gfwapiclient.exceptions.validation

Global Fishing Watch (GFW) API Python Client - Validation Exceptions.

Module Contents

Data

__all__
MODEL_VALIDATION_ERROR_MESSAGE
REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE
REQUEST_BODY_VALIDATION_ERROR_MESSAGE
RESULT_ITEM_VALIDATION_ERROR_MESSAGE

API

gfwapiclient.exceptions.validation.__all__ = ['ModelValidationError', 'RequestBodyValidationError', 'RequestParamsValidationError', 'ResultItemVa...

gfwapiclient.exceptions.validation.MODEL_VALIDATION_ERROR_MESSAGE: Final[str] = 'Model validation failed.'

gfwapiclient.exceptions.validation.REQUEST_PARAMS_VALIDATION_ERROR_MESSAGE: Final[str] = 'Request parameters validation failed.'

gfwapiclient.exceptions.validation.REQUEST_BODY_VALIDATION_ERROR_MESSAGE: Final[str] = 'Request body validation failed.'

gfwapiclient.exceptions.validation.RESULT_ITEM_VALIDATION_ERROR_MESSAGE: Final[str] = 'Result item validation failed.'

exception gfwapiclient.exceptions.validation.ModelValidationError(*, message: Optional[str] = None, error: Optional[pydantic_core.ValidationError] = None)

Bases: gfwapiclient.exceptions.base.GFWAPIClientError

Base exception for Pydantic model validation errors.

Attributes:

message (str):

The error message.

errors (List[ErrorDetails]):

A list of validation errors (if available).

Initialization

Initialize a new ModelValidationError exception.

Args:

message (Optional[str], default=None):

Error message describing the exception.

error (Optional[pydantic.ValidationError], default=None):

The pydantic.ValidationError instance with list of validation errors (if available).

error: Optional[pydantic_core.ValidationError] = None

__str__() → str

Return a string representation of the error.

__repr__() → str

Return the canonical string representation of the error.

exception gfwapiclient.exceptions.validation.RequestParamsValidationError(*, message: Optional[str] = None, error: Optional[pydantic_core.ValidationError] = None)

Bases: gfwapiclient.exceptions.validation.ModelValidationError

Exception raised when RequestParams validation fails.

Initialization

Initialize a new RequestParamsValidationError exception.

Args:

message (Optional[str], default=None):

Error message describing the exception.

error (Optional[pydantic.ValidationError], default=None):

The pydantic.ValidationError instance with list of validation errors (if available).

exception gfwapiclient.exceptions.validation.RequestBodyValidationError(*, message: Optional[str] = None, error: Optional[pydantic_core.ValidationError] = None)

Bases: gfwapiclient.exceptions.validation.ModelValidationError

Exception raised when RequestBody validation fails.

Initialization

Initialize a new RequestBodyValidationError exception.

Args:

message (Optional[str], default=None):

Error message describing the exception.

error (Optional[pydantic.ValidationError], default=None):

The pydantic.ValidationError instance with list of validation errors (if available).

exception gfwapiclient.exceptions.validation.ResultItemValidationError(*, error: Optional[pydantic_core.ValidationError] = None, response: Optional[httpx.Response] = None, body: Optional[Any] = None)

Bases: gfwapiclient.exceptions.validation.ModelValidationError

Raised when a ResultItem is invalid.

Attributes:

response (Optional[httpx.Response]):

Associated HTTP response (if available).

body (Optional[Any]):

Associated HTTP response body content (if available).

Initialization

Initialize a new ResultItemValidationError exception.

Args:

error (Optional[pydantic.ValidationError], default=None):

The pydantic.ValidationError instance with list of validation errors (if available).

response (Optional[httpx.Response], default=None):

The HTTP response received.

body (Optional[Any], default=None):

The HTTP response body content.

response: Optional[httpx.Response] = None

body: Optional[Any] = None

__str__() → str

Return a string representation of the error.

__repr__() → str

Return the canonical string representation of the error.

exception gfwapiclient.exceptions.validation.ResultValidationError(*, message: Optional[str] = None, error: Optional[pydantic_core.ValidationError] = None, response: Optional[httpx.Response] = None, body: Optional[Any] = None)

Bases: gfwapiclient.exceptions.validation.ModelValidationError

Raised when a Result or received HTTP response is invalid.

Attributes:

response (Optional[httpx.Response]):

Associated HTTP response (if available).

body (Optional[Any]):

Associated HTTP response body content (if available).

Initialization

Initialize a new ResultValidationError exception.

Args:

message (Optional[str], default=None):

Error message describing the exception.

error (Optional[pydantic.ValidationError], default=None):

The pydantic.ValidationError instance with list of validation errors (if available).

response (Optional[httpx.Response], default=None):

The HTTP response received.

body (Optional[Any], default=None):

The HTTP response body content.

__str__() → str

Return a string representation of the error.

__repr__() → str

Return the canonical string representation of the error.