Skip to content

Exceptions

griddy / core / exceptions**

exceptions

Custom exceptions for the Griddy SDK.

This module defines a hierarchy of exceptions used throughout the Griddy SDK to provide specific error information for different failure scenarios.

Exception Hierarchy

GriddyError (Base) ├── APIError - General API request failures ├── RateLimitError - Rate limit exceeded (429) ├── NotFoundError - Resource not found (404) ├── AuthenticationError - Authentication failed (401) └── ValidationError - Request validation failures

Example

from griddy import GriddyError, RateLimitError try: ... result = nfl.games.get_games(season=2024) ... except RateLimitError as e: ... print(f"Rate limited. Retry after: {e.retry_after}") ... except GriddyError as e: ... print(f"Error: {e.message} (status: {e.status_code})")

Classes

GriddyError 

GriddyError(
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
)

Bases: Exception


              flowchart TD
              griddy.core.exceptions.GriddyError[GriddyError]

              

              click griddy.core.exceptions.GriddyError href "" "griddy.core.exceptions.GriddyError"

Base exception for all Griddy SDK errors.

All SDK-specific exceptions inherit from this class, allowing you to catch all SDK errors with a single except clause.

ATTRIBUTE DESCRIPTION
message

Human-readable error description.
status_code

HTTP status code from the API response, if applicable.
response_data

Raw response data from the API, if available.
Example

try: ... result = nfl.games.get_games(season=2024) ... except GriddyError as e: ... print(f"Error: {e.message}") ... print(f"Status: {e.status_code}") ... print(f"Data: {e.response_data}")

Initialize a GriddyError.

PARAMETER DESCRIPTION
message

Human-readable error description.

TYPE: str

status_code

HTTP status code from the API response.

TYPE: int | None DEFAULT: None

response_data

Raw response data from the API.

TYPE: dict[str, Any] | None DEFAULT: None

Source code in griddy/core/exceptions.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
) -> None:
    """Initialize a GriddyError.

    Args:
        message: Human-readable error description.
        status_code: HTTP status code from the API response.
        response_data: Raw response data from the API.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data or {}
Functions

APIError 

APIError(
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
)

Bases: GriddyError


              flowchart TD
              griddy.core.exceptions.APIError[APIError]
              griddy.core.exceptions.GriddyError[GriddyError]

                              griddy.core.exceptions.GriddyError --> griddy.core.exceptions.APIError
                


              click griddy.core.exceptions.APIError href "" "griddy.core.exceptions.APIError"
              click griddy.core.exceptions.GriddyError href "" "griddy.core.exceptions.GriddyError"

Raised when an API request fails.

This exception is raised for general API errors, including server errors (5xx status codes) and client errors that don't fit more specific categories.

Example

try: ... result = nfl.games.get_games(season=2024) ... except APIError as e: ... if e.status_code and e.status_code >= 500: ... print("Server error - retry later") ... else: ... print(f"API error: {e.message}")

Source code in griddy/core/exceptions.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
) -> None:
    """Initialize a GriddyError.

    Args:
        message: Human-readable error description.
        status_code: HTTP status code from the API response.
        response_data: Raw response data from the API.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data or {}

RateLimitError 

RateLimitError(
    message: str,
    retry_after: int | None = None,
    **kwargs: Any
)

Bases: GriddyError


              flowchart TD
              griddy.core.exceptions.RateLimitError[RateLimitError]
              griddy.core.exceptions.GriddyError[GriddyError]

                              griddy.core.exceptions.GriddyError --> griddy.core.exceptions.RateLimitError
                


              click griddy.core.exceptions.RateLimitError href "" "griddy.core.exceptions.RateLimitError"
              click griddy.core.exceptions.GriddyError href "" "griddy.core.exceptions.GriddyError"

Raised when the API rate limit is exceeded.

This exception is raised when the API returns a 429 status code, indicating too many requests have been made in a given time period.

ATTRIBUTE DESCRIPTION
retry_after

Number of seconds to wait before retrying, if provided by the API in the Retry-After header.
Example

import time try: ... result = nfl.games.get_games(season=2024) ... except RateLimitError as e: ... wait_time = e.retry_after or 60 ... print(f"Rate limited. Waiting {wait_time} seconds...") ... time.sleep(wait_time)

