Module adcp.types.domains.property.property_error

Classes

class Code (*args, **kwds)
Expand source code 
class Code(StrEnum):
    PROPERTY_NOT_FOUND = 'PROPERTY_NOT_FOUND'
    PROPERTY_NOT_MONITORED = 'PROPERTY_NOT_MONITORED'
    LIST_NOT_FOUND = 'LIST_NOT_FOUND'
    LIST_ACCESS_DENIED = 'LIST_ACCESS_DENIED'
    METHODOLOGY_NOT_SUPPORTED = 'METHODOLOGY_NOT_SUPPORTED'
    JURISDICTION_NOT_SUPPORTED = 'JURISDICTION_NOT_SUPPORTED'

Enum where members are also (and must be) strings

Ancestors

  • enum.StrEnum
  • builtins.str
  • enum.ReprEnum
  • enum.Enum

Class variables

var JURISDICTION_NOT_SUPPORTED
var LIST_ACCESS_DENIED
var LIST_NOT_FOUND
var METHODOLOGY_NOT_SUPPORTED
var PROPERTY_NOT_FOUND
var PROPERTY_NOT_MONITORED
class PropertyError (**data: Any)
Expand source code 
class PropertyError(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    code: Annotated[Code, Field(description='Error code')]
    property: Annotated[
        property_1.Property | None, Field(description='The property that caused the error')
    ] = None
    message: Annotated[str, Field(description='Human-readable error message')]

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 code : Code
var message : str
var model_config
var property : Property | None

Inherited members