Coverage for pydantic/fields.py: 91.28%

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

2 

3from __future__ import annotations as _annotations 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

4 

5import dataclasses 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

6import inspect 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

7import sys 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

8import typing 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

9from collections.abc import Callable, Mapping 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

10from copy import copy 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

11from dataclasses import Field as DataclassField 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

12from functools import cached_property 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

13from typing import Annotated, Any, ClassVar, Literal, TypeVar, cast, final, overload 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

14from warnings import warn 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

15 

16import annotated_types 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

17import typing_extensions 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

18from pydantic_core import MISSING, PydanticUndefined 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

20from typing_inspection import typing_objects 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

22 

23from . import types 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

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

26from .aliases import AliasChoices, AliasGenerator, AliasPath 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

27from .config import JsonDict 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

28from .errors import PydanticForbiddenQualifier, PydanticUserError 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

29from .json_schema import PydanticJsonSchemaWarning 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

30from .warnings import PydanticDeprecatedSince20 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

31 

32if typing.TYPE_CHECKING: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

33 from ._internal._config import ConfigWrapper 

34 from ._internal._repr import ReprArgs 1 ctx1i

35else: 

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

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

38 DeprecationWarning = PydanticDeprecatedSince20 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

39 

40__all__ = 'Field', 'PrivateAttr', 'computed_field' 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

41 

42 

43_Unset: Any = PydanticUndefined 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

44 

45if sys.version_info >= (3, 13): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

46 import warnings 16 ctx1abopqcdrstPefuvw

47 

48 Deprecated: TypeAlias = warnings.deprecated | deprecated 16 ctx1abopqcdrstPefuvw

49else: 

50 Deprecated: TypeAlias = deprecated 26 ctx1JKxyzAghniLMBCDEjkNOFGHIlm

51 

52 

53class _FromFieldInfoInputs(typing_extensions.TypedDict, total=False): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

55 

56 # TODO PEP 747: use TypeForm: 

57 annotation: type[Any] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

58 default_factory: Callable[[], Any] | Callable[[dict[str, Any]], Any] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

59 alias: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

60 alias_priority: int | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

61 validation_alias: str | AliasPath | AliasChoices | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

62 serialization_alias: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

63 title: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

64 field_title_generator: Callable[[str, FieldInfo], str] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

65 description: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

66 examples: list[Any] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

67 exclude: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

68 gt: annotated_types.SupportsGt | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

69 ge: annotated_types.SupportsGe | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

70 lt: annotated_types.SupportsLt | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

71 le: annotated_types.SupportsLe | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

72 multiple_of: float | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

73 strict: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

74 min_length: int | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

75 max_length: int | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

76 pattern: str | typing.Pattern[str] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

77 allow_inf_nan: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

78 max_digits: int | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

79 decimal_places: int | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

80 union_mode: Literal['smart', 'left_to_right'] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

81 discriminator: str | types.Discriminator | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

82 deprecated: Deprecated | str | bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

83 json_schema_extra: JsonDict | Callable[[JsonDict], None] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

84 frozen: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

85 validate_default: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

86 repr: bool 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

87 init: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

88 init_var: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

89 kw_only: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

90 coerce_numbers_to_str: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

91 fail_fast: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

92 

93 

94class _FieldInfoInputs(_FromFieldInfoInputs, total=False): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

96 

97 default: Any 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

98 

99 

100@final 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

101class FieldInfo(_repr.Representation): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

103 

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

105 function is explicitly used. 

106 

107 !!! warning 

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

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

110 

111 Attributes: 

112 annotation: The type annotation of the field. 

113 default: The default value of the field. 

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

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

116 alias: The alias name of the field. 

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

118 validation_alias: The validation alias of the field. 

119 serialization_alias: The serialization alias of the field. 

120 title: The title of the field. 

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

122 description: The description of the field. 

123 examples: List of examples of the field. 

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

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

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

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

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

129 frozen: Whether the field is frozen. 

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

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

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

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

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

135 metadata: List of metadata constraints. 

