ironic.objects.fields module

class ironic.objects.fields.BooleanField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: BooleanField

class ironic.objects.fields.DateTimeField(tzinfo_aware: bool = True, **kwargs: Any)

Bases: DateTimeField

class ironic.objects.fields.EnumField(valid_values: Collection[Any], **kwargs: Any)

Bases: EnumField

class ironic.objects.fields.FlexibleDict

Bases: FieldType

coerce(obj, attr, value)

This is called to coerce (if possible) a value on assignment.

This method should convert the value given into the designated type, or throw an exception if this is not possible.

Param:obj:

The VersionedObject on which an attribute is being set

Param:attr:

The name of the attribute being set

Param:value:

The value being set

Returns:

A properly-typed value

class ironic.objects.fields.FlexibleDictField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: AutoTypedField

AUTO_TYPE: FieldType[T] = <ironic.objects.fields.FlexibleDict object>

class ironic.objects.fields.IntegerField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: IntegerField

class ironic.objects.fields.ListOfFlexibleDictsField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: AutoTypedField

AUTO_TYPE: FieldType[T] = <oslo_versionedobjects.fields.List object>

class ironic.objects.fields.ListOfObjectsField(objtype: str, subclasses: bool = False, **kwargs: Any)

Bases: ListOfObjectsField

class ironic.objects.fields.ListOfStringsField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: ListOfStringsField

class ironic.objects.fields.MACAddress

Bases: FieldType

coerce(obj, attr, value)

This is called to coerce (if possible) a value on assignment.

This method should convert the value given into the designated type, or throw an exception if this is not possible.

Param:obj:

The VersionedObject on which an attribute is being set

Param:attr:

The name of the attribute being set

Param:value:

The value being set

Returns:

A properly-typed value

class ironic.objects.fields.MACAddressField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: AutoTypedField

AUTO_TYPE: FieldType[T] = <ironic.objects.fields.MACAddress object>

class ironic.objects.fields.NotificationLevel

Bases: Enum

ALL = ('debug', 'info', 'warning', 'error', 'critical')

CRITICAL = 'critical'

DEBUG = 'debug'

ERROR = 'error'

INFO = 'info'

WARNING = 'warning'

class ironic.objects.fields.NotificationLevelField(nullable: bool = False, default: str | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: BaseEnumField

AUTO_TYPE: FieldType[T] = <ironic.objects.fields.NotificationLevel object>

class ironic.objects.fields.NotificationStatus

Bases: Enum

ALL = ('start', 'end', 'error', 'success')

END = 'end'

ERROR = 'error'

START = 'start'

SUCCESS = 'success'

class ironic.objects.fields.NotificationStatusField(nullable: bool = False, default: str | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: BaseEnumField

AUTO_TYPE: FieldType[T] = <ironic.objects.fields.NotificationStatus object>

class ironic.objects.fields.ObjectField(objtype: str, subclasses: bool = False, **kwargs: Any)

Bases: ObjectField

class ironic.objects.fields.StringAcceptsCallable

Bases: String

coerce(obj, attr, value)

This is called to coerce (if possible) a value on assignment.

This method should convert the value given into the designated type, or throw an exception if this is not possible.

Param:obj:

The VersionedObject on which an attribute is being set

Param:attr:

The name of the attribute being set

Param:value:

The value being set

Returns:

A properly-typed value

class ironic.objects.fields.StringField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: StringField

class ironic.objects.fields.StringFieldThatAcceptsCallable(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: StringField

Custom StringField object that allows for functions as default

In some cases we need to allow for dynamic defaults based on configuration options, this StringField object allows for a function to be passed as a default, and will only process it at the point the field is coerced

AUTO_TYPE: FieldType[T] = <ironic.objects.fields.StringAcceptsCallable object>

class ironic.objects.fields.UUIDField(nullable: bool = False, default: ~oslo_versionedobjects.fields.T | type[~oslo_versionedobjects.fields.UnspecifiedDefault] = <class 'oslo_versionedobjects.fields.UnspecifiedDefault'>, read_only: bool = False)

Bases: UUIDField