Coverage for pydantic/fields.py: 99.04%

1"""Defining fields on models.""" 

2 

3from __future__ import annotations as _annotations 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

4 

5import dataclasses 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

6import inspect 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

7import sys 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

8import typing 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

9from collections.abc import Mapping 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

10from copy import copy 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

11from dataclasses import Field as DataclassField 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

12from functools import cached_property 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

13from typing import Annotated, Any, Callable, ClassVar, Literal, TypeVar, cast, overload 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

14from warnings import warn 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

15 

16import annotated_types 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

17import typing_extensions 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

18from pydantic_core import PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

19from typing_extensions import Self, TypeAlias, Unpack, deprecated 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

20from typing_inspection import typing_objects 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

21from typing_inspection.introspection import UNKNOWN, AnnotationSource, ForbiddenQualifier, Qualifier, inspect_annotation 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

22 

23from . import types 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

24from ._internal import _decorators, _fields, _generics, _internal_dataclass, _repr, _typing_extra, _utils 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

25from ._internal._namespace_utils import GlobalsNamespace, MappingNamespace 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

26from .aliases import AliasChoices, AliasPath 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

27from .config import JsonDict 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

28from .errors import PydanticForbiddenQualifier, PydanticUserError 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

29from .json_schema import PydanticJsonSchemaWarning 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

30from .warnings import PydanticDeprecatedSince20 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

31 

32if typing.TYPE_CHECKING: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

33 from ._internal._repr import ReprArgs 1 ctx1p

34else: 

35 # See PyCharm issues https://youtrack.jetbrains.com/issue/PY-21915 

36 # and https://youtrack.jetbrains.com/issue/PY-51428 

37 DeprecationWarning = PydanticDeprecatedSince20 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

38 

39__all__ = 'Field', 'PrivateAttr', 'computed_field' 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

40 

41 

42_Unset: Any = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

43 

44if sys.version_info >= (3, 13): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

45 import warnings 10 ctx1abcdefJghi

46 

47 Deprecated: TypeAlias = warnings.deprecated | deprecated 10 ctx1abcdefJghi

48else: 

49 Deprecated: TypeAlias = deprecated 32 ctx1xyzArsjkqpBCDEtulmNOPKLMFGHIvwno

50 

51 

52class _FromFieldInfoInputs(typing_extensions.TypedDict, total=False): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

53 """This class exists solely to add type checking for the `**kwargs` in `FieldInfo.from_field`.""" 

54 

55 # TODO PEP 747: use TypeForm: 