Initialize a RateLimitError.

PARAMETER DESCRIPTION
message

Human-readable error description.

TYPE: str

retry_after

Seconds to wait before retrying, from Retry-After header.

TYPE: int | None DEFAULT: None

**kwargs

Additional arguments passed to GriddyError.

TYPE: Any DEFAULT: {}

Source code in griddy/core/exceptions.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def __init__(
    self,
    message: str,
    retry_after: int | None = None,
    **kwargs: Any,
) -> None:
    """Initialize a RateLimitError.

    Args:
        message: Human-readable error description.
        retry_after: Seconds to wait before retrying, from Retry-After header.
        **kwargs: Additional arguments passed to GriddyError.
    """
    super().__init__(message, **kwargs)
    self.retry_after = retry_after
Functions

NotFoundError 

NotFoundError(
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
)

Bases: GriddyError


              flowchart TD
              griddy.core.exceptions.NotFoundError[NotFoundError]
              griddy.core.exceptions.GriddyError[GriddyError]

                              griddy.core.exceptions.GriddyError --> griddy.core.exceptions.NotFoundError
                


              click griddy.core.exceptions.NotFoundError href "" "griddy.core.exceptions.NotFoundError"
              click griddy.core.exceptions.GriddyError href "" "griddy.core.exceptions.GriddyError"

Raised when a requested resource is not found.

This exception is raised when the API returns a 404 status code, indicating the requested resource does not exist.

Example

try: ... player = nfl.players.get_player(player_id="invalid_id") ... except NotFoundError as e: ... print(f"Player not found: {e.message}") ... player = None

Source code in griddy/core/exceptions.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
) -> None:
    """Initialize a GriddyError.

    Args:
        message: Human-readable error description.
        status_code: HTTP status code from the API response.
        response_data: Raw response data from the API.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data or {}

AuthenticationError 

AuthenticationError(
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
)

Bases: GriddyError


              flowchart TD
              griddy.core.exceptions.AuthenticationError[AuthenticationError]
              griddy.core.exceptions.GriddyError[GriddyError]

                              griddy.core.exceptions.GriddyError --> griddy.core.exceptions.AuthenticationError
                


              click griddy.core.exceptions.AuthenticationError href "" "griddy.core.exceptions.AuthenticationError"
              click griddy.core.exceptions.GriddyError href "" "griddy.core.exceptions.GriddyError"

Raised when authentication fails.

This exception is raised when the API returns a 401 status code, indicating the request lacks valid authentication credentials.

Example

try: ... result = nfl.games.get_games(season=2024) ... except AuthenticationError: ... print("Token expired. Please re-authenticate.")

Source code in griddy/core/exceptions.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
) -> None:
    """Initialize a GriddyError.

    Args:
        message: Human-readable error description.
        status_code: HTTP status code from the API response.
        response_data: Raw response data from the API.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data or {}

ValidationError 

ValidationError(
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
)

Bases: GriddyError


              flowchart TD
              griddy.core.exceptions.ValidationError[ValidationError]
              griddy.core.exceptions.GriddyError[GriddyError]

                              griddy.core.exceptions.GriddyError --> griddy.core.exceptions.ValidationError
                


              click griddy.core.exceptions.ValidationError href "" "griddy.core.exceptions.ValidationError"
              click griddy.core.exceptions.GriddyError href "" "griddy.core.exceptions.GriddyError"

Raised when request validation fails.

This exception is raised when the request parameters fail validation, either client-side or when the API returns a 400 status code.

Example

try: ... result = nfl.games.get_games(season="invalid") ... except ValidationError as e: ... print(f"Invalid parameters: {e.message}")

Source code in griddy/core/exceptions.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    message: str,
    status_code: int | None = None,
    response_data: dict[str, Any] | None = None,
) -> None:
    """Initialize a GriddyError.

    Args:
        message: Human-readable error description.
        status_code: HTTP status code from the API response.
        response_data: Raw response data from the API.
    """
    super().__init__(message)
    self.message = message
    self.status_code = status_code
    self.response_data = response_data or {}