Skip to content

Exceptions

All errors raised by the client derive from SignTrakerError. See the Error Handling guide for the status-code mapping.

signtraker.exceptions

Custom exceptions for the SignTraker API client.

The hierarchy is rooted at :class:SignTrakerError. Every error carries the HTTP status_code (when applicable) and the parsed response_data so callers can inspect the failure without re-parsing the response.

SignTrakerError 

SignTrakerError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: Exception

Base exception for all SignTraker API errors.

Attributes:

Name Type Description
message

Human-readable error message.
status_code

HTTP status code associated with the error, if any.
response_data

Parsed response payload associated with the error, if any.

Initialize the error.

Parameters:

Name Type Description Default
message str

Human-readable error message.

 required
status_code Optional[int]

HTTP status code, if applicable.

 None
response_data Optional[Dict[str, Any]]

Parsed response payload, if available.

 None
Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

SignTrakerConfigError 

SignTrakerConfigError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised when the client is misconfigured (e.g. no base URL/subdomain).

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

AuthenticationError 

AuthenticationError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised when authentication fails or is missing (HTTP 401/403).

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

ValidationError 

ValidationError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised when request validation fails (HTTP 400).

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

NotFoundError 

NotFoundError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised when a requested resource does not exist (HTTP 404).

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

RateLimitError 

RateLimitError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised when the API rate limit is exceeded (HTTP 429).

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

ServerError 

ServerError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised on server-side failures (HTTP 5xx).

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data

NetworkError 

NetworkError(message: str, status_code: Optional[int] = None, response_data: Optional[Dict[str, Any]] = None)

Bases: SignTrakerError

Raised when the network request fails before a response is received.

Source code in signtraker/exceptions.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    message: str,
    status_code: Optional[int] = None,
    response_data: Optional[Dict[str, Any]] = None,
) -> None:
    """Initialize the error.

    Args:
        message: Human-readable error message.
        status_code: HTTP status code, if applicable.
        response_data: Parsed response payload, if available.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data