From 727577cd8a5ee4c13eba3b1225878070df048e12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20S=C3=A1nchez?= Date: Sun, 11 Aug 2024 18:07:40 +0100 Subject: [PATCH] Update status_handler signature and add documentation --- blackboard/exceptions.py | 2 +- docs/index.rst | 1 + docs/pages/exceptions.rst | 5 +++++ 3 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 docs/pages/exceptions.rst diff --git a/blackboard/exceptions.py b/blackboard/exceptions.py index 57ad6e7..5bd416c 100644 --- a/blackboard/exceptions.py +++ b/blackboard/exceptions.py @@ -33,7 +33,7 @@ class BBForbiddenError(Exception): pass -def status_handler(status_code: Any) -> NoReturn: +def status_handler(status_code: Any, response: Any) -> NoReturn: match status_code: case 400: raise BBBadRequestError() diff --git a/docs/index.rst b/docs/index.rst index b0def77..ba22d3d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ Blackboard Learn API Client pages/api pages/blackboard + pages/exceptions Indices and tables diff --git a/docs/pages/exceptions.rst b/docs/pages/exceptions.rst new file mode 100644 index 0000000..804d561 --- /dev/null +++ b/docs/pages/exceptions.rst @@ -0,0 +1,5 @@ +Exceptions Reference +==================== + +.. automodule:: blackboard.exceptions + :members: