Coverage for pydantic/_internal/_mock_val_ser.py: 84.03%

1from __future__ import annotations 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

2 

3from collections.abc import Iterator, Mapping 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

4from typing import TYPE_CHECKING, Any, Callable, Generic, Literal, TypeVar, Union 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

5 

6from pydantic_core import CoreSchema, SchemaSerializer, SchemaValidator 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

7 

8from ..errors import PydanticErrorCodes, PydanticUserError 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

9from ..plugin._schema_validator import PluggableSchemaValidator 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

10 

11if TYPE_CHECKING: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

12 from ..dataclasses import PydanticDataclass 

13 from ..main import BaseModel 

14 from ..type_adapter import TypeAdapter 

15 

16 

17ValSer = TypeVar('ValSer', bound=Union[SchemaValidator, PluggableSchemaValidator, SchemaSerializer]) 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

18T = TypeVar('T') 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

19 

20 

21class MockCoreSchema(Mapping[str, Any]): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

22 """Mocker for `pydantic_core.CoreSchema` which optionally attempts to 

23 rebuild the thing it's mocking when one of its methods is accessed and raises an error if that fails. 

24 """ 

25 

26 __slots__ = '_error_message', '_code', '_attempt_rebuild', '_built_memo' 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

27 

28 def __init__( 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

29 self, 

30 error_message: str, 

31 *, 

32 code: PydanticErrorCodes, 

33 attempt_rebuild: Callable[[], CoreSchema | None] | None = None, 

34 ) -> None: 

35 self._error_message = error_message 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

36 self._code: PydanticErrorCodes = code 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

37 self._attempt_rebuild = attempt_rebuild 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

38 self._built_memo: CoreSchema | None = None 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

39 

40 def __getitem__(self, key: str) -> Any: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

41 return self._get_built().__getitem__(key) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

42 

43 def __len__(self) -> int: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

44 return self._get_built().__len__() 

45 

46 def __iter__(self) -> Iterator[str]: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

47 return self._get_built().__iter__() 

48 

49 def _get_built(self) -> CoreSchema: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

50 if self._built_memo is not None: 50 ↛ 51line 50 didn't jump to line 51 because the condition on line 50 was never true35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

51 return self._built_memo 

52 

53 if self._attempt_rebuild: 53 ↛ 58line 53 didn't jump to line 58 because the condition on line 53 was always true35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

54 schema = self._attempt_rebuild() 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

55 if schema is not None: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

56 self._built_memo = schema 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

57 return schema 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

58 raise PydanticUserError(self._error_message, code=self._code) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

59 

60 def rebuild(self) -> CoreSchema | None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

61 self._built_memo = None 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

62 if self._attempt_rebuild: 62 ↛ 68line 62 didn't jump to line 68 because the condition on line 62 was always true35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

63 schema = self._attempt_rebuild() 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

64 if schema is not None: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

65 return schema 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

66 else: 

67 raise PydanticUserError(self._error_message, code=self._code) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

68 return None 

69 

70 

71class MockValSer(Generic[ValSer]): 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

72 """Mocker for `pydantic_core.SchemaValidator` or `pydantic_core.SchemaSerializer` which optionally attempts to 

73 rebuild the thing it's mocking when one of its methods is accessed and raises an error if that fails. 

74 """ 

75 

76 __slots__ = '_error_message', '_code', '_val_or_ser', '_attempt_rebuild' 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

77 

78 def __init__( 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

79 self, 

80 error_message: str, 

81 *, 

82 code: PydanticErrorCodes, 

83 val_or_ser: Literal['validator', 'serializer'], 

84 attempt_rebuild: Callable[[], ValSer | None] | None = None, 

85 ) -> None: 

86 self._error_message = error_message 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

87 self._val_or_ser = SchemaValidator if val_or_ser == 'validator' else SchemaSerializer 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

88 self._code: PydanticErrorCodes = code 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

89 self._attempt_rebuild = attempt_rebuild 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

90 

91 def __getattr__(self, item: str) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

92 __tracebackhide__ = True 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

93 if self._attempt_rebuild: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

94 val_ser = self._attempt_rebuild() 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

95 if val_ser is not None: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

96 return getattr(val_ser, item) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

97 

98 # raise an AttributeError if `item` doesn't exist 

99 getattr(self._val_or_ser, item) 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

100 raise PydanticUserError(self._error_message, code=self._code) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

101 

102 def rebuild(self) -> ValSer | None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

103 if self._attempt_rebuild: 

104 val_ser = self._attempt_rebuild() 

105 if val_ser is not None: 

106 return val_ser 

107 else: 

108 raise PydanticUserError(self._error_message, code=self._code) 

109 return None 

110 

111 

112def set_type_adapter_mocks(adapter: TypeAdapter) -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

113 """Set `core_schema`, `validator` and `serializer` to mock core types on a type adapter instance. 

114 

115 Args: 

116 adapter: The type adapter instance to set the mocks on 

117 """ 

118 type_repr = str(adapter._type) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

119 undefined_type_error_message = ( 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

120 f'`TypeAdapter[{type_repr}]` is not fully defined; you should define `{type_repr}` and all referenced types,' 

121 f' then call `.rebuild()` on the instance.' 

122 ) 

