_mock_val_ser.py 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. from __future__ import annotations
  2. from collections.abc import Iterator, Mapping
  3. from typing import TYPE_CHECKING, Any, Callable, Generic, Literal, TypeVar, Union
  4. from pydantic_core import CoreSchema, SchemaSerializer, SchemaValidator
  5. from ..errors import PydanticErrorCodes, PydanticUserError
  6. from ..plugin._schema_validator import PluggableSchemaValidator
  7. if TYPE_CHECKING:
  8. from ..dataclasses import PydanticDataclass
  9. from ..main import BaseModel
  10. from ..type_adapter import TypeAdapter
  11. ValSer = TypeVar('ValSer', bound=Union[SchemaValidator, PluggableSchemaValidator, SchemaSerializer])
  12. T = TypeVar('T')
  13. class MockCoreSchema(Mapping[str, Any]):
  14. """Mocker for `pydantic_core.CoreSchema` which optionally attempts to
  15. rebuild the thing it's mocking when one of its methods is accessed and raises an error if that fails.
  16. """
  17. __slots__ = '_error_message', '_code', '_attempt_rebuild', '_built_memo'
  18. def __init__(
  19. self,
  20. error_message: str,
  21. *,
  22. code: PydanticErrorCodes,
  23. attempt_rebuild: Callable[[], CoreSchema | None] | None = None,
  24. ) -> None:
  25. self._error_message = error_message
  26. self._code: PydanticErrorCodes = code
  27. self._attempt_rebuild = attempt_rebuild
  28. self._built_memo: CoreSchema | None = None
  29. def __getitem__(self, key: str) -> Any:
  30. return self._get_built().__getitem__(key)
  31. def __len__(self) -> int:
  32. return self._get_built().__len__()
  33. def __iter__(self) -> Iterator[str]:
  34. return self._get_built().__iter__()
  35. def _get_built(self) -> CoreSchema:
  36. if self._built_memo is not None:
  37. return self._built_memo
  38. if self._attempt_rebuild:
  39. schema = self._attempt_rebuild()
  40. if schema is not None:
  41. self._built_memo = schema
  42. return schema
  43. raise PydanticUserError(self._error_message, code=self._code)
  44. def rebuild(self) -> CoreSchema | None:
  45. self._built_memo = None
  46. if self._attempt_rebuild:
  47. schema = self._attempt_rebuild()
  48. if schema is not None:
  49. return schema
  50. else:
  51. raise PydanticUserError(self._error_message, code=self._code)
  52. return None
  53. class MockValSer(Generic[ValSer]):
  54. """Mocker for `pydantic_core.SchemaValidator` or `pydantic_core.SchemaSerializer` which optionally attempts to
  55. rebuild the thing it's mocking when one of its methods is accessed and raises an error if that fails.
  56. """
  57. __slots__ = '_error_message', '_code', '_val_or_ser', '_attempt_rebuild'
  58. def __init__(
  59. self,
  60. error_message: str,
  61. *,
  62. code: PydanticErrorCodes,
  63. val_or_ser: Literal['validator', 'serializer'],
  64. attempt_rebuild: Callable[[], ValSer | None] | None = None,
  65. ) -> None:
  66. self._error_message = error_message
  67. self._val_or_ser = SchemaValidator if val_or_ser == 'validator' else SchemaSerializer
  68. self._code: PydanticErrorCodes = code
  69. self._attempt_rebuild = attempt_rebuild
  70. def __getattr__(self, item: str) -> None:
  71. __tracebackhide__ = True
  72. if self._attempt_rebuild:
  73. val_ser = self._attempt_rebuild()
  74. if val_ser is not None:
  75. return getattr(val_ser, item)
  76. # raise an AttributeError if `item` doesn't exist
  77. getattr(self._val_or_ser, item)
  78. raise PydanticUserError(self._error_message, code=self._code)
  79. def rebuild(self) -> ValSer | None:
  80. if self._attempt_rebuild:
  81. val_ser = self._attempt_rebuild()
  82. if val_ser is not None:
  83. return val_ser
  84. else:
  85. raise PydanticUserError(self._error_message, code=self._code)
  86. return None
  87. def set_type_adapter_mocks(adapter: TypeAdapter) -> None:
  88. """Set `core_schema`, `validator` and `serializer` to mock core types on a type adapter instance.
  89. Args:
  90. adapter: The type adapter instance to set the mocks on
  91. """
  92. type_repr = str(adapter._type)
  93. undefined_type_error_message = (
  94. f'`TypeAdapter[{type_repr}]` is not fully defined; you should define `{type_repr}` and all referenced types,'
  95. f' then call `.rebuild()` on the instance.'
  96. )
  97. def attempt_rebuild_fn(attr_fn: Callable[[TypeAdapter], T]) -> Callable[[], T | None]:
  98. def handler() -> T | None:
  99. if adapter.rebuild(raise_errors=False, _parent_namespace_depth=5) is not False:
  100. return attr_fn(adapter)
  101. return None
  102. return handler
  103. adapter.core_schema = MockCoreSchema( # pyright: ignore[reportAttributeAccessIssue]
  104. undefined_type_error_message,
  105. code='class-not-fully-defined',
  106. attempt_rebuild=attempt_rebuild_fn(lambda ta: ta.core_schema),
  107. )
  108. adapter.validator = MockValSer( # pyright: ignore[reportAttributeAccessIssue]
  109. undefined_type_error_message,
  110. code='class-not-fully-defined',
  111. val_or_ser='validator',
  112. attempt_rebuild=attempt_rebuild_fn(lambda ta: ta.validator),
  113. )
  114. adapter.serializer = MockValSer( # pyright: ignore[reportAttributeAccessIssue]
  115. undefined_type_error_message,
  116. code='class-not-fully-defined',
  117. val_or_ser='serializer',
  118. attempt_rebuild=attempt_rebuild_fn(lambda ta: ta.serializer),
  119. )
  120. def set_model_mocks(cls: type[BaseModel], undefined_name: str = 'all referenced types') -> None:
  121. """Set `__pydantic_core_schema__`, `__pydantic_validator__` and `__pydantic_serializer__` to mock core types on a model.
  122. Args:
  123. cls: The model class to set the mocks on
  124. undefined_name: Name of the undefined thing, used in error messages
  125. """
  126. undefined_type_error_message = (
  127. f'`{cls.__name__}` is not fully defined; you should define {undefined_name},'
  128. f' then call `{cls.__name__}.model_rebuild()`.'
  129. )
  130. def attempt_rebuild_fn(attr_fn: Callable[[type[BaseModel]], T]) -> Callable[[], T | None]:
  131. def handler() -> T | None:
  132. if cls.model_rebuild(raise_errors=False, _parent_namespace_depth=5) is not False:
  133. return attr_fn(cls)
  134. return None
  135. return handler
  136. cls.__pydantic_core_schema__ = MockCoreSchema( # pyright: ignore[reportAttributeAccessIssue]
  137. undefined_type_error_message,
  138. code='class-not-fully-defined',
  139. attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_core_schema__),
  140. )
  141. cls.__pydantic_validator__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue]
  142. undefined_type_error_message,
  143. code='class-not-fully-defined',
  144. val_or_ser='validator',
  145. attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_validator__),
  146. )
  147. cls.__pydantic_serializer__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue]
  148. undefined_type_error_message,
  149. code='class-not-fully-defined',
  150. val_or_ser='serializer',
  151. attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_serializer__),
  152. )
  153. def set_dataclass_mocks(cls: type[PydanticDataclass], undefined_name: str = 'all referenced types') -> None:
  154. """Set `__pydantic_validator__` and `__pydantic_serializer__` to `MockValSer`s on a dataclass.
  155. Args:
  156. cls: The model class to set the mocks on
  157. undefined_name: Name of the undefined thing, used in error messages
  158. """
  159. from ..dataclasses import rebuild_dataclass
  160. undefined_type_error_message = (
  161. f'`{cls.__name__}` is not fully defined; you should define {undefined_name},'
  162. f' then call `pydantic.dataclasses.rebuild_dataclass({cls.__name__})`.'
  163. )
  164. def attempt_rebuild_fn(attr_fn: Callable[[type[PydanticDataclass]], T]) -> Callable[[], T | None]:
  165. def handler() -> T | None:
  166. if rebuild_dataclass(cls, raise_errors=False, _parent_namespace_depth=5) is not False:
  167. return attr_fn(cls)
  168. return None
  169. return handler
  170. cls.__pydantic_core_schema__ = MockCoreSchema( # pyright: ignore[reportAttributeAccessIssue]
  171. undefined_type_error_message,
  172. code='class-not-fully-defined',
  173. attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_core_schema__),
  174. )
  175. cls.__pydantic_validator__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue]
  176. undefined_type_error_message,
  177. code='class-not-fully-defined',
  178. val_or_ser='validator',
  179. attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_validator__),
  180. )
  181. cls.__pydantic_serializer__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue]
  182. undefined_type_error_message,
  183. code='class-not-fully-defined',
  184. val_or_ser='serializer',
  185. attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_serializer__),
  186. )