Module adcp.types.generated_poc.property.feature_requirement

Classes

class FeatureRequirement (**data: Any)

Expand source code

class FeatureRequirement(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    allowed_values: Annotated[
        list[Any] | None,
        Field(
            description='Values that pass the requirement (for binary/categorical features)',
            min_length=1,
        ),
    ] = None
    feature_id: Annotated[
        str, Field(description='Feature to evaluate (discovered via get_adcp_capabilities)')
    ]
    if_not_covered: Annotated[
        IfNotCovered | None,
        Field(
            description="How to handle properties where this feature is not covered. 'exclude' (default): property is removed from the list. 'include': property passes this requirement (fail-open)."
        ),
    ] = IfNotCovered.exclude
    max_value: Annotated[
        float | None, Field(description='Maximum numeric value allowed (for quantitative features)')
    ] = None
    min_value: Annotated[
        float | None,
        Field(description='Minimum numeric value required (for quantitative features)'),
    ] = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so that 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. Consumers who want strict validation can override with extra='forbid'.

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 allowed_values : list[typing.Any] | None

var feature_id : str

var if_not_covered : IfNotCovered | None

var max_value : float | None

var min_value : float | None

var model_config

Inherited members

• AdCPBaseModel:
  • model_dump
  • model_dump_json
  • model_summary

class IfNotCovered (*args, **kwds)

Expand source code

class IfNotCovered(Enum):
    exclude = 'exclude'
    include = 'include'

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access::

>>> Color.RED
<Color.RED: 1>

• value lookup:

>>> Color(1)
<Color.RED: 1>

• name lookup:

>>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Ancestors

• enum.Enum

Class variables

var exclude

var include