Skip to content

Exceptions

pyopenf1.exceptions.PyOpenF1Error

Bases: Exception

Base exception for all pyopenf1 errors.

Source code in pyopenf1/exceptions.py 
11
12
13
14
15
16
class PyOpenF1Error(Exception):
    """Base exception for all pyopenf1 errors."""

    def __init__(self, message: str = "An unexpected pyopenf1 error occurred.") -> None:
        self.message = message
        super().__init__(self.message)

pyopenf1.exceptions.APIError

Bases: PyOpenF1Error

Raised when the OpenF1 API returns a non-success HTTP status.

Attributes:

Name Type Description
status_code

The HTTP status code returned by the API.
response_body

The raw response body, if available.
Source code in pyopenf1/exceptions.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class APIError(PyOpenF1Error):
    """Raised when the OpenF1 API returns a non-success HTTP status.

    Attributes:
        status_code: The HTTP status code returned by the API.
        response_body: The raw response body, if available.
    """

    def __init__(
        self,
        message: str,
        *,
        status_code: int,
        response_body: str | None = None,
    ) -> None:
        self.status_code = status_code
        self.response_body = response_body
        super().__init__(message)

pyopenf1.exceptions.RateLimitError

Bases: APIError

Raised when the API returns HTTP 429 (Too Many Requests).

The caller should back off and retry after the period indicated by the Retry-After header, if present.

Source code in pyopenf1/exceptions.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class RateLimitError(APIError):
    """Raised when the API returns HTTP 429 (Too Many Requests).

    The caller should back off and retry after the period indicated by the
    ``Retry-After`` header, if present.
    """

    def __init__(
        self,
        message: str = "Rate limit exceeded. Please slow down.",
        *,
        status_code: int = 429,
        response_body: str | None = None,
        retry_after: float | None = None,
    ) -> None:
        self.retry_after = retry_after
        super().__init__(message, status_code=status_code, response_body=response_body)

pyopenf1.exceptions.AuthenticationError

Bases: APIError

Raised when the API returns HTTP 401 or 403.

Source code in pyopenf1/exceptions.py 
58
59
60
61
62
63
64
65
66
67
68
class AuthenticationError(APIError):
    """Raised when the API returns HTTP 401 or 403."""

    def __init__(
        self,
        message: str = "Authentication failed.",
        *,
        status_code: int = 401,
        response_body: str | None = None,
    ) -> None:
        super().__init__(message, status_code=status_code, response_body=response_body)

pyopenf1.exceptions.NotFoundError

Bases: APIError

Raised when the API returns HTTP 404.

Source code in pyopenf1/exceptions.py 
71
72
73
74
75
76
77
78
79
80
81
class NotFoundError(APIError):
    """Raised when the API returns HTTP 404."""

    def __init__(
        self,
        message: str = "The requested resource was not found.",
        *,
        status_code: int = 404,
        response_body: str | None = None,
    ) -> None:
        super().__init__(message, status_code=status_code, response_body=response_body)

pyopenf1.exceptions.ServerError

Bases: APIError

Raised when the API returns an HTTP 5xx status.

Source code in pyopenf1/exceptions.py 
84
85
86
87
88
89
90
91
92
93
94
class ServerError(APIError):
    """Raised when the API returns an HTTP 5xx status."""

    def __init__(
        self,
        message: str = "The server encountered an internal error.",
        *,
        status_code: int = 500,
        response_body: str | None = None,
    ) -> None:
        super().__init__(message, status_code=status_code, response_body=response_body)