56 annotation: type[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

57 default_factory: Callable[[], Any] | Callable[[dict[str, Any]], Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

58 alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

59 alias_priority: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

60 validation_alias: str | AliasPath | AliasChoices | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

61 serialization_alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

62 title: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

63 field_title_generator: Callable[[str, FieldInfo], str] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

64 description: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

65 examples: list[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

66 exclude: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

67 gt: annotated_types.SupportsGt | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

68 ge: annotated_types.SupportsGe | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

69 lt: annotated_types.SupportsLt | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

70 le: annotated_types.SupportsLe | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

71 multiple_of: float | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

72 strict: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

73 min_length: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

74 max_length: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

75 pattern: str | typing.Pattern[str] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

76 allow_inf_nan: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

77 max_digits: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

78 decimal_places: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

79 union_mode: Literal['smart', 'left_to_right'] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

80 discriminator: str | types.Discriminator | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

81 deprecated: Deprecated | str | bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

82 json_schema_extra: JsonDict | Callable[[JsonDict], None] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

83 frozen: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

84 validate_default: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

85 repr: bool 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

86 init: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

87 init_var: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

88 kw_only: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

89 coerce_numbers_to_str: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

90 fail_fast: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

91 

92 

93class _FieldInfoInputs(_FromFieldInfoInputs, total=False): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

94 """This class exists solely to add type checking for the `**kwargs` in `FieldInfo.__init__`.""" 

95 

96 default: Any 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

97 

98 

99class FieldInfo(_repr.Representation): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

100 """This class holds information about a field. 

101 

102 `FieldInfo` is used for any field definition regardless of whether the [`Field()`][pydantic.fields.Field] 

103 function is explicitly used. 

104 

105 !!! warning 

106 You generally shouldn't be creating `FieldInfo` directly, you'll only need to use it when accessing 

107 [`BaseModel`][pydantic.main.BaseModel] `.model_fields` internals. 

108 

109 Attributes: 

110 annotation: The type annotation of the field. 

111 default: The default value of the field. 

112 default_factory: A callable to generate the default value. The callable can either take 0 arguments 

113 (in which case it is called as is) or a single argument containing the already validated data. 

114 alias: The alias name of the field. 

115 alias_priority: The priority of the field's alias. 

116 validation_alias: The validation alias of the field. 

117 serialization_alias: The serialization alias of the field. 

118 title: The title of the field. 

119 field_title_generator: A callable that takes a field name and returns title for it. 

120 description: The description of the field. 

121 examples: List of examples of the field. 

122 exclude: Whether to exclude the field from the model serialization. 

123 discriminator: Field name or Discriminator for discriminating the type in a tagged union. 

124 deprecated: A deprecation message, an instance of `warnings.deprecated` or the `typing_extensions.deprecated` backport, 

125 or a boolean. If `True`, a default deprecation message will be emitted when accessing the field. 

126 json_schema_extra: A dict or callable to provide extra JSON schema properties. 

127 frozen: Whether the field is frozen. 

128 validate_default: Whether to validate the default value of the field. 

129 repr: Whether to include the field in representation of the model. 

130 init: Whether the field should be included in the constructor of the dataclass. 

131 init_var: Whether the field should _only_ be included in the constructor of the dataclass, and not stored. 

132 kw_only: Whether the field should be a keyword-only argument in the constructor of the dataclass. 

133 metadata: List of metadata constraints. 

134 """ 

135 

136 annotation: type[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

137 default: Any 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

138 default_factory: Callable[[], Any] | Callable[[dict[str, Any]], Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

139 alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

140 alias_priority: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

141 validation_alias: str | AliasPath | AliasChoices | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

142 serialization_alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

143 title: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

144 field_title_generator: Callable[[str, FieldInfo], str] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

145 description: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

146 examples: list[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

147 exclude: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

148 discriminator: str | types.Discriminator | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

149 deprecated: Deprecated | str | bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

150 json_schema_extra: JsonDict | Callable[[JsonDict], None] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

151 frozen: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

152 validate_default: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

153 repr: bool 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

154 init: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

155 init_var: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

156 kw_only: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

157 metadata: list[Any] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

158 

159 __slots__ = ( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

160 'annotation', 

161 'default', 

162 'default_factory', 

163 'alias', 

164 'alias_priority', 

165 'validation_alias', 

166 'serialization_alias', 

167 'title', 

168 'field_title_generator', 

169 'description', 

170 'examples', 

171 'exclude', 

172 'discriminator', 

173 'deprecated', 

174 'json_schema_extra', 

175 'frozen', 

176 'validate_default', 

177 'repr', 

178 'init', 

179 'init_var', 

180 'kw_only', 

181 'metadata', 

182 '_attributes_set', 

183 '_qualifiers', 

184 '_complete', 

185 '_original_assignment', 

186 '_original_annotation', 

187 ) 

188 

189 # used to convert kwargs to metadata/constraints, 

190 # None has a special meaning - these items are collected into a `PydanticGeneralMetadata` 

191 metadata_lookup: ClassVar[dict[str, typing.Callable[[Any], Any] | None]] = { 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

192 'strict': types.Strict, 

193 'gt': annotated_types.Gt, 

194 'ge': annotated_types.Ge, 

195 'lt': annotated_types.Lt, 

196 'le': annotated_types.Le, 

197 'multiple_of': annotated_types.MultipleOf, 

198 'min_length': annotated_types.MinLen, 

199 'max_length': annotated_types.MaxLen, 

200 'pattern': None, 

201 'allow_inf_nan': None, 

202 'max_digits': None, 

203 'decimal_places': None, 

204 'union_mode': None, 

205 'coerce_numbers_to_str': None, 

206 'fail_fast': types.FailFast, 

207 } 

208 

209 def __init__(self, **kwargs: Unpack[_FieldInfoInputs]) -> None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

210 """This class should generally not be initialized directly; instead, use the `pydantic.fields.Field` function 

211 or one of the constructor classmethods. 

212 

213 See the signature of `pydantic.fields.Field` for more details about the expected arguments. 

214 """ 

215 self._attributes_set = {k: v for k, v in kwargs.items() if v is not _Unset} 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

216 kwargs = {k: _DefaultValues.get(k) if v is _Unset else v for k, v in kwargs.items()} # type: ignore 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

217 self.annotation = kwargs.get('annotation') 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

218 

219 default = kwargs.pop('default', PydanticUndefined) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

220 if default is Ellipsis: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

221 self.default = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

222 self._attributes_set.pop('default', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

223 else: 

224 self.default = default 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

225 

226 self.default_factory = kwargs.pop('default_factory', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

227 

228 if self.default is not PydanticUndefined and self.default_factory is not None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

229 raise TypeError('cannot specify both default and default_factory') 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

230 

231 self.alias = kwargs.pop('alias', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

232 self.validation_alias = kwargs.pop('validation_alias', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

233 self.serialization_alias = kwargs.pop('serialization_alias', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

234 alias_is_set = any(alias is not None for alias in (self.alias, self.validation_alias, self.serialization_alias)) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

235 self.alias_priority = kwargs.pop('alias_priority', None) or 2 if alias_is_set else None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

236 self.title = kwargs.pop('title', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

237 self.field_title_generator = kwargs.pop('field_title_generator', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

238 self.description = kwargs.pop('description', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

239 self.examples = kwargs.pop('examples', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

240 self.exclude = kwargs.pop('exclude', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

241 self.discriminator = kwargs.pop('discriminator', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

242 # For compatibility with FastAPI<=0.110.0, we preserve the existing value if it is not overridden 

243 self.deprecated = kwargs.pop('deprecated', getattr(self, 'deprecated', None)) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

244 self.repr = kwargs.pop('repr', True) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

245 self.json_schema_extra = kwargs.pop('json_schema_extra', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

246 self.validate_default = kwargs.pop('validate_default', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

247 self.frozen = kwargs.pop('frozen', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

248 # currently only used on dataclasses 

249 self.init = kwargs.pop('init', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

250 self.init_var = kwargs.pop('init_var', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

251 self.kw_only = kwargs.pop('kw_only', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

252 

253 self.metadata = self._collect_metadata(kwargs) # type: ignore 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

254 

255 # Private attributes: 

256 self._qualifiers: set[Qualifier] = set() 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

257 # Used to rebuild FieldInfo instances: 

258 self._complete = True 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

259 self._original_annotation: Any = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

260 self._original_assignment: Any = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

261 

262 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

263 def from_field(default: Any = PydanticUndefined, **kwargs: Unpack[_FromFieldInfoInputs]) -> FieldInfo: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

264 """Create a new `FieldInfo` object with the `Field` function. 

265 

266 Args: 

267 default: The default value for the field. Defaults to Undefined. 

268 **kwargs: Additional arguments dictionary. 

269 

270 Raises: 

271 TypeError: If 'annotation' is passed as a keyword argument. 

272 

273 Returns: 

274 A new FieldInfo object with the given parameters. 

275 

276 Example: 

277 This is how you can create a field with default value like this: 

278 

279 ```python 

280 import pydantic 

281 

282 class MyModel(pydantic.BaseModel): 

283 foo: int = pydantic.Field(4) 

284 ``` 

285 """ 

286 if 'annotation' in kwargs: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

287 raise TypeError('"annotation" is not permitted as a Field keyword argument') 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

288 return FieldInfo(default=default, **kwargs) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

289 

290 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

291 def from_annotation(annotation: type[Any], *, _source: AnnotationSource = AnnotationSource.ANY) -> FieldInfo: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

292 """Creates a `FieldInfo` instance from a bare annotation. 

293 

294 This function is used internally to create a `FieldInfo` from a bare annotation like this: 

295 

296 ```python 

297 import pydantic 

298 

299 class MyModel(pydantic.BaseModel): 

300 foo: int # <-- like this 

301 ``` 

302 

303 We also account for the case where the annotation can be an instance of `Annotated` and where 

304 one of the (not first) arguments in `Annotated` is an instance of `FieldInfo`, e.g.: 

305 

306 ```python 

307 from typing import Annotated 

308 

309 import annotated_types 

310 

311 import pydantic 

312 

313 class MyModel(pydantic.BaseModel): 

314 foo: Annotated[int, annotated_types.Gt(42)] 

315 bar: Annotated[int, pydantic.Field(gt=42)] 

316 ``` 

317 

318 Args: 

319 annotation: An annotation object. 

320 

321 Returns: 

322 An instance of the field metadata. 

323 """ 

324 try: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

325 inspected_ann = inspect_annotation( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

326 annotation, 

327 annotation_source=_source, 

328 unpack_type_aliases='skip', 

329 ) 

330 except ForbiddenQualifier as e: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

331 raise PydanticForbiddenQualifier(e.qualifier, annotation) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

332 

333 # TODO check for classvar and error? 

334 

335 # No assigned value, this happens when using a bare `Final` qualifier (also for other 

336 # qualifiers, but they shouldn't appear here). In this case we infer the type as `Any` 

337 # because we don't have any assigned value. 

338 type_expr: Any = Any if inspected_ann.type is UNKNOWN else inspected_ann.type 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

339 final = 'final' in inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

340 metadata = inspected_ann.metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

341 

342 if not metadata: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

343 # No metadata, e.g. `field: int`, or `field: Final[str]`: 

344 field_info = FieldInfo(annotation=type_expr, frozen=final or None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

345 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

346 return field_info 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

347 

348 # With metadata, e.g. `field: Annotated[int, Field(...), Gt(1)]`: 

349 field_info_annotations = [a for a in metadata if isinstance(a, FieldInfo)] 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

350 field_info = FieldInfo.merge_field_infos(*field_info_annotations, annotation=type_expr) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

351 

352 new_field_info = field_info._copy() 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

353 new_field_info.annotation = type_expr 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

354 new_field_info.frozen = final or field_info.frozen 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

355 field_metadata: list[Any] = [] 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

356 for a in metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

357 if typing_objects.is_deprecated(a): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

358 new_field_info.deprecated = a.message 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

359 elif not isinstance(a, FieldInfo): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

360 field_metadata.append(a) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

361 else: 

362 field_metadata.extend(a.metadata) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

363 new_field_info.metadata = field_metadata 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

364 new_field_info._qualifiers = inspected_ann.qualifiers 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

365 return new_field_info 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

366 

367 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

368 def from_annotated_attribute( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

369 annotation: type[Any], default: Any, *, _source: AnnotationSource = AnnotationSource.ANY 

370 ) -> FieldInfo: 

371 """Create `FieldInfo` from an annotation with a default value. 

372 

373 This is used in cases like the following: 

374 

375 ```python 

376 from typing import Annotated 

377 

378 import annotated_types 

379 

380 import pydantic 

381 

382 class MyModel(pydantic.BaseModel): 

383 foo: int = 4 # <-- like this 

384 bar: Annotated[int, annotated_types.Gt(4)] = 4 # <-- or this 

385 spam: Annotated[int, pydantic.Field(gt=4)] = 4 # <-- or this 

386 ``` 

387 

388 Args: 

389 annotation: The type annotation of the field. 

390 default: The default value of the field. 

391 

392 Returns: 

393 A field object with the passed values. 

394 """ 

395 if annotation is default: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

396 raise PydanticUserError( 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

397 'Error when building FieldInfo from annotated attribute. ' 

398 "Make sure you don't have any field name clashing with a type annotation.", 

399 code='unevaluable-type-annotation', 

400 ) 

401 

402 try: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

403 inspected_ann = inspect_annotation( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

404 annotation, 

405 annotation_source=_source, 

406 unpack_type_aliases='skip', 

407 ) 

408 except ForbiddenQualifier as e: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

409 raise PydanticForbiddenQualifier(e.qualifier, annotation) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

410 

411 # TODO check for classvar and error? 

412 

413 # TODO infer from the default, this can be done in v3 once we treat final fields with 

414 # a default as proper fields and not class variables: 

415 type_expr: Any = Any if inspected_ann.type is UNKNOWN else inspected_ann.type 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

416 final = 'final' in inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

417 metadata = inspected_ann.metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

418 

419 if isinstance(default, FieldInfo): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

420 # e.g. `field: int = Field(...)` 

421 default.annotation = type_expr 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

422 default.metadata += metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

423 merged_default = FieldInfo.merge_field_infos( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

424 *[x for x in metadata if isinstance(x, FieldInfo)], 

425 default, 

426 annotation=default.annotation, 

427 ) 

428 merged_default.frozen = final or merged_default.frozen 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

429 merged_default._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

430 return merged_default 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

431 

432 if isinstance(default, dataclasses.Field): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

433 # `collect_dataclass_fields()` passes the dataclass Field as a default. 

434 pydantic_field = FieldInfo._from_dataclass_field(default) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

435 pydantic_field.annotation = type_expr 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

436 pydantic_field.metadata += metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

437 pydantic_field = FieldInfo.merge_field_infos( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

438 *[x for x in metadata if isinstance(x, FieldInfo)], 

439 pydantic_field, 

440 annotation=pydantic_field.annotation, 

441 ) 

442 pydantic_field.frozen = final or pydantic_field.frozen 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

443 pydantic_field.init_var = 'init_var' in inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

444 pydantic_field.init = getattr(default, 'init', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

445 pydantic_field.kw_only = getattr(default, 'kw_only', None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

446 pydantic_field._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

447 return pydantic_field 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

448 

449 if not metadata: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

450 # No metadata, e.g. `field: int = ...`, or `field: Final[str] = ...`: 

451 field_info = FieldInfo(annotation=type_expr, default=default, frozen=final or None) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

452 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

453 return field_info 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

454 

455 # With metadata, e.g. `field: Annotated[int, Field(...), Gt(1)] = ...`: 

456 field_infos = [a for a in metadata if isinstance(a, FieldInfo)] 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

457 field_info = FieldInfo.merge_field_infos(*field_infos, annotation=type_expr, default=default) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

458 field_metadata: list[Any] = [] 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

459 for a in metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

460 if typing_objects.is_deprecated(a): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

461 field_info.deprecated = a.message 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

462 elif not isinstance(a, FieldInfo): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

463 field_metadata.append(a) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

464 else: 

465 field_metadata.extend(a.metadata) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

466 field_info.metadata = field_metadata 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

467 field_info._qualifiers = inspected_ann.qualifiers 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

468 return field_info 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

469 

470 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

471 def merge_field_infos(*field_infos: FieldInfo, **overrides: Any) -> FieldInfo: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

472 """Merge `FieldInfo` instances keeping only explicitly set attributes. 

473 

474 Later `FieldInfo` instances override earlier ones. 

475 

476 Returns: 

477 FieldInfo: A merged FieldInfo instance. 

478 """ 

479 if len(field_infos) == 1: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

480 # No merging necessary, but we still need to make a copy and apply the overrides 

481 field_info = field_infos[0]._copy() 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

482 field_info._attributes_set.update(overrides) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

483 

484 default_override = overrides.pop('default', PydanticUndefined) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

485 if default_override is Ellipsis: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

486 default_override = PydanticUndefined 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

487 if default_override is not PydanticUndefined: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

488 field_info.default = default_override 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

489 

490 for k, v in overrides.items(): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

491 setattr(field_info, k, v) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

492 return field_info # type: ignore 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

493 

494 merged_field_info_kwargs: dict[str, Any] = {} 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

495 metadata = {} 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

496 for field_info in field_infos: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

497 attributes_set = field_info._attributes_set.copy() 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

498 

499 try: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

500 json_schema_extra = attributes_set.pop('json_schema_extra') 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

501 existing_json_schema_extra = merged_field_info_kwargs.get('json_schema_extra') 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

502 

503 if existing_json_schema_extra is None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

504 merged_field_info_kwargs['json_schema_extra'] = json_schema_extra 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

505 if isinstance(existing_json_schema_extra, dict): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

506 if isinstance(json_schema_extra, dict): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

507 merged_field_info_kwargs['json_schema_extra'] = { 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

508 **existing_json_schema_extra, 

509 **json_schema_extra, 

510 } 

511 if callable(json_schema_extra): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

512 warn( 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

513 'Composing `dict` and `callable` type `json_schema_extra` is not supported.' 

514 'The `callable` type is being ignored.' 

515 "If you'd like support for this behavior, please open an issue on pydantic.", 

516 PydanticJsonSchemaWarning, 

517 ) 

518 elif callable(json_schema_extra): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

519 # if ever there's a case of a callable, we'll just keep the last json schema extra spec 

520 merged_field_info_kwargs['json_schema_extra'] = json_schema_extra 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

521 except KeyError: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

522 pass 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

523 

524 # later FieldInfo instances override everything except json_schema_extra from earlier FieldInfo instances 

525 merged_field_info_kwargs.update(attributes_set) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

526 

527 for x in field_info.metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

528 if not isinstance(x, FieldInfo): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

529 metadata[type(x)] = x 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

530 

531 merged_field_info_kwargs.update(overrides) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

532 field_info = FieldInfo(**merged_field_info_kwargs) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

533 field_info.metadata = list(metadata.values()) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

534 return field_info 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

535 

536 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

537 def _from_dataclass_field(dc_field: DataclassField[Any]) -> FieldInfo: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

538 """Return a new `FieldInfo` instance from a `dataclasses.Field` instance. 

539 

540 Args: 

541 dc_field: The `dataclasses.Field` instance to convert. 

542 

543 Returns: 

544 The corresponding `FieldInfo` instance. 

545 

546 Raises: 

547 TypeError: If any of the `FieldInfo` kwargs does not match the `dataclass.Field` kwargs. 

548 """ 

549 default = dc_field.default 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

550 if default is dataclasses.MISSING: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

551 default = _Unset 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

552 

553 if dc_field.default_factory is dataclasses.MISSING: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

554 default_factory = _Unset 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

555 else: 

556 default_factory = dc_field.default_factory 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

557 

558 # use the `Field` function so in correct kwargs raise the correct `TypeError` 

559 dc_field_metadata = {k: v for k, v in dc_field.metadata.items() if k in _FIELD_ARG_NAMES} 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

560 return Field(default=default, default_factory=default_factory, repr=dc_field.repr, **dc_field_metadata) # pyright: ignore[reportCallIssue] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

561 

562 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

563 def _collect_metadata(kwargs: dict[str, Any]) -> list[Any]: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

564 """Collect annotations from kwargs. 

565 

566 Args: 

567 kwargs: Keyword arguments passed to the function. 

568 

569 Returns: 

570 A list of metadata objects - a combination of `annotated_types.BaseMetadata` and 

571 `PydanticMetadata`. 

572 """ 

573 metadata: list[Any] = [] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

574 general_metadata = {} 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

575 for key, value in list(kwargs.items()): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

576 try: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

577 marker = FieldInfo.metadata_lookup[key] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

578 except KeyError: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

579 continue 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

580 

581 del kwargs[key] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

582 if value is not None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

583 if marker is None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

584 general_metadata[key] = value 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

585 else: 

586 metadata.append(marker(value)) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

587 if general_metadata: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

588 metadata.append(_fields.pydantic_general_metadata(**general_metadata)) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

589 return metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

590 

591 def _copy(self) -> Self: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

592 copied = copy(self) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

593 for attr_name in ('metadata', '_attributes_set', '_qualifiers'): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

594 # Apply "deep-copy" behavior on collections attributes: 

595 value = getattr(copied, attr_name).copy() 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

596 setattr(copied, attr_name, value) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

597 

598 return copied 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

599 

600 @property 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

601 def deprecation_message(self) -> str | None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

602 """The deprecation message to be emitted, or `None` if not set.""" 

603 if self.deprecated is None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

604 return None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

605 if isinstance(self.deprecated, bool): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

606 return 'deprecated' if self.deprecated else None 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

607 return self.deprecated if isinstance(self.deprecated, str) else self.deprecated.message 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

608 

609 @property 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

610 def default_factory_takes_validated_data(self) -> bool | None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

611 """Whether the provided default factory callable has a validated data parameter. 

612 

613 Returns `None` if no default factory is set. 

614 """ 

615 if self.default_factory is not None: 615 ↛ exitline 615 didn't return from function 'default_factory_takes_validated_data' because the condition on line 615 was always true35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

616 return _fields.takes_validated_data_argument(self.default_factory) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

617 

618 @overload 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

619 def get_default( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

620 self, *, call_default_factory: Literal[True], validated_data: dict[str, Any] | None = None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

621 ) -> Any: ... 21 ctx1jkabcqplmdefKLMJnoghi

622 

623 @overload 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

624 def get_default(self, *, call_default_factory: Literal[False] = ...) -> Any: ... 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

625 

626 def get_default(self, *, call_default_factory: bool = False, validated_data: dict[str, Any] | None = None) -> Any: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

627 """Get the default value. 

628 

629 We expose an option for whether to call the default_factory (if present), as calling it may 

630 result in side effects that we want to avoid. However, there are times when it really should 

631 be called (namely, when instantiating a model via `model_construct`). 

632 

633 Args: 

634 call_default_factory: Whether to call the default factory or not. 

635 validated_data: The already validated data to be passed to the default factory. 

636 

637 Returns: 

638 The default value, calling the default factory if requested or `None` if not set. 

639 """ 

640 if self.default_factory is None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

641 return _utils.smart_deepcopy(self.default) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

642 elif call_default_factory: 642 ↛ 654line 642 didn't jump to line 654 because the condition on line 642 was always true35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

643 if self.default_factory_takes_validated_data: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

644 fac = cast('Callable[[dict[str, Any]], Any]', self.default_factory) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

645 if validated_data is None: 645 ↛ 646line 645 didn't jump to line 646 because the condition on line 645 was never true35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

646 raise ValueError( 

647 "The default factory requires the 'validated_data' argument, which was not provided when calling 'get_default'." 

648 ) 

649 return fac(validated_data) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

650 else: 

651 fac = cast('Callable[[], Any]', self.default_factory) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

652 return fac() 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

653 else: 

654 return None 

655 

656 def is_required(self) -> bool: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

657 """Check if the field is required (i.e., does not have a default value or factory). 

658 

659 Returns: 

660 `True` if the field is required, `False` otherwise. 

661 """ 

662 return self.default is PydanticUndefined and self.default_factory is None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

663 

664 def rebuild_annotation(self) -> Any: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

665 """Attempts to rebuild the original annotation for use in function signatures. 

666 

667 If metadata is present, it adds it to the original annotation using 

668 `Annotated`. Otherwise, it returns the original annotation as-is. 

669 

670 Note that because the metadata has been flattened, the original annotation 

671 may not be reconstructed exactly as originally provided, e.g. if the original 

672 type had unrecognized annotations, or was annotated with a call to `pydantic.Field`. 

673 

674 Returns: 

675 The rebuilt annotation. 

676 """ 

677 if not self.metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

678 return self.annotation 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

679 else: 

680 # Annotated arguments must be a tuple 

681 return Annotated[(self.annotation, *self.metadata)] # type: ignore 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

682 

683 def apply_typevars_map( 40 ctx1xyzArsjkabcBCDEtulmdefNOPKLMJFGHIvwnoghi

684 self, 

685 typevars_map: Mapping[TypeVar, Any] | None, 

686 globalns: GlobalsNamespace | None = None, 

687 localns: MappingNamespace | None = None, 

688 ) -> None: 

689 """Apply a `typevars_map` to the annotation. 

690 

691 This method is used when analyzing parametrized generic types to replace typevars with their concrete types. 

692 

693 This method applies the `typevars_map` to the annotation in place. 

694 

695 Args: 

696 typevars_map: A dictionary mapping type variables to their concrete types. 

697 globalns: The globals namespace to use during type annotation evaluation. 

698 localns: The locals namespace to use during type annotation evaluation. 

699 

700 See Also: 

701 pydantic._internal._generics.replace_types is used for replacing the typevars with 

702 their concrete types. 

703 """ 

704 annotation = _generics.replace_types(self.annotation, typevars_map) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

705 annotation, evaluated = _typing_extra.try_eval_type(annotation, globalns, localns) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

706 self.annotation = annotation 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

707 if not evaluated: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

708 self._complete = False 21 ctx1rsjkabctulmdefvwnoghi

709 self._original_annotation = self.annotation 21 ctx1rsjkabctulmdefvwnoghi

710 

711 def __repr_args__(self) -> ReprArgs: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

712 yield 'annotation', _repr.PlainRepr(_repr.display_as_type(self.annotation)) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

713 yield 'required', self.is_required() 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

714 

715 for s in self.__slots__: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

716 # TODO: properly make use of the protocol (https://rich.readthedocs.io/en/stable/pretty.html#rich-repr-protocol) 

717 # By yielding a three-tuple: 

718 if s in ( 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

719 'annotation', 

720 '_attributes_set', 

721 '_qualifiers', 

722 '_complete', 

723 '_original_assignment', 

724 '_original_annotation', 

725 ): 

726 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

727 elif s == 'metadata' and not self.metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

728 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

729 elif s == 'repr' and self.repr is True: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

730 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

731 if s == 'frozen' and self.frozen is False: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

732 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

733 if s == 'validation_alias' and self.validation_alias == self.alias: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

734 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

735 if s == 'serialization_alias' and self.serialization_alias == self.alias: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

736 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

737 if s == 'default' and self.default is not PydanticUndefined: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

738 yield 'default', self.default 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

739 elif s == 'default_factory' and self.default_factory is not None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

740 yield 'default_factory', _repr.PlainRepr(_repr.display_as_type(self.default_factory)) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

741 else: 

742 value = getattr(self, s) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

743 if value is not None and value is not PydanticUndefined: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

744 yield s, value 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

745 

746 

747class _EmptyKwargs(typing_extensions.TypedDict): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi