Skip to main content

ModelConfigData

Pydantic mypy plugin model config class.

Attributes

AttributeTypeDescription
forbid_extra`boolNone`
frozen`boolNone`
from_attributes`boolNone`
populate_by_name`boolNone`
validate_by_alias`boolNone`
validate_by_name`boolNone`
has_alias_generator`boolNone`
strict`boolNone`

Constructor

Signature

def ModelConfigData(
forbid_extra: bool | None = None,
frozen: bool | None = None,
from_attributes: bool | None = None,
populate_by_name: bool | None = None,
validate_by_alias: bool | None = None,
validate_by_name: bool | None = None,
has_alias_generator: bool | None = None,
strict: bool | None = None
) - > None

Parameters

NameTypeDescription
forbid_extra`boolNone` = None
frozen`boolNone` = None
from_attributes`boolNone` = None
populate_by_name`boolNone` = None
validate_by_alias`boolNone` = None
validate_by_name`boolNone` = None
has_alias_generator`boolNone` = None
strict`boolNone` = None

Signature

def ModelConfigData(
forbid_extra: bool | None = None,
frozen: bool | None = None,
from_attributes: bool | None = None,
populate_by_name: bool | None = None,
validate_by_alias: bool | None = None,
validate_by_name: bool | None = None,
has_alias_generator: bool | None = None,
strict: bool | None = None
) - > None

Parameters

NameTypeDescription
forbid_extra`boolNone` = None
frozen`boolNone` = None
from_attributes`boolNone` = None
populate_by_name`boolNone` = None
validate_by_alias`boolNone` = None
validate_by_name`boolNone` = None
has_alias_generator`boolNone` = None
strict`boolNone` = None

Methods


get_values_dict()

@classmethod
def get_values_dict() - > dict[str, Any]

Returns a dict of Pydantic model config names to their values. It includes the config if config value is not None.

Returns

TypeDescription
dict[str, Any]A dictionary mapping configuration attribute names to their assigned values, excluding any that are None.

update()

@classmethod
def update(
config: ModelConfigData | None
) - > None

Update Pydantic model config values.

Parameters

NameTypeDescription
config`ModelConfigDataNone`

Returns

TypeDescription
NoneNone

setdefault()

@classmethod
def setdefault(
key: str,
value: Any
) - > None

Set default value for Pydantic model config if config value is None.

Parameters

NameTypeDescription
keystrThe name of the configuration attribute to check and potentially set.
valueAnyThe value to assign to the attribute if its current value is None.

Returns

TypeDescription
NoneNone