Module adcp.types.domains.core.special

Classes

class Special (**data: Any)
Expand source code 
class Special(AdCPBaseModel):
    model_config = ConfigDict(
        extra='allow',
    )
    name: Annotated[
        str, Field(description="Name of the event (e.g., 'Olympics 2028', 'Super Bowl LXI')")
    ]
    category: Annotated[
        special_category.SpecialCategory | None, Field(description='Category of the event')
    ] = None
    starts: Annotated[
        AwareDatetime | None, Field(description='When the event starts (ISO 8601)')
    ] = None
    ends: Annotated[
        AwareDatetime | None,
        Field(description='When the event ends (ISO 8601). Omit for single-day events.'),
    ] = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so unknown fields from newer spec versions are silently dropped rather than causing validation errors. Generated types whose schemas set additionalProperties: true override this with extra='allow' in their own model_config.

Set ADCP_STRICT_VALIDATION=1 in the environment ("1", "true", "yes", "on" are accepted) to flip the default to extra='forbid'. Use this during spec upgrades to catch silently-dropped renamed fields in tests. See :func:_resolve_extra_policy.

Important

The env var is resolved once at module import time. Set it in your shell or CI environment before import adcp runs — mutating os.environ["ADCP_STRICT_VALIDATION"] after the first adcp import has no effect on already-imported model classes (they captured the policy at class-body evaluation).

Consumers who want per-model strict validation can override model_config on their subclass.

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.

Ancestors

Class variables

var category : SpecialCategory | None
var ends : pydantic.types.AwareDatetime | None
var model_config
var name : str
var starts : pydantic.types.AwareDatetime | None

Inherited members