Merge pull request #870 from adamtheturtle/exceptions-doc

Document all exceptions

Author: adamtheturtle

docs/source/exceptions.rst

@@ -0,0 +1,5 @@
+Exceptions
+==========
+
+.. automodule:: vws.exceptions
+   :members:

docs/source/index.rst

@@ -1,2 +1,7 @@
 VWS Python
 ==========
+
+.. toctree::
+   :maxdepth: 3
+
+   exceptions

src/vws/exceptions.py

@@ -17,7 +17,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class Fail(Exception):
@@ -32,7 +39,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class BadImage(Exception):
@@ -47,7 +61,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class AuthenticationFailure(Exception):
@@ -62,8 +83,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
 
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 class TargetStatusProcessing(Exception):
     """
@@ -77,7 +104,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class ProjectInactive(Exception):
@@ -92,7 +126,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class MetadataTooLarge(Exception):
@@ -107,7 +148,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class TargetNameExist(Exception):
@@ -122,7 +170,14 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
 
 
 class ImageTooLarge(Exception):
@@ -137,4 +192,11 @@ def __init__(self, response: Response) -> None:
             response: The response to a request to Vuforia.
         """
         super().__init__()
-        self.response = response
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response