|
- import json
- from enum import Enum
- from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Tuple, Type, Union
-
- from .typing import AnyCallable
- from .utils import GetterDict
-
- if TYPE_CHECKING:
- from typing import overload
-
- import typing_extensions
-
- from .fields import ModelField
- from .main import BaseModel
-
- ConfigType = Type['BaseConfig']
-
- class SchemaExtraCallable(typing_extensions.Protocol):
- @overload
- def __call__(self, schema: Dict[str, Any]) -> None:
- pass
-
- @overload
- def __call__(self, schema: Dict[str, Any], model_class: Type[BaseModel]) -> None:
- pass
-
- else:
- SchemaExtraCallable = Callable[..., None]
-
- __all__ = 'BaseConfig', 'Extra', 'inherit_config', 'prepare_config'
-
-
- class Extra(str, Enum):
- allow = 'allow'
- ignore = 'ignore'
- forbid = 'forbid'
-
-
- class BaseConfig:
- title: Optional[str] = None
- anystr_lower: bool = False
- anystr_strip_whitespace: bool = False
- min_anystr_length: int = 0
- max_anystr_length: Optional[int] = None
- validate_all: bool = False
- extra: Extra = Extra.ignore
- allow_mutation: bool = True
- frozen: bool = False
- allow_population_by_field_name: bool = False
- use_enum_values: bool = False
- fields: Dict[str, Union[str, Dict[str, str]]] = {}
- validate_assignment: bool = False
- error_msg_templates: Dict[str, str] = {}
- arbitrary_types_allowed: bool = False
- orm_mode: bool = False
- getter_dict: Type[GetterDict] = GetterDict
- alias_generator: Optional[Callable[[str], str]] = None
- keep_untouched: Tuple[type, ...] = ()
- schema_extra: Union[Dict[str, Any], 'SchemaExtraCallable'] = {}
- json_loads: Callable[[str], Any] = json.loads
- json_dumps: Callable[..., str] = json.dumps
- # key type should include ForwardRef, but that breaks with python3.6
- json_encoders: Dict[Union[Type[Any], str], AnyCallable] = {}
- underscore_attrs_are_private: bool = False
-
- # whether inherited models as fields should be reconstructed as base model
- copy_on_model_validation: bool = True
- # whether `Union` should check all allowed types before even trying to coerce
- smart_union: bool = False
-
- @classmethod
- def get_field_info(cls, name: str) -> Dict[str, Any]:
- """
- Get properties of FieldInfo from the `fields` property of the config class.
- """
-
- fields_value = cls.fields.get(name)
-
- if isinstance(fields_value, str):
- field_info: Dict[str, Any] = {'alias': fields_value}
- elif isinstance(fields_value, dict):
- field_info = fields_value
- else:
- field_info = {}
-
- if 'alias' in field_info:
- field_info.setdefault('alias_priority', 2)
-
- if field_info.get('alias_priority', 0) <= 1 and cls.alias_generator:
- alias = cls.alias_generator(name)
- if not isinstance(alias, str):
- raise TypeError(f'Config.alias_generator must return str, not {alias.__class__}')
- field_info.update(alias=alias, alias_priority=1)
- return field_info
-
- @classmethod
- def prepare_field(cls, field: 'ModelField') -> None:
- """
- Optional hook to check or modify fields during model creation.
- """
- pass
-
-
- def inherit_config(self_config: 'ConfigType', parent_config: 'ConfigType', **namespace: Any) -> 'ConfigType':
- if not self_config:
- base_classes: Tuple['ConfigType', ...] = (parent_config,)
- elif self_config == parent_config:
- base_classes = (self_config,)
- else:
- base_classes = self_config, parent_config
-
- namespace['json_encoders'] = {
- **getattr(parent_config, 'json_encoders', {}),
- **getattr(self_config, 'json_encoders', {}),
- **namespace.get('json_encoders', {}),
- }
-
- return type('Config', base_classes, namespace)
-
-
- def prepare_config(config: Type[BaseConfig], cls_name: str) -> None:
- if not isinstance(config.extra, Extra):
- try:
- config.extra = Extra(config.extra)
- except ValueError:
- raise ValueError(f'"{cls_name}": {config.extra} is not a valid value for "extra"')
|