136 """ 

137 

138 annotation: type[Any] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

139 default: Any 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

140 default_factory: Callable[[], Any] | Callable[[dict[str, Any]], Any] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

141 alias: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

142 alias_priority: int | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

143 validation_alias: str | AliasPath | AliasChoices | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

144 serialization_alias: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

145 title: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

146 field_title_generator: Callable[[str, FieldInfo], str] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

147 description: str | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

148 examples: list[Any] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

149 exclude: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

150 discriminator: str | types.Discriminator | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

151 deprecated: Deprecated | str | bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

152 json_schema_extra: JsonDict | Callable[[JsonDict], None] | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

153 frozen: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

154 validate_default: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

155 repr: bool 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

156 init: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

157 init_var: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

158 kw_only: bool | None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

159 metadata: list[Any] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

160 

161 __slots__ = ( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

162 'annotation', 

163 'default', 

164 'default_factory', 

165 'alias', 

166 'alias_priority', 

167 'validation_alias', 

168 'serialization_alias', 

169 'title', 

170 'field_title_generator', 

171 'description', 

172 'examples', 

173 'exclude', 

174 'discriminator', 

175 'deprecated', 

176 'json_schema_extra', 

177 'frozen', 

178 'validate_default', 

179 'repr', 

180 'init', 

181 'init_var', 

182 'kw_only', 

183 'metadata', 

184 '_attributes_set', 

185 '_qualifiers', 

186 '_complete', 

187 '_original_assignment', 

188 '_original_annotation', 

189 ) 

190 

191 # used to convert kwargs to metadata/constraints, 

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

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

194 'strict': types.Strict, 

195 'gt': annotated_types.Gt, 

196 'ge': annotated_types.Ge, 

197 'lt': annotated_types.Lt, 

198 'le': annotated_types.Le, 

199 'multiple_of': annotated_types.MultipleOf, 

200 'min_length': annotated_types.MinLen, 

201 'max_length': annotated_types.MaxLen, 

202 'pattern': None, 

203 'allow_inf_nan': None, 

204 'max_digits': None, 

205 'decimal_places': None, 

206 'union_mode': None, 

207 'coerce_numbers_to_str': None, 

208 'fail_fast': types.FailFast, 

209 } 

210 

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

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

213 or one of the constructor classmethods. 

214 

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

216 """ 

217 self._attributes_set = {k: v for k, v in kwargs.items() if v is not _Unset and k not in self.metadata_lookup} 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

219 self.annotation = kwargs.get('annotation') 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

220 

221 default = kwargs.pop('default', PydanticUndefined) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

222 if default is Ellipsis: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

223 self.default = PydanticUndefined 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

