gfwapiclient.base.models

Global Fishing Watch (GFW) API Python Client - Base Models.

Module Contents

Classes

BaseModel

Base model for domain data models.

Data

__all__

API

gfwapiclient.base.models.__all__ = ['BaseModel']
class gfwapiclient.base.models.BaseModel(/, **data: typing.Any)

Bases: pydantic.BaseModel

Base model for domain data models.

This class extends pydantic.BaseModel to:

  • Use snake_case for Python attributes.

  • Use camelCase for API requests and responses.

  • Strip whitespace from string fields automatically.

  • Use value property of enums

  • Validate default values.

  • Allow additional (unexpected) fields.

Attributes:
model_config (ClassVar[ConfigDict]):

Configuration settings for Pydantic models.

  • alias_generator: Generates aliases for serialization/deserialization. - serialization_alias: Serializes Python’s snake_case fields to camelCase. - validation_alias: Deserializes camelCase to Python’s snake_case fields.

  • extra=”allow”: Allows additional fields not explicitly defined in the model.

  • populate_by_name=True: Enables populate aliased field by model attribute or alias.

  • str_strip_whitespace=True: Trims whitespace from string fields.

  • use_enum_values=True: Enables populate models with the value property of enums.

  • validate_default=True: Ensures default values are validated.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_config: ClassVar[pydantic.ConfigDict] = 'ConfigDict(...)'