Module adcp.types.domains.property.property_feature_result

Classes

class CoverageStatus (*args, **kwds)

Expand source code

class CoverageStatus(StrEnum):
    covered = 'covered'
    not_covered = 'not_covered'
    pending = 'pending'

Enum where members are also (and must be) strings

Ancestors

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

Class variables

var covered

var not_covered

var pending

class PropertyFeatureResult (**data: Any)

Expand source code

class PropertyFeatureResult(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    property: Annotated[
        str | property_id.PropertyId, Field(description='The property these features apply to')
    ]
    features: Annotated[
        dict[str, property_feature_value.PropertyFeatureValue] | None,
        Field(description='Map of feature_id to feature value'),
    ] = None
    coverage_status: Annotated[
        CoverageStatus,
        Field(
            description='Whether this property is covered by this governance agent: covered (has data), not_covered (not measured), pending (measurement in progress)'
        ),
    ]
    last_evaluated: Annotated[
        AwareDatetime | None,
        Field(description='When features were last evaluated for this property'),
    ] = None
    ext: ext_1.ExtensionObject | None = 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

• AdCPBaseModel
• pydantic.main.BaseModel

Class variables

var coverage_status : CoverageStatus

var ext : ExtensionObject | None

var features : dict[str, PropertyFeatureValue] | None

var last_evaluated : pydantic.types.AwareDatetime | None

var model_config

var property : str | PropertyId

Inherited members

• AdCPBaseModel:
  • model_dump
  • model_dump_json
  • model_summary