Module adcp.types.generated_poc.tmp.error

Classes

class Code (*args, **kwds)
Expand source code
class Code(Enum):
    invalid_request = 'invalid_request'
    unknown_package = 'unknown_package'
    rate_limited = 'rate_limited'
    timeout = 'timeout'
    internal_error = 'internal_error'
    provider_unavailable = 'provider_unavailable'

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 internal_error
var invalid_request
var provider_unavailable
var rate_limited
var timeout
var unknown_package
class TmpError (**data: Any)
Expand source code
class TmpError(AdCPBaseModel):
    model_config = ConfigDict(
        extra='allow',
    )
    code: Annotated[Code, Field(description='Machine-readable error code')]
    message: Annotated[
        str | None, Field(description='Human-readable error description for debugging')
    ] = None
    request_id: Annotated[
        str, Field(description='Echoed request identifier from the original request')
    ]
    type: Annotated[
        Literal['error'], Field(description='Message type discriminator for deserialization.')
    ]

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

Class variables

var codeCode
var message : str | None
var model_config
var request_id : str
var type : Literal['error']

Inherited members