123 

124 def attempt_rebuild_fn(attr_fn: Callable[[TypeAdapter], T]) -> Callable[[], T | None]: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

125 def handler() -> T | None: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

126 if adapter.rebuild(raise_errors=False, _parent_namespace_depth=5) is not False: 126 ↛ 128line 126 didn't jump to line 128 because the condition on line 126 was always true35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

127 return attr_fn(adapter) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

128 return None 

129 

130 return handler 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

131 

132 adapter.core_schema = MockCoreSchema( # pyright: ignore[reportAttributeAccessIssue] 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

133 undefined_type_error_message, 

134 code='class-not-fully-defined', 

135 attempt_rebuild=attempt_rebuild_fn(lambda ta: ta.core_schema), 

136 ) 

137 adapter.validator = MockValSer( # pyright: ignore[reportAttributeAccessIssue] 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

138 undefined_type_error_message, 

139 code='class-not-fully-defined', 

140 val_or_ser='validator', 

141 attempt_rebuild=attempt_rebuild_fn(lambda ta: ta.validator), 

142 ) 

143 adapter.serializer = MockValSer( # pyright: ignore[reportAttributeAccessIssue] 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

144 undefined_type_error_message, 

145 code='class-not-fully-defined', 

146 val_or_ser='serializer', 

147 attempt_rebuild=attempt_rebuild_fn(lambda ta: ta.serializer), 

148 ) 

149 

150 

151def set_model_mocks(cls: type[BaseModel], undefined_name: str = 'all referenced types') -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

152 """Set `__pydantic_core_schema__`, `__pydantic_validator__` and `__pydantic_serializer__` to mock core types on a model. 

153 

154 Args: 

155 cls: The model class to set the mocks on 

156 undefined_name: Name of the undefined thing, used in error messages 

157 """ 

158 undefined_type_error_message = ( 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

159 f'`{cls.__name__}` is not fully defined; you should define {undefined_name},' 

160 f' then call `{cls.__name__}.model_rebuild()`.' 

161 ) 

162 

163 def attempt_rebuild_fn(attr_fn: Callable[[type[BaseModel]], T]) -> Callable[[], T | None]: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

164 def handler() -> T | None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

165 if cls.model_rebuild(raise_errors=False, _parent_namespace_depth=5) is not False: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

166 return attr_fn(cls) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

167 return None 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

168 

169 return handler 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

170 

171 cls.__pydantic_core_schema__ = MockCoreSchema( # pyright: ignore[reportAttributeAccessIssue] 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

172 undefined_type_error_message, 

173 code='class-not-fully-defined', 

174 attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_core_schema__), 

175 ) 

176 cls.__pydantic_validator__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue] 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

177 undefined_type_error_message, 

178 code='class-not-fully-defined', 

179 val_or_ser='validator', 

180 attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_validator__), 

181 ) 

182 cls.__pydantic_serializer__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue] 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

183 undefined_type_error_message, 

184 code='class-not-fully-defined', 

185 val_or_ser='serializer', 

186 attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_serializer__), 

187 ) 

188 

189 

190def set_dataclass_mocks(cls: type[PydanticDataclass], undefined_name: str = 'all referenced types') -> None: 36 ctx1abcdefghijklmnopqrstuvwxJyzABCDEFGHI

191 """Set `__pydantic_validator__` and `__pydantic_serializer__` to `MockValSer`s on a dataclass. 

192 

193 Args: 

194 cls: The model class to set the mocks on 

195 undefined_name: Name of the undefined thing, used in error messages 

196 """ 

197 from ..dataclasses import rebuild_dataclass 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

198 

199 undefined_type_error_message = ( 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

200 f'`{cls.__name__}` is not fully defined; you should define {undefined_name},' 

201 f' then call `pydantic.dataclasses.rebuild_dataclass({cls.__name__})`.' 

202 ) 

203 

204 def attempt_rebuild_fn(attr_fn: Callable[[type[PydanticDataclass]], T]) -> Callable[[], T | None]: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

205 def handler() -> T | None: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

206 if rebuild_dataclass(cls, raise_errors=False, _parent_namespace_depth=5) is not False: 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

207 return attr_fn(cls) 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

208 return None 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

209 

210 return handler 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

211 

212 cls.__pydantic_core_schema__ = MockCoreSchema( # pyright: ignore[reportAttributeAccessIssue] 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

213 undefined_type_error_message, 

214 code='class-not-fully-defined', 

215 attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_core_schema__), 

216 ) 

217 cls.__pydantic_validator__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue] 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

218 undefined_type_error_message, 

219 code='class-not-fully-defined', 

220 val_or_ser='validator', 

221 attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_validator__), 

222 ) 

223 cls.__pydantic_serializer__ = MockValSer( # pyright: ignore[reportAttributeAccessIssue] 35 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHI

224 undefined_type_error_message, 

225 code='class-not-fully-defined', 

226 val_or_ser='serializer', 

227 attempt_rebuild=attempt_rebuild_fn(lambda c: c.__pydantic_serializer__), 

228 )