Skip to content

Exceptions

Detailed API reference for the wingpy.exceptions module, which provides custom exceptions used throughout wingpy for error handling. We have defined several specific exceptions to help you identify and handle different error scenarios effectively in your automation scripts. They include rich context about what went wrong, making debugging easier, and this also allows us to provide more meaningful logging messages.

wingpy.exceptions

ApiClient

Bases: ABC

base_url 
base_url: str | None = None

The base URL for the API.

AuthenticationFailure 

AuthenticationFailure(
    message: str = "", response: Response | None = None
)

Bases: WingpyException

Raised when API authentication fails.

response 
response: Response | None = None

The HTTP response returned by the API.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
72
73
74
75
76
77
78
79
80
def __str__(self) -> str:
    msg = self.message

    if self.response:
        code = self.response.status_code
        msg += f"\nAuthentication failed with status code: {code}"
        msg += f"\nResponse content: {self.response.text}"

    return msg

InvalidEndpointError 

InvalidEndpointError(
    message: str = "",
    client: ApiClient | None = None,
    endpoint_path: str | None = None,
)

Bases: WingpyException

Raised when the specified API endpoint path is not valid for use in a URL.

client 
client: ApiClient | None = None

The client class that is making the request.

endpoint_path 
endpoint_path: str | None = None

The invalid endpoint path.

__str__ 
__str__() -> str

Return a detailed error message including the full URL if possible.

Source code in src/wingpy/exceptions.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def __str__(self) -> str:
    """
    Return a detailed error message including the full URL if possible.
    """

    msg = self.message

    if isinstance(self.client, ApiClient):
        client_name = self.client.__class__.__name__
        msg += f"\n{client_name}: Invalid endpoint path provided."

    if isinstance(self.client, ApiClient) and self.endpoint_path:
        msg += f"\nFull URL: {self.client.base_url}{self.endpoint_path}"
    else:
        if isinstance(self.client, ApiClient):
            msg += f"\nBase URL: {self.client.base_url}"
        if self.endpoint_path:
            msg += f"\nEndpoint path: {self.endpoint_path}"

    return msg

InvalidResponseError 

InvalidResponseError(
    message: str = "", response: Response | None = None
)

Bases: WingpyException

Raised when the API returned an invalid or unexpected HTTP response.

response 
response: Response | None = None

The HTTP response returned by the API.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
235
236
237
238
239
240
241
242
243
def __str__(self) -> str:
    msg = self.message

    if self.response:
        code = self.response.status_code
        msg += f"\nInvalid response with status code: {code}"
        msg += f"\nResponse content: {self.response.text}"

    return msg

MissingPathParameterError 

MissingPathParameterError(
    message: str = "",
    parameter: str | None = None,
    available_params: str | None = None,
    client: ApiClient | None = None,
    endpoint_path: str | None = None,
)

Bases: WingpyException

Raised when a required path parameter is missing for URL construction.

available_params 
available_params: str | None = None

The available path parameters.

client 
client: ApiClient | None = None

The client class that is making the request.

endpoint_path 
endpoint_path: str | None = None

The endpoint path where the parameter is missing.

parameter 
parameter: str | None = None

The missing path parameter.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def __str__(self) -> str:
    msg = self.message

    if isinstance(self.client, ApiClient):
        client_name = self.client.__class__.__name__
        msg += f"{client_name}: Missing path parameter."

    if self.parameter:
        msg += f"\nMissing path parameter: {self.parameter}"
    if self.available_params:
        msg += f"\nAvailable parameters: {self.available_params}"
    if self.endpoint_path:
        msg += f"\nEndpoint path: {self.endpoint_path}"

    return msg

URLNetlocError 

URLNetlocError(
    message: str = "", base_url: str | None = None
)

Bases: WingpyException

Raised when the provided base URL does not include a valid network location.

base_url 
base_url: str | None = None

The invalid base URL.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
163
164
165
166
167
168
169
170
def __str__(self) -> str:
    msg = self.message

    if self.base_url:
        msg += f"\nInvalid base URL: {self.base_url}"
        msg += "\nThe base URL must include a valid network location."

    return msg

URLPathError 

URLPathError(
    message: str = "", base_url: str | None = None
)

Bases: WingpyException

Raised when the provided base URL ends with a forward slash (/).

base_url 
base_url: str | None = None

The invalid base URL.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
182
183
184
185
186
187
188
def __str__(self) -> str:
    msg = self.message

    if self.base_url:
        msg += f"Invalid base URL. Must not end with a '/': {self.base_url}"

    return msg

URLSchemaError 

URLSchemaError(
    message: str = "", base_url: str | None = None
)

Bases: WingpyException

Raised when the provided base URL does not include a valid schema (http or https).

base_url 
base_url: str | None = None

The invalid base URL.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
144
145
146
147
148
149
150
151
def __str__(self) -> str:
    msg = self.message

    if self.base_url:
        msg += f"\nInvalid base URL: {self.base_url}"
        msg += "\nThe base URL must start with 'http://' or 'https://'."

    return msg

UnexpectedPayloadError 

UnexpectedPayloadError(
    message: str = "", response: Response | None = None
)

Bases: WingpyException

Raised when the API returned payload with unexpected data structure.

response 
response: Response | None = None

The HTTP response returned by the API.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
126
127
128
129
130
131
132
def __str__(self) -> str:
    msg = self.message

    if self.response:
        msg += f"\nUnexpected response: {self.response.text}"

    return msg

UnsupportedMethodError 

UnsupportedMethodError(
    message: str = "",
    method: (
        Literal["DELETE", "GET", "PATCH", "POST", "PUT"]
        | None
    ) = None,
    client: ApiClient | None = None,
)

Bases: WingpyException

Raised when the an unsupported HTTP method is used on a client instance.

Some APIs do not support all HTTP methods, and all methods must be implemented by client classes.

Examples:

  1. An API does not support the PUT HTTP method.
  2. The user calls the .put() method on the instance.
  3. The exception is raised.
client 
client: ApiClient | None = None

The name of the client class that does not support the method.

method 
method: (
    Literal["DELETE", "GET", "PATCH", "POST", "PUT"] | None
) = None

The HTTP method that is not supported.

__str__ 
__str__() -> str
Source code in src/wingpy/exceptions.py 
49
50
51
52
53
54
55
56
57
58
59
60
def __str__(self) -> str:
    msg = self.message

    if isinstance(self.client, ApiClient):
        client_name = self.client.__class__.__name__
    else:
        client_name = "this API"

    if self.method:
        msg += f"\n{self.method} not supported by {client_name}"

    return msg

WingpyException 

WingpyException(message: str = '')

Bases: Exception

Base exception class for all wingpy exceptions.

message 
message: str = ''
__post_init__ 
__post_init__()
Source code in src/wingpy/exceptions.py 
23
24
def __post_init__(self):
    traceback.install()