ModelConfigData
Pydantic mypy plugin model config class.
Attributes
| Attribute | Type | Description |
|---|---|---|
| forbid_extra | `bool | None` |
| frozen | `bool | None` |
| from_attributes | `bool | None` |
| populate_by_name | `bool | None` |
| validate_by_alias | `bool | None` |
| validate_by_name | `bool | None` |
| has_alias_generator | `bool | None` |
| strict | `bool | None` |
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
| Name | Type | Description |
|---|---|---|
| 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 |
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
| Name | Type | Description |
|---|---|---|
| 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 |
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
| Type | Description |
|---|---|
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
| Name | Type | Description |
|---|---|---|
| config | `ModelConfigData | None` |
Returns
| Type | Description |
|---|---|
None | None |
setdefault()
@classmethod
def setdefault(
key: str,
value: Any
) - > None
Set default value for Pydantic model config if config value is None.
Parameters
| Name | Type | Description |
|---|---|---|
| key | str | The name of the configuration attribute to check and potentially set. |
| value | Any | The value to assign to the attribute if its current value is None. |
Returns
| Type | Description |
|---|---|
None | None |