You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

724 line
20 KiB

  1. import re
  2. from collections import OrderedDict, deque
  3. from collections.abc import Hashable as CollectionsHashable
  4. from datetime import date, datetime, time, timedelta
  5. from decimal import Decimal, DecimalException
  6. from enum import Enum, IntEnum
  7. from ipaddress import IPv4Address, IPv4Interface, IPv4Network, IPv6Address, IPv6Interface, IPv6Network
  8. from pathlib import Path
  9. from typing import (
  10. TYPE_CHECKING,
  11. Any,
  12. Callable,
  13. Deque,
  14. Dict,
  15. FrozenSet,
  16. Generator,
  17. Hashable,
  18. List,
  19. NamedTuple,
  20. Pattern,
  21. Set,
  22. Tuple,
  23. Type,
  24. TypeVar,
  25. Union,
  26. )
  27. from uuid import UUID
  28. from . import errors
  29. from .datetime_parse import parse_date, parse_datetime, parse_duration, parse_time
  30. from .typing import (
  31. AnyCallable,
  32. ForwardRef,
  33. all_literal_values,
  34. display_as_type,
  35. get_class,
  36. is_callable_type,
  37. is_literal_type,
  38. is_namedtuple,
  39. is_none_type,
  40. is_typeddict,
  41. )
  42. from .utils import almost_equal_floats, lenient_issubclass, sequence_like
  43. if TYPE_CHECKING:
  44. from typing_extensions import Literal, TypedDict
  45. from .config import BaseConfig
  46. from .fields import ModelField
  47. from .types import ConstrainedDecimal, ConstrainedFloat, ConstrainedInt
  48. ConstrainedNumber = Union[ConstrainedDecimal, ConstrainedFloat, ConstrainedInt]
  49. AnyOrderedDict = OrderedDict[Any, Any]
  50. Number = Union[int, float, Decimal]
  51. StrBytes = Union[str, bytes]
  52. def str_validator(v: Any) -> Union[str]:
  53. if isinstance(v, str):
  54. if isinstance(v, Enum):
  55. return v.value
  56. else:
  57. return v
  58. elif isinstance(v, (float, int, Decimal)):
  59. # is there anything else we want to add here? If you think so, create an issue.
  60. return str(v)
  61. elif isinstance(v, (bytes, bytearray)):
  62. return v.decode()
  63. else:
  64. raise errors.StrError()
  65. def strict_str_validator(v: Any) -> Union[str]:
  66. if isinstance(v, str) and not isinstance(v, Enum):
  67. return v
  68. raise errors.StrError()
  69. def bytes_validator(v: Any) -> bytes:
  70. if isinstance(v, bytes):
  71. return v
  72. elif isinstance(v, bytearray):
  73. return bytes(v)
  74. elif isinstance(v, str):
  75. return v.encode()
  76. elif isinstance(v, (float, int, Decimal)):
  77. return str(v).encode()
  78. else:
  79. raise errors.BytesError()
  80. def strict_bytes_validator(v: Any) -> Union[bytes]:
  81. if isinstance(v, bytes):
  82. return v
  83. elif isinstance(v, bytearray):
  84. return bytes(v)
  85. else:
  86. raise errors.BytesError()
  87. BOOL_FALSE = {0, '0', 'off', 'f', 'false', 'n', 'no'}
  88. BOOL_TRUE = {1, '1', 'on', 't', 'true', 'y', 'yes'}
  89. def bool_validator(v: Any) -> bool:
  90. if v is True or v is False:
  91. return v
  92. if isinstance(v, bytes):
  93. v = v.decode()
  94. if isinstance(v, str):
  95. v = v.lower()
  96. try:
  97. if v in BOOL_TRUE:
  98. return True
  99. if v in BOOL_FALSE:
  100. return False
  101. except TypeError:
  102. raise errors.BoolError()
  103. raise errors.BoolError()
  104. def int_validator(v: Any) -> int:
  105. if isinstance(v, int) and not (v is True or v is False):
  106. return v
  107. try:
  108. return int(v)
  109. except (TypeError, ValueError):
  110. raise errors.IntegerError()
  111. def strict_int_validator(v: Any) -> int:
  112. if isinstance(v, int) and not (v is True or v is False):
  113. return v
  114. raise errors.IntegerError()
  115. def float_validator(v: Any) -> float:
  116. if isinstance(v, float):
  117. return v
  118. try:
  119. return float(v)
  120. except (TypeError, ValueError):
  121. raise errors.FloatError()
  122. def strict_float_validator(v: Any) -> float:
  123. if isinstance(v, float):
  124. return v
  125. raise errors.FloatError()
  126. def number_multiple_validator(v: 'Number', field: 'ModelField') -> 'Number':
  127. field_type: ConstrainedNumber = field.type_
  128. if field_type.multiple_of is not None:
  129. mod = float(v) / float(field_type.multiple_of) % 1
  130. if not almost_equal_floats(mod, 0.0) and not almost_equal_floats(mod, 1.0):
  131. raise errors.NumberNotMultipleError(multiple_of=field_type.multiple_of)
  132. return v
  133. def number_size_validator(v: 'Number', field: 'ModelField') -> 'Number':
  134. field_type: ConstrainedNumber = field.type_
  135. if field_type.gt is not None and not v > field_type.gt:
  136. raise errors.NumberNotGtError(limit_value=field_type.gt)
  137. elif field_type.ge is not None and not v >= field_type.ge:
  138. raise errors.NumberNotGeError(limit_value=field_type.ge)
  139. if field_type.lt is not None and not v < field_type.lt:
  140. raise errors.NumberNotLtError(limit_value=field_type.lt)
  141. if field_type.le is not None and not v <= field_type.le:
  142. raise errors.NumberNotLeError(limit_value=field_type.le)
  143. return v
  144. def constant_validator(v: 'Any', field: 'ModelField') -> 'Any':
  145. """Validate ``const`` fields.
  146. The value provided for a ``const`` field must be equal to the default value
  147. of the field. This is to support the keyword of the same name in JSON
  148. Schema.
  149. """
  150. if v != field.default:
  151. raise errors.WrongConstantError(given=v, permitted=[field.default])
  152. return v
  153. def anystr_length_validator(v: 'StrBytes', config: 'BaseConfig') -> 'StrBytes':
  154. v_len = len(v)
  155. min_length = config.min_anystr_length
  156. if v_len < min_length:
  157. raise errors.AnyStrMinLengthError(limit_value=min_length)
  158. max_length = config.max_anystr_length
  159. if max_length is not None and v_len > max_length:
  160. raise errors.AnyStrMaxLengthError(limit_value=max_length)
  161. return v
  162. def anystr_strip_whitespace(v: 'StrBytes') -> 'StrBytes':
  163. return v.strip()
  164. def anystr_lower(v: 'StrBytes') -> 'StrBytes':
  165. return v.lower()
  166. def ordered_dict_validator(v: Any) -> 'AnyOrderedDict':
  167. if isinstance(v, OrderedDict):
  168. return v
  169. try:
  170. return OrderedDict(v)
  171. except (TypeError, ValueError):
  172. raise errors.DictError()
  173. def dict_validator(v: Any) -> Dict[Any, Any]:
  174. if isinstance(v, dict):
  175. return v
  176. try:
  177. return dict(v)
  178. except (TypeError, ValueError):
  179. raise errors.DictError()
  180. def list_validator(v: Any) -> List[Any]:
  181. if isinstance(v, list):
  182. return v
  183. elif sequence_like(v):
  184. return list(v)
  185. else:
  186. raise errors.ListError()
  187. def tuple_validator(v: Any) -> Tuple[Any, ...]:
  188. if isinstance(v, tuple):
  189. return v
  190. elif sequence_like(v):
  191. return tuple(v)
  192. else:
  193. raise errors.TupleError()
  194. def set_validator(v: Any) -> Set[Any]:
  195. if isinstance(v, set):
  196. return v
  197. elif sequence_like(v):
  198. return set(v)
  199. else:
  200. raise errors.SetError()
  201. def frozenset_validator(v: Any) -> FrozenSet[Any]:
  202. if isinstance(v, frozenset):
  203. return v
  204. elif sequence_like(v):
  205. return frozenset(v)
  206. else:
  207. raise errors.FrozenSetError()
  208. def deque_validator(v: Any) -> Deque[Any]:
  209. if isinstance(v, deque):
  210. return v
  211. elif sequence_like(v):
  212. return deque(v)
  213. else:
  214. raise errors.DequeError()
  215. def enum_member_validator(v: Any, field: 'ModelField', config: 'BaseConfig') -> Enum:
  216. try:
  217. enum_v = field.type_(v)
  218. except ValueError:
  219. # field.type_ should be an enum, so will be iterable
  220. raise errors.EnumMemberError(enum_values=list(field.type_))
  221. return enum_v.value if config.use_enum_values else enum_v
  222. def uuid_validator(v: Any, field: 'ModelField') -> UUID:
  223. try:
  224. if isinstance(v, str):
  225. v = UUID(v)
  226. elif isinstance(v, (bytes, bytearray)):
  227. try:
  228. v = UUID(v.decode())
  229. except ValueError:
  230. # 16 bytes in big-endian order as the bytes argument fail
  231. # the above check
  232. v = UUID(bytes=v)
  233. except ValueError:
  234. raise errors.UUIDError()
  235. if not isinstance(v, UUID):
  236. raise errors.UUIDError()
  237. required_version = getattr(field.type_, '_required_version', None)
  238. if required_version and v.version != required_version:
  239. raise errors.UUIDVersionError(required_version=required_version)
  240. return v
  241. def decimal_validator(v: Any) -> Decimal:
  242. if isinstance(v, Decimal):
  243. return v
  244. elif isinstance(v, (bytes, bytearray)):
  245. v = v.decode()
  246. v = str(v).strip()
  247. try:
  248. v = Decimal(v)
  249. except DecimalException:
  250. raise errors.DecimalError()
  251. if not v.is_finite():
  252. raise errors.DecimalIsNotFiniteError()
  253. return v
  254. def hashable_validator(v: Any) -> Hashable:
  255. if isinstance(v, Hashable):
  256. return v
  257. raise errors.HashableError()
  258. def ip_v4_address_validator(v: Any) -> IPv4Address:
  259. if isinstance(v, IPv4Address):
  260. return v
  261. try:
  262. return IPv4Address(v)
  263. except ValueError:
  264. raise errors.IPv4AddressError()
  265. def ip_v6_address_validator(v: Any) -> IPv6Address:
  266. if isinstance(v, IPv6Address):
  267. return v
  268. try:
  269. return IPv6Address(v)
  270. except ValueError:
  271. raise errors.IPv6AddressError()
  272. def ip_v4_network_validator(v: Any) -> IPv4Network:
  273. """
  274. Assume IPv4Network initialised with a default ``strict`` argument
  275. See more:
  276. https://docs.python.org/library/ipaddress.html#ipaddress.IPv4Network
  277. """
  278. if isinstance(v, IPv4Network):
  279. return v
  280. try:
  281. return IPv4Network(v)
  282. except ValueError:
  283. raise errors.IPv4NetworkError()
  284. def ip_v6_network_validator(v: Any) -> IPv6Network:
  285. """
  286. Assume IPv6Network initialised with a default ``strict`` argument
  287. See more:
  288. https://docs.python.org/library/ipaddress.html#ipaddress.IPv6Network
  289. """
  290. if isinstance(v, IPv6Network):
  291. return v
  292. try:
  293. return IPv6Network(v)
  294. except ValueError:
  295. raise errors.IPv6NetworkError()
  296. def ip_v4_interface_validator(v: Any) -> IPv4Interface:
  297. if isinstance(v, IPv4Interface):
  298. return v
  299. try:
  300. return IPv4Interface(v)
  301. except ValueError:
  302. raise errors.IPv4InterfaceError()
  303. def ip_v6_interface_validator(v: Any) -> IPv6Interface:
  304. if isinstance(v, IPv6Interface):
  305. return v
  306. try:
  307. return IPv6Interface(v)
  308. except ValueError:
  309. raise errors.IPv6InterfaceError()
  310. def path_validator(v: Any) -> Path:
  311. if isinstance(v, Path):
  312. return v
  313. try:
  314. return Path(v)
  315. except TypeError:
  316. raise errors.PathError()
  317. def path_exists_validator(v: Any) -> Path:
  318. if not v.exists():
  319. raise errors.PathNotExistsError(path=v)
  320. return v
  321. def callable_validator(v: Any) -> AnyCallable:
  322. """
  323. Perform a simple check if the value is callable.
  324. Note: complete matching of argument type hints and return types is not performed
  325. """
  326. if callable(v):
  327. return v
  328. raise errors.CallableError(value=v)
  329. def enum_validator(v: Any) -> Enum:
  330. if isinstance(v, Enum):
  331. return v
  332. raise errors.EnumError(value=v)
  333. def int_enum_validator(v: Any) -> IntEnum:
  334. if isinstance(v, IntEnum):
  335. return v
  336. raise errors.IntEnumError(value=v)
  337. def make_literal_validator(type_: Any) -> Callable[[Any], Any]:
  338. permitted_choices = all_literal_values(type_)
  339. # To have a O(1) complexity and still return one of the values set inside the `Literal`,
  340. # we create a dict with the set values (a set causes some problems with the way intersection works).
  341. # In some cases the set value and checked value can indeed be different (see `test_literal_validator_str_enum`)
  342. allowed_choices = {v: v for v in permitted_choices}
  343. def literal_validator(v: Any) -> Any:
  344. try:
  345. return allowed_choices[v]
  346. except KeyError:
  347. raise errors.WrongConstantError(given=v, permitted=permitted_choices)
  348. return literal_validator
  349. def constr_length_validator(v: 'StrBytes', field: 'ModelField', config: 'BaseConfig') -> 'StrBytes':
  350. v_len = len(v)
  351. min_length = field.type_.min_length if field.type_.min_length is not None else config.min_anystr_length
  352. if v_len < min_length:
  353. raise errors.AnyStrMinLengthError(limit_value=min_length)
  354. max_length = field.type_.max_length if field.type_.max_length is not None else config.max_anystr_length
  355. if max_length is not None and v_len > max_length:
  356. raise errors.AnyStrMaxLengthError(limit_value=max_length)
  357. return v
  358. def constr_strip_whitespace(v: 'StrBytes', field: 'ModelField', config: 'BaseConfig') -> 'StrBytes':
  359. strip_whitespace = field.type_.strip_whitespace or config.anystr_strip_whitespace
  360. if strip_whitespace:
  361. v = v.strip()
  362. return v
  363. def constr_lower(v: 'StrBytes', field: 'ModelField', config: 'BaseConfig') -> 'StrBytes':
  364. lower = field.type_.to_lower or config.anystr_lower
  365. if lower:
  366. v = v.lower()
  367. return v
  368. def validate_json(v: Any, config: 'BaseConfig') -> Any:
  369. if v is None:
  370. # pass None through to other validators
  371. return v
  372. try:
  373. return config.json_loads(v) # type: ignore
  374. except ValueError:
  375. raise errors.JsonError()
  376. except TypeError:
  377. raise errors.JsonTypeError()
  378. T = TypeVar('T')
  379. def make_arbitrary_type_validator(type_: Type[T]) -> Callable[[T], T]:
  380. def arbitrary_type_validator(v: Any) -> T:
  381. if isinstance(v, type_):
  382. return v
  383. raise errors.ArbitraryTypeError(expected_arbitrary_type=type_)
  384. return arbitrary_type_validator
  385. def make_class_validator(type_: Type[T]) -> Callable[[Any], Type[T]]:
  386. def class_validator(v: Any) -> Type[T]:
  387. if lenient_issubclass(v, type_):
  388. return v
  389. raise errors.SubclassError(expected_class=type_)
  390. return class_validator
  391. def any_class_validator(v: Any) -> Type[T]:
  392. if isinstance(v, type):
  393. return v
  394. raise errors.ClassError()
  395. def none_validator(v: Any) -> 'Literal[None]':
  396. if v is None:
  397. return v
  398. raise errors.NotNoneError()
  399. def pattern_validator(v: Any) -> Pattern[str]:
  400. if isinstance(v, Pattern):
  401. return v
  402. str_value = str_validator(v)
  403. try:
  404. return re.compile(str_value)
  405. except re.error:
  406. raise errors.PatternError()
  407. NamedTupleT = TypeVar('NamedTupleT', bound=NamedTuple)
  408. def make_namedtuple_validator(namedtuple_cls: Type[NamedTupleT]) -> Callable[[Tuple[Any, ...]], NamedTupleT]:
  409. from .annotated_types import create_model_from_namedtuple
  410. NamedTupleModel = create_model_from_namedtuple(
  411. namedtuple_cls,
  412. __module__=namedtuple_cls.__module__,
  413. )
  414. namedtuple_cls.__pydantic_model__ = NamedTupleModel # type: ignore[attr-defined]
  415. def namedtuple_validator(values: Tuple[Any, ...]) -> NamedTupleT:
  416. annotations = NamedTupleModel.__annotations__
  417. if len(values) > len(annotations):
  418. raise errors.ListMaxLengthError(limit_value=len(annotations))
  419. dict_values: Dict[str, Any] = dict(zip(annotations, values))
  420. validated_dict_values: Dict[str, Any] = dict(NamedTupleModel(**dict_values))
  421. return namedtuple_cls(**validated_dict_values)
  422. return namedtuple_validator
  423. def make_typeddict_validator(
  424. typeddict_cls: Type['TypedDict'], config: Type['BaseConfig'] # type: ignore[valid-type]
  425. ) -> Callable[[Any], Dict[str, Any]]:
  426. from .annotated_types import create_model_from_typeddict
  427. TypedDictModel = create_model_from_typeddict(
  428. typeddict_cls,
  429. __config__=config,
  430. __module__=typeddict_cls.__module__,
  431. )
  432. typeddict_cls.__pydantic_model__ = TypedDictModel # type: ignore[attr-defined]
  433. def typeddict_validator(values: 'TypedDict') -> Dict[str, Any]: # type: ignore[valid-type]
  434. return TypedDictModel.parse_obj(values).dict(exclude_unset=True)
  435. return typeddict_validator
  436. class IfConfig:
  437. def __init__(self, validator: AnyCallable, *config_attr_names: str) -> None:
  438. self.validator = validator
  439. self.config_attr_names = config_attr_names
  440. def check(self, config: Type['BaseConfig']) -> bool:
  441. return any(getattr(config, name) not in {None, False} for name in self.config_attr_names)
  442. # order is important here, for example: bool is a subclass of int so has to come first, datetime before date same,
  443. # IPv4Interface before IPv4Address, etc
  444. _VALIDATORS: List[Tuple[Type[Any], List[Any]]] = [
  445. (IntEnum, [int_validator, enum_member_validator]),
  446. (Enum, [enum_member_validator]),
  447. (
  448. str,
  449. [
  450. str_validator,
  451. IfConfig(anystr_strip_whitespace, 'anystr_strip_whitespace'),
  452. IfConfig(anystr_lower, 'anystr_lower'),
  453. IfConfig(anystr_length_validator, 'min_anystr_length', 'max_anystr_length'),
  454. ],
  455. ),
  456. (
  457. bytes,
  458. [
  459. bytes_validator,
  460. IfConfig(anystr_strip_whitespace, 'anystr_strip_whitespace'),
  461. IfConfig(anystr_lower, 'anystr_lower'),
  462. IfConfig(anystr_length_validator, 'min_anystr_length', 'max_anystr_length'),
  463. ],
  464. ),
  465. (bool, [bool_validator]),
  466. (int, [int_validator]),
  467. (float, [float_validator]),
  468. (Path, [path_validator]),
  469. (datetime, [parse_datetime]),
  470. (date, [parse_date]),
  471. (time, [parse_time]),
  472. (timedelta, [parse_duration]),
  473. (OrderedDict, [ordered_dict_validator]),
  474. (dict, [dict_validator]),
  475. (list, [list_validator]),
  476. (tuple, [tuple_validator]),
  477. (set, [set_validator]),
  478. (frozenset, [frozenset_validator]),
  479. (deque, [deque_validator]),
  480. (UUID, [uuid_validator]),
  481. (Decimal, [decimal_validator]),
  482. (IPv4Interface, [ip_v4_interface_validator]),
  483. (IPv6Interface, [ip_v6_interface_validator]),
  484. (IPv4Address, [ip_v4_address_validator]),
  485. (IPv6Address, [ip_v6_address_validator]),
  486. (IPv4Network, [ip_v4_network_validator]),
  487. (IPv6Network, [ip_v6_network_validator]),
  488. ]
  489. def find_validators( # noqa: C901 (ignore complexity)
  490. type_: Type[Any], config: Type['BaseConfig']
  491. ) -> Generator[AnyCallable, None, None]:
  492. from .dataclasses import is_builtin_dataclass, make_dataclass_validator
  493. if type_ is Any or type_ is object:
  494. return
  495. type_type = type_.__class__
  496. if type_type == ForwardRef or type_type == TypeVar:
  497. return
  498. if is_none_type(type_):
  499. yield none_validator
  500. return
  501. if type_ is Pattern:
  502. yield pattern_validator
  503. return
  504. if type_ is Hashable or type_ is CollectionsHashable:
  505. yield hashable_validator
  506. return
  507. if is_callable_type(type_):
  508. yield callable_validator
  509. return
  510. if is_literal_type(type_):
  511. yield make_literal_validator(type_)
  512. return
  513. if is_builtin_dataclass(type_):
  514. yield from make_dataclass_validator(type_, config)
  515. return
  516. if type_ is Enum:
  517. yield enum_validator
  518. return
  519. if type_ is IntEnum:
  520. yield int_enum_validator
  521. return
  522. if is_namedtuple(type_):
  523. yield tuple_validator
  524. yield make_namedtuple_validator(type_)
  525. return
  526. if is_typeddict(type_):
  527. yield make_typeddict_validator(type_, config)
  528. return
  529. class_ = get_class(type_)
  530. if class_ is not None:
  531. if isinstance(class_, type):
  532. yield make_class_validator(class_)
  533. else:
  534. yield any_class_validator
  535. return
  536. for val_type, validators in _VALIDATORS:
  537. try:
  538. if issubclass(type_, val_type):
  539. for v in validators:
  540. if isinstance(v, IfConfig):
  541. if v.check(config):
  542. yield v.validator
  543. else:
  544. yield v
  545. return
  546. except TypeError:
  547. raise RuntimeError(f'error checking inheritance of {type_!r} (type: {display_as_type(type_)})')
  548. if config.arbitrary_types_allowed:
  549. yield make_arbitrary_type_validator(type_)
  550. else:
  551. raise RuntimeError(f'no validator found for {type_}, see `arbitrary_types_allowed` in Config')