ConfigUnitDataModel

ConfigUnitDataModel is the base class for defining configuration data models for individual configurable units.

A configurable unit data model organizes configuration into API, Implementation, and Runtime sections using direct schema-typed fields on the configurable unit model itself.

The configuration sections are defined as fields on the ConfigUnitDataModel subclass. Only include the sections relevant to your configurable unit (a configurable unit can have 1 to 3 sections).

Example with all three configuration sections: class MyConfigUnitDataModel(ConfigUnitDataModel): api: MyApiConfigurationSchema implementation: MyImplementationConfigurationSchema runtime: MyRuntimeConfigurationSchema

Example with multiple runtime schemas on the configurable unit: class MyConfigUnitDataModel(ConfigUnitDataModel): runtime_machine_config: MachineConfig runtime_process_configs: list[ProcessConfig]

Inherits from: ConfigModel: The base configuration model class.

Member Functions:

configuration_schema

configuration_schema()

Return a set of configuration schema types that this configurable unit data model uses.

Returns

set[type[ConfigurationSchema]] — A set of ConfigurationSchema types.

configuration_data

configuration_data()

Return an iterable of configuration schema instances that this configurable unit manages.

Returns

Iterable[ConfigurationSchema] — An iterable of ConfigurationSchema instances.