224 self._attributes_set.pop('default', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

225 else: 

226 self.default = default 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

227 

228 self.default_factory = kwargs.pop('default_factory', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

229 

230 if self.default is not PydanticUndefined and self.default_factory is not None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

231 raise TypeError('cannot specify both default and default_factory') 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

232 

233 self.alias = kwargs.pop('alias', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

234 self.validation_alias = kwargs.pop('validation_alias', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

235 self.serialization_alias = kwargs.pop('serialization_alias', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

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

238 self.title = kwargs.pop('title', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

239 self.field_title_generator = kwargs.pop('field_title_generator', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

240 self.description = kwargs.pop('description', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

241 self.examples = kwargs.pop('examples', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

242 self.exclude = kwargs.pop('exclude', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

243 self.discriminator = kwargs.pop('discriminator', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

245 self.deprecated = kwargs.pop('deprecated', getattr(self, 'deprecated', None)) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

246 self.repr = kwargs.pop('repr', True) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

247 self.json_schema_extra = kwargs.pop('json_schema_extra', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

248 self.validate_default = kwargs.pop('validate_default', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

249 self.frozen = kwargs.pop('frozen', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

250 # currently only used on dataclasses 

251 self.init = kwargs.pop('init', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

252 self.init_var = kwargs.pop('init_var', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

253 self.kw_only = kwargs.pop('kw_only', None) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

254 

255 self.metadata = self._collect_metadata(kwargs) # type: ignore 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

256 

257 # Private attributes: 

258 self._qualifiers: set[Qualifier] = set() 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

259 # Used to rebuild FieldInfo instances: 

260 self._complete = True 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

261 self._original_annotation: Any = PydanticUndefined 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

262 self._original_assignment: Any = PydanticUndefined 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

263 

264 @staticmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

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

267 

268 Args: 

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

270 **kwargs: Additional arguments dictionary. 

271 

272 Raises: 

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

274 

275 Returns: 

276 A new FieldInfo object with the given parameters. 

277 

278 Example: 

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

280 

281 ```python 

282 import pydantic 

283 

284 class MyModel(pydantic.BaseModel): 

285 foo: int = pydantic.Field(4) 

286 ``` 

287 """ 

288 if 'annotation' in kwargs: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

289 raise TypeError('"annotation" is not permitted as a Field keyword argument') 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

290 return FieldInfo(default=default, **kwargs) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

291 

292 @staticmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

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

295 

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

297 

298 ```python 

299 import pydantic 

300 

301 class MyModel(pydantic.BaseModel): 

302 foo: int # <-- like this 

303 ``` 

304 

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

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

307 

308 ```python 

309 from typing import Annotated 

310 

311 import annotated_types 

312 

313 import pydantic 

314 

315 class MyModel(pydantic.BaseModel): 

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

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

318 ``` 

319 

320 Args: 

321 annotation: An annotation object. 

322 

323 Returns: 

324 An instance of the field metadata. 

325 """ 

326 try: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

327 inspected_ann = inspect_annotation( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

328 annotation, 

329 annotation_source=_source, 

330 unpack_type_aliases='skip', 

331 ) 

332 except ForbiddenQualifier as e: 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

333 raise PydanticForbiddenQualifier(e.qualifier, annotation) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

334 

335 # TODO check for classvar and error? 

336 

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

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

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

340 type_expr: Any = Any if inspected_ann.type is UNKNOWN else inspected_ann.type 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

341 final = 'final' in inspected_ann.qualifiers 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

342 metadata = inspected_ann.metadata 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

343 

344 attr_overrides = {'annotation': type_expr} 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

345 if final: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

346 attr_overrides['frozen'] = True 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

347 field_info = FieldInfo._construct(metadata, **attr_overrides) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

348 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

349 return field_info 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

350 

351 @staticmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

352 def from_annotated_attribute( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

354 ) -> FieldInfo: 

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

356 

357 This is used in cases like the following: 

358 

359 ```python 

360 from typing import Annotated 

361 

362 import annotated_types 

363 

364 import pydantic 

365 

366 class MyModel(pydantic.BaseModel): 

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

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

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

370 ``` 

371 

372 Args: 

373 annotation: The type annotation of the field. 

374 default: The default value of the field. 

375 

376 Returns: 

377 A field object with the passed values. 

378 """ 

379 if annotation is not MISSING and annotation is default: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

380 raise PydanticUserError( 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

381 'Error when building FieldInfo from annotated attribute. ' 

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

383 code='unevaluable-type-annotation', 

384 ) 

385 

386 try: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

387 inspected_ann = inspect_annotation( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

388 annotation, 

389 annotation_source=_source, 

390 unpack_type_aliases='skip', 

391 ) 

392 except ForbiddenQualifier as e: 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

393 raise PydanticForbiddenQualifier(e.qualifier, annotation) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

394 

395 # TODO check for classvar and error? 

396 

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

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

399 type_expr: Any = Any if inspected_ann.type is UNKNOWN else inspected_ann.type 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

400 final = 'final' in inspected_ann.qualifiers 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

401 metadata = inspected_ann.metadata 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

402 

403 # HACK 1: the order in which the metadata is merged is inconsistent; we need to prepend 

404 # metadata from the assignment at the beginning of the metadata. Changing this is only 

405 # possible in v3 (at least). See https://github.com/pydantic/pydantic/issues/10507 

406 prepend_metadata: list[Any] | None = None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

407 attr_overrides = {'annotation': type_expr} 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

408 if final: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

409 attr_overrides['frozen'] = True 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

410 

411 # HACK 2: FastAPI is subclassing `FieldInfo` and historically expected the actual 

412 # instance's type to be preserved when constructing new models with its subclasses as assignments. 

413 # This code is never reached by Pydantic itself, and in an ideal world this shouldn't be necessary. 

414 if not metadata and isinstance(default, FieldInfo) and type(default) is not FieldInfo: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

415 field_info = default._copy() 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

416 field_info._attributes_set.update(attr_overrides) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

417 for k, v in attr_overrides.items(): 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

418 setattr(field_info, k, v) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

419 return field_info 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

420 

421 if isinstance(default, FieldInfo): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

422 default_copy = default._copy() # Copy unnecessary when we remove HACK 1. 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

423 prepend_metadata = default_copy.metadata 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

424 default_copy.metadata = [] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

425 metadata = metadata + [default_copy] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

426 elif isinstance(default, dataclasses.Field): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

427 from_field = FieldInfo._from_dataclass_field(default) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

428 prepend_metadata = from_field.metadata # Unnecessary when we remove HACK 1. 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

429 from_field.metadata = [] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

430 metadata = metadata + [from_field] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

431 if 'init_var' in inspected_ann.qualifiers: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

432 attr_overrides['init_var'] = True 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

433 if (init := getattr(default, 'init', None)) is not None: 433 ↛ 435line 433 didn't jump to line 435 because the condition on line 433 was always true42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

434 attr_overrides['init'] = init 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

435 if (kw_only := getattr(default, 'kw_only', None)) is not None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

436 attr_overrides['kw_only'] = kw_only 35 ctx1xyzAghabopqiBCDEjkcdrstPFGHIlmefuvw

437 else: 

438 # `default` is the actual default value 

439 attr_overrides['default'] = default 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

440 

441 field_info = FieldInfo._construct( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

442 prepend_metadata + metadata if prepend_metadata is not None else metadata, **attr_overrides 

443 ) 

444 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

445 return field_info 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

446 

447 @classmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

448 def _construct(cls, metadata: list[Any], **attr_overrides: Any) -> Self: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

449 """Construct the final `FieldInfo` instance, by merging the possibly existing `FieldInfo` instances from the metadata. 

450 

451 With the following example: 

452 

453 ```python {test="skip" lint="skip"} 

454 class Model(BaseModel): 

455 f: Annotated[int, Gt(1), Field(description='desc', lt=2)] 

456 ``` 

457 

458 `metadata` refers to the metadata elements of the `Annotated` form. This metadata is iterated over from left to right: 

459 

460 - If the element is a `Field()` function (which is itself a `FieldInfo` instance), the field attributes (such as 

461 `description`) are saved to be set on the final `FieldInfo` instance. 

462 On the other hand, some kwargs (such as `lt`) are stored as `metadata` (see `FieldInfo.__init__()`, calling 

463 `FieldInfo._collect_metadata()`). In this case, the final metadata list is extended with the one from this instance. 

464 - Else, the element is considered as a single metadata object, and is appended to the final metadata list. 

465 

466 Args: 

467 metadata: The list of metadata elements to merge together. If the `FieldInfo` instance to be constructed is for 

468 a field with an assigned `Field()`, this `Field()` assignment should be added as the last element of the 

469 provided metadata. 

470 **attr_overrides: Extra attributes that should be set on the final merged `FieldInfo` instance. 

471 

472 Returns: 

473 The final merged `FieldInfo` instance. 

474 """ 

475 merged_metadata: list[Any] = [] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

476 merged_kwargs: dict[str, Any] = {} 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

477 

478 for meta in metadata: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

479 if isinstance(meta, FieldInfo): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

480 merged_metadata.extend(meta.metadata) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

481 

482 new_js_extra: JsonDict | None = None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

483 current_js_extra = meta.json_schema_extra 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

484 if current_js_extra is not None and 'json_schema_extra' in merged_kwargs: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

485 # We need to merge `json_schema_extra`'s: 

486 existing_js_extra = merged_kwargs['json_schema_extra'] 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

487 if isinstance(existing_js_extra, dict): 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

488 if isinstance(current_js_extra, dict): 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

489 new_js_extra = { 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

490 **existing_js_extra, 

491 **current_js_extra, 

492 } 

493 elif callable(current_js_extra): 493 ↛ 508line 493 didn't jump to line 508 because the condition on line 493 was always true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

494 warn( 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

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

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

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

498 UserWarning, 

499 ) 

500 elif callable(existing_js_extra) and isinstance(current_js_extra, dict): 500 ↛ 508line 500 didn't jump to line 508 because the condition on line 500 was always true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

501 warn( 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

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

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

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

505 UserWarning, 

506 ) 

507 

508 merged_kwargs.update(meta._attributes_set) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

509 if new_js_extra is not None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

510 merged_kwargs['json_schema_extra'] = new_js_extra 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

511 elif typing_objects.is_deprecated(meta): 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

512 merged_kwargs['deprecated'] = meta 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

513 else: 

514 merged_metadata.append(meta) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

515 

516 merged_kwargs.update(attr_overrides) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

517 merged_field_info = cls(**merged_kwargs) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

518 merged_field_info.metadata = merged_metadata 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

519 return merged_field_info 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

520 

521 @staticmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

522 @typing_extensions.deprecated( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

523 "The 'merge_field_infos()' method is deprecated and will be removed in a future version. " 

524 'If you relied on this method, please open an issue in the Pydantic issue tracker.', 

525 category=None, 

526 ) 

527 def merge_field_infos(*field_infos: FieldInfo, **overrides: Any) -> FieldInfo: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

529 

530 Later `FieldInfo` instances override earlier ones. 

531 

532 Returns: 

533 FieldInfo: A merged FieldInfo instance. 

534 """ 

535 if len(field_infos) == 1: 535 ↛ 550line 535 didn't jump to line 550 because the condition on line 535 was always true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

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

537 field_info = field_infos[0]._copy() 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

538 field_info._attributes_set.update(overrides) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

539 

540 default_override = overrides.pop('default', PydanticUndefined) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

541 if default_override is Ellipsis: 541 ↛ 542line 541 didn't jump to line 542 because the condition on line 541 was never true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

542 default_override = PydanticUndefined 

543 if default_override is not PydanticUndefined: 543 ↛ 546line 543 didn't jump to line 546 because the condition on line 543 was always true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

544 field_info.default = default_override 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

545 

546 for k, v in overrides.items(): 546 ↛ 547line 546 didn't jump to line 547 because the loop on line 546 never started41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

547 setattr(field_info, k, v) 

548 return field_info # type: ignore 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

549 

550 merged_field_info_kwargs: dict[str, Any] = {} 

551 metadata = {} 

552 for field_info in field_infos: 

553 attributes_set = field_info._attributes_set.copy() 

554 

555 try: 

556 json_schema_extra = attributes_set.pop('json_schema_extra') 

557 existing_json_schema_extra = merged_field_info_kwargs.get('json_schema_extra') 

558 

559 if existing_json_schema_extra is None: 

560 merged_field_info_kwargs['json_schema_extra'] = json_schema_extra 

561 if isinstance(existing_json_schema_extra, dict): 

562 if isinstance(json_schema_extra, dict): 

563 merged_field_info_kwargs['json_schema_extra'] = { 

564 **existing_json_schema_extra, 

565 **json_schema_extra, 

566 } 

567 if callable(json_schema_extra): 

568 warn( 

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

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

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

572 PydanticJsonSchemaWarning, 

573 ) 

574 elif callable(json_schema_extra): 

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

576 merged_field_info_kwargs['json_schema_extra'] = json_schema_extra 

577 except KeyError: 

578 pass 

579 

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

581 merged_field_info_kwargs.update(attributes_set) 

582 

583 for x in field_info.metadata: 

584 if not isinstance(x, FieldInfo): 

585 metadata[type(x)] = x 

586 

587 merged_field_info_kwargs.update(overrides) 

588 field_info = FieldInfo(**merged_field_info_kwargs) 

589 field_info.metadata = list(metadata.values()) 

590 return field_info 

591 

592 @staticmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

593 def _from_dataclass_field(dc_field: DataclassField[Any]) -> FieldInfo: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

595 

596 Args: 

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

598 

599 Returns: 

600 The corresponding `FieldInfo` instance. 

601 

602 Raises: 

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

604 """ 

605 default = dc_field.default 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

606 if default is dataclasses.MISSING: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

607 default = _Unset 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

608 

609 if dc_field.default_factory is dataclasses.MISSING: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

610 default_factory = _Unset 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

611 else: 

612 default_factory = dc_field.default_factory 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

613 

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

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

616 if sys.version_info >= (3, 14) and dc_field.doc is not None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

617 dc_field_metadata['description'] = dc_field.doc 9 ctx1opqrstuvw

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

619 

620 @staticmethod 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

622 """Collect annotations from kwargs. 

623 

624 Args: 

625 kwargs: Keyword arguments passed to the function. 

626 

627 Returns: 

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

629 `PydanticMetadata`. 

630 """ 

631 metadata: list[Any] = [] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

632 general_metadata = {} 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

633 for key, value in list(kwargs.items()): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

634 try: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

635 marker = FieldInfo.metadata_lookup[key] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

636 except KeyError: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

637 continue 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

638 

639 del kwargs[key] 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

640 if value is not None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

641 if marker is None: 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

642 general_metadata[key] = value 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

643 else: 

644 metadata.append(marker(value)) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

645 if general_metadata: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

646 metadata.append(_fields.pydantic_general_metadata(**general_metadata)) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

647 return metadata 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

648 

649 @property 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

650 def deprecation_message(self) -> str | None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

652 if self.deprecated is None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

653 return None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

654 if isinstance(self.deprecated, bool): 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

655 return 'deprecated' if self.deprecated else None 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

656 return self.deprecated if isinstance(self.deprecated, str) else self.deprecated.message 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

657 

658 @property 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

659 def default_factory_takes_validated_data(self) -> bool | None: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

661 

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

663 """ 

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

665 return _fields.takes_validated_data_argument(self.default_factory) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

666 

667 @overload 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

668 def get_default( 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

670 ) -> Any: ... 15 ctx1ghabnijkcdPlmef

671 

672 @overload 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

674 

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

676 """Get the default value. 

677 

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

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

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

681 

682 Args: 

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

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

685 

686 Returns: 

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

688 """ 

689 if self.default_factory is None: 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

690 return _utils.smart_deepcopy(self.default) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

691 elif call_default_factory: 691 ↛ 703line 691 didn't jump to line 703 because the condition on line 691 was always true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

692 if self.default_factory_takes_validated_data: 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

693 fac = cast('Callable[[dict[str, Any]], Any]', self.default_factory) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

694 if validated_data is None: 694 ↛ 695line 694 didn't jump to line 695 because the condition on line 694 was never true41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

695 raise ValueError( 

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

697 ) 

698 return fac(validated_data) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

699 else: 

700 fac = cast('Callable[[], Any]', self.default_factory) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

701 return fac() 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

702 else: 

703 return None 

704 

705 def is_required(self) -> bool: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

707 

708 Returns: 

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

710 """ 

711 return self.default is PydanticUndefined and self.default_factory is None 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

712 

713 def rebuild_annotation(self) -> Any: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

715 

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

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

718 

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

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

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

722 

723 Returns: 

724 The rebuilt annotation. 

725 """ 

726 if not self.metadata: 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

727 return self.annotation 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

728 else: 

729 # Annotated arguments must be a tuple 

730 return Annotated[(self.annotation, *self.metadata)] # type: ignore 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

731 

732 def apply_typevars_map( 40 ctx1JKxyzAghabopqLMBCDEjkcdrstPNOFGHIlmefuvw

733 self, 

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

735 globalns: GlobalsNamespace | None = None, 

736 localns: MappingNamespace | None = None, 

737 ) -> None: 

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

739 

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

741 

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

743 

744 Args: 

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

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

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

748 

749 See Also: 

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

751 their concrete types. 

752 """ 

753 annotation = _generics.replace_types(self.annotation, typevars_map) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

754 annotation, evaluated = _typing_extra.try_eval_type(annotation, globalns, localns) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

755 self.annotation = annotation 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

756 if not evaluated: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

757 self._complete = False 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

758 self._original_annotation = self.annotation 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw

759 

760 def _copy(self) -> Self: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

761 """Return a copy of the `FieldInfo` instance.""" 

762 # Note: we can't define a custom `__copy__()`, as `FieldInfo` is being subclassed 

763 # by some third-party libraries with extra attributes defined (and as `FieldInfo` 

764 # is slotted, we can't make a copy of the `__dict__`). 

765 copied = copy(self) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

766 for attr_name in ('metadata', '_attributes_set', '_qualifiers'): 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

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

768 value = getattr(copied, attr_name).copy() 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

769 setattr(copied, attr_name, value) 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

770 

771 return copied 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

772 

773 def __repr_args__(self) -> ReprArgs: 42 ctx1JKxyzAghabopqniLMBCDEjkcdrstPNOFGHIlmefuvw

774 yield 'annotation', _repr.PlainRepr(_repr.display_as_type(self.annotation)) 41 ctx1JKxyzAghabopqniLMBCDEjkcdrstNOFGHIlmefuvw