Skip to content

Commit 8bc589b

Browse files
Merge pull request #870 from adamtheturtle/exceptions-doc
Document all exceptions
2 parents 5fbea5f + fb5380e commit 8bc589b

File tree

3 files changed

+81
-9
lines changed

3 files changed

+81
-9
lines changed

docs/source/exceptions.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Exceptions
2+
==========
3+
4+
.. automodule:: vws.exceptions
5+
:members:

docs/source/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
VWS Python
22
==========
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
exceptions

src/vws/exceptions.py

Lines changed: 71 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ def __init__(self, response: Response) -> None:
1717
response: The response to a request to Vuforia.
1818
"""
1919
super().__init__()
20-
self.response = response
20+
self._response = response
21+
22+
@property
23+
def response(self) -> Response:
24+
"""
25+
The response returned by Vuforia which included this error.
26+
"""
27+
return self._response
2128

2229

2330
class Fail(Exception):
@@ -32,7 +39,14 @@ def __init__(self, response: Response) -> None:
3239
response: The response to a request to Vuforia.
3340
"""
3441
super().__init__()
35-
self.response = response
42+
self._response = response
43+
44+
@property
45+
def response(self) -> Response:
46+
"""
47+
The response returned by Vuforia which included this error.
48+
"""
49+
return self._response
3650

3751

3852
class BadImage(Exception):
@@ -47,7 +61,14 @@ def __init__(self, response: Response) -> None:
4761
response: The response to a request to Vuforia.
4862
"""
4963
super().__init__()
50-
self.response = response
64+
self._response = response
65+
66+
@property
67+
def response(self) -> Response:
68+
"""
69+
The response returned by Vuforia which included this error.
70+
"""
71+
return self._response
5172

5273

5374
class AuthenticationFailure(Exception):
@@ -62,8 +83,14 @@ def __init__(self, response: Response) -> None:
6283
response: The response to a request to Vuforia.
6384
"""
6485
super().__init__()
65-
self.response = response
86+
self._response = response
6687

88+
@property
89+
def response(self) -> Response:
90+
"""
91+
The response returned by Vuforia which included this error.
92+
"""
93+
return self._response
6794

6895
class TargetStatusProcessing(Exception):
6996
"""
@@ -77,7 +104,14 @@ def __init__(self, response: Response) -> None:
77104
response: The response to a request to Vuforia.
78105
"""
79106
super().__init__()
80-
self.response = response
107+
self._response = response
108+
109+
@property
110+
def response(self) -> Response:
111+
"""
112+
The response returned by Vuforia which included this error.
113+
"""
114+
return self._response
81115

82116

83117
class ProjectInactive(Exception):
@@ -92,7 +126,14 @@ def __init__(self, response: Response) -> None:
92126
response: The response to a request to Vuforia.
93127
"""
94128
super().__init__()
95-
self.response = response
129+
self._response = response
130+
131+
@property
132+
def response(self) -> Response:
133+
"""
134+
The response returned by Vuforia which included this error.
135+
"""
136+
return self._response
96137

97138

98139
class MetadataTooLarge(Exception):
@@ -107,7 +148,14 @@ def __init__(self, response: Response) -> None:
107148
response: The response to a request to Vuforia.
108149
"""
109150
super().__init__()
110-
self.response = response
151+
self._response = response
152+
153+
@property
154+
def response(self) -> Response:
155+
"""
156+
The response returned by Vuforia which included this error.
157+
"""
158+
return self._response
111159

112160

113161
class TargetNameExist(Exception):
@@ -122,7 +170,14 @@ def __init__(self, response: Response) -> None:
122170
response: The response to a request to Vuforia.
123171
"""
124172
super().__init__()
125-
self.response = response
173+
self._response = response
174+
175+
@property
176+
def response(self) -> Response:
177+
"""
178+
The response returned by Vuforia which included this error.
179+
"""
180+
return self._response
126181

127182

128183
class ImageTooLarge(Exception):
@@ -137,4 +192,11 @@ def __init__(self, response: Response) -> None:
137192
response: The response to a request to Vuforia.
138193
"""
139194
super().__init__()
140-
self.response = response
195+
self._response = response
196+
197+
@property
198+
def response(self) -> Response:
199+
"""
200+
The response returned by Vuforia which included this error.
201+
"""
202+
return self._response

0 commit comments

Comments
 (0)