Skip to content

Exceptions

See Error Handling for usage guidance.

pycomptox.exceptions

Exception hierarchy for PyCompTox.

All errors raised by PyCompTox clients derive from :class:CompToxError, so callers can catch every library-specific failure with a single except clause while still being able to distinguish the common cases.

Example

from pycomptox import Chemical from pycomptox.exceptions import NotFoundError, RateLimitError client = Chemical() try: ... details = client.search_by_exact_value("not-a-real-chemical") ... except NotFoundError: ... print("No such chemical") ... except RateLimitError as exc: ... print(f"Slow down; retry after {exc.retry_after}s")

APIError

Bases: CompToxError

Raised when the CompTox API returns an unsuccessful HTTP response.

Attributes:

Name Type Description
status_code int

HTTP status code returned by the API.
url str

The URL that was requested.
response_text str

Raw response body, truncated.
Source code in src/pycomptox/exceptions.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class APIError(CompToxError):
    """
    Raised when the CompTox API returns an unsuccessful HTTP response.

    Attributes:
        status_code (int, optional): HTTP status code returned by the API.
        url (str, optional): The URL that was requested.
        response_text (str, optional): Raw response body, truncated.
    """

    def __init__(
        self,
        message: str,
        status_code: Optional[int] = None,
        url: Optional[str] = None,
        response_text: Optional[str] = None,
    ) -> None:
        super().__init__(message)
        self.status_code = status_code
        self.url = url
        self.response_text = response_text

AuthenticationError

Bases: APIError

Raised on HTTP 401/403 - the API key is missing, invalid, or lacks access.

Source code in src/pycomptox/exceptions.py 
65
66
class AuthenticationError(APIError):
    """Raised on HTTP 401/403 - the API key is missing, invalid, or lacks access."""

CompToxError

Bases: Exception

Base class for every error raised by PyCompTox.

Source code in src/pycomptox/exceptions.py 
34
35
class CompToxError(Exception):
    """Base class for every error raised by PyCompTox."""

ConfigurationError

Bases: CompToxError

Raised when the client is misconfigured, e.g. no API key is available.

Source code in src/pycomptox/exceptions.py 
38
39
class ConfigurationError(CompToxError):
    """Raised when the client is misconfigured, e.g. no API key is available."""

NotFoundError

Bases: APIError

Raised on HTTP 404 - the requested resource or identifier does not exist.

Source code in src/pycomptox/exceptions.py 
69
70
class NotFoundError(APIError):
    """Raised on HTTP 404 - the requested resource or identifier does not exist."""

RateLimitError

Bases: APIError

Raised on HTTP 429 - the API rate limit has been exceeded.

Attributes:

Name Type Description
retry_after float

Seconds to wait before retrying, taken from the Retry-After response header when present.
Source code in src/pycomptox/exceptions.py 
73
74
75
76
77
78
79
80
81
82
83
84
class RateLimitError(APIError):
    """
    Raised on HTTP 429 - the API rate limit has been exceeded.

    Attributes:
        retry_after (float, optional): Seconds to wait before retrying, taken
            from the ``Retry-After`` response header when present.
    """

    def __init__(self, *args: Any, retry_after: Optional[float] = None, **kwargs: Any) -> None:
        super().__init__(*args, **kwargs)
        self.retry_after = retry_after

ServerError

Bases: APIError

Raised on HTTP 5xx - the CompTox API failed to handle the request.

Source code in src/pycomptox/exceptions.py 
87
88
class ServerError(APIError):
    """Raised on HTTP 5xx - the CompTox API failed to handle the request."""

TimeoutError

Bases: CompToxError

Raised when a request exceeds the configured timeout.

Source code in src/pycomptox/exceptions.py 
91
92
class TimeoutError(CompToxError):  # noqa: A001 - deliberately shadows the builtin name
    """Raised when a request exceeds the configured timeout."""