Coverage for pydantic/fields.py: 98.61%

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 Callable, 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, 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 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, AliasGenerator, 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._config import ConfigWrapper 

34 from ._internal._repr import ReprArgs 1 ctx1p

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 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

39 

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

41 

42 

43_Unset: Any = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

44 

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

46 import warnings 10 ctx1abcdefJghi

47 

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

49else: 

50 Deprecated: TypeAlias = deprecated 32 ctx1xyzArsjkqpBCDEtulmNOPKLMFGHIvwno

51 

52 

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

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 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

59 alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

60 alias_priority: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

62 serialization_alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

63 title: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

65 description: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

66 examples: list[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

67 exclude: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

68 gt: annotated_types.SupportsGt | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

69 ge: annotated_types.SupportsGe | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

70 lt: annotated_types.SupportsLt | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

71 le: annotated_types.SupportsLe | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

72 multiple_of: float | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

73 strict: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

74 min_length: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

75 max_length: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

77 allow_inf_nan: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

78 max_digits: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

79 decimal_places: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

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

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

84 frozen: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

85 validate_default: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

86 repr: bool 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

87 init: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

88 init_var: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

89 kw_only: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

90 coerce_numbers_to_str: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

91 fail_fast: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

92 

93 

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

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

96 

97 default: Any 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

98 

99 

100class FieldInfo(_repr.Representation): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

102 

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

104 function is explicitly used. 

105 

106 !!! warning 

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

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

109 

110 Attributes: 

111 annotation: The type annotation of the field. 

112 default: The default value of the field. 

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

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

115 alias: The alias name of the field. 

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

117 validation_alias: The validation alias of the field. 

118 serialization_alias: The serialization alias of the field. 

119 title: The title of the field. 

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

121 description: The description of the field. 

122 examples: List of examples of the field. 

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

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

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

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

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

128 frozen: Whether the field is frozen. 

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

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

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

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

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

134 metadata: List of metadata constraints. 

135 """ 

136 

137 annotation: type[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

138 default: Any 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

140 alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

141 alias_priority: int | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

143 serialization_alias: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

144 title: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

146 description: str | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

147 examples: list[Any] | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

148 exclude: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

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

152 frozen: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

153 validate_default: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

154 repr: bool 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

155 init: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

156 init_var: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

157 kw_only: bool | None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

158 metadata: list[Any] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

159 

160 __slots__ = ( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

161 'annotation', 

162 'default', 

163 'default_factory', 

164 'alias', 

165 'alias_priority', 

166 'validation_alias', 

167 'serialization_alias', 

168 'title', 

169 'field_title_generator', 

170 'description', 

171 'examples', 

172 'exclude', 

173 'discriminator', 

174 'deprecated', 

175 'json_schema_extra', 

176 'frozen', 

177 'validate_default', 

178 'repr', 

179 'init', 

180 'init_var', 

181 'kw_only', 

182 'metadata', 

183 '_attributes_set', 

184 '_qualifiers', 

185 '_complete', 

186 '_original_assignment', 

187 '_original_annotation', 

188 ) 

189 

190 # used to convert kwargs to metadata/constraints, 

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

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

193 'strict': types.Strict, 

194 'gt': annotated_types.Gt, 

195 'ge': annotated_types.Ge, 

196 'lt': annotated_types.Lt, 

197 'le': annotated_types.Le, 

198 'multiple_of': annotated_types.MultipleOf, 

199 'min_length': annotated_types.MinLen, 

200 'max_length': annotated_types.MaxLen, 

201 'pattern': None, 

202 'allow_inf_nan': None, 

203 'max_digits': None, 

204 'decimal_places': None, 

205 'union_mode': None, 

206 'coerce_numbers_to_str': None, 

207 'fail_fast': types.FailFast, 

208 } 

209 

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

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

212 or one of the constructor classmethods. 

213 

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

215 """ 

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

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

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

219 

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

221 if default is Ellipsis: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

222 self.default = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

224 else: 

225 self.default = default 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

226 

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

228 

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

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

231 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

249 # currently only used on dataclasses 

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

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

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

253 

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

255 

256 # Private attributes: 

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

258 # Used to rebuild FieldInfo instances: 

259 self._complete = True 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

260 self._original_annotation: Any = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

261 self._original_assignment: Any = PydanticUndefined 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

262 

263 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

266 

267 Args: 

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

269 **kwargs: Additional arguments dictionary. 

270 

271 Raises: 

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

273 

274 Returns: 

275 A new FieldInfo object with the given parameters. 

276 

277 Example: 

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

279 

280 ```python 

281 import pydantic 

282 

283 class MyModel(pydantic.BaseModel): 

284 foo: int = pydantic.Field(4) 

285 ``` 

286 """ 

287 if 'annotation' in kwargs: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

290 

291 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

294 

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

296 

297 ```python 

298 import pydantic 

299 

300 class MyModel(pydantic.BaseModel): 

301 foo: int # <-- like this 

302 ``` 

303 

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

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

306 

307 ```python 

308 from typing import Annotated 

309 

310 import annotated_types 

311 

312 import pydantic 

313 

314 class MyModel(pydantic.BaseModel): 

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

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

317 ``` 

318 

319 Args: 

320 annotation: An annotation object. 

321 

322 Returns: 

323 An instance of the field metadata. 

324 """ 

325 try: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

326 inspected_ann = inspect_annotation( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

327 annotation, 

328 annotation_source=_source, 

329 unpack_type_aliases='skip', 

330 ) 

331 except ForbiddenQualifier as e: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

333 

334 # TODO check for classvar and error? 

335 

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

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

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

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

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

341 metadata = inspected_ann.metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

342 

343 if not metadata: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

346 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

347 return field_info 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

348 

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

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

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

352 

353 new_field_info = copy(field_info) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

354 new_field_info.annotation = type_expr 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

357 for a in metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

358 if typing_objects.is_deprecated(a): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

359 new_field_info.deprecated = a.message 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

361 field_metadata.append(a) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

362 else: 

363 field_metadata.extend(a.metadata) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

364 new_field_info.metadata = field_metadata 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

365 new_field_info._qualifiers = inspected_ann.qualifiers 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

366 return new_field_info 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

367 

368 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

369 def from_annotated_attribute( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

371 ) -> FieldInfo: 

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

373 

374 This is used in cases like the following: 

375 

376 ```python 

377 from typing import Annotated 

378 

379 import annotated_types 

380 

381 import pydantic 

382 

383 class MyModel(pydantic.BaseModel): 

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

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

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

387 ``` 

388 

389 Args: 

390 annotation: The type annotation of the field. 

391 default: The default value of the field. 

392 

393 Returns: 

394 A field object with the passed values. 

395 """ 

396 if annotation is default: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

397 raise PydanticUserError( 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

398 'Error when building FieldInfo from annotated attribute. ' 

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

400 code='unevaluable-type-annotation', 

401 ) 

402 

403 try: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

404 inspected_ann = inspect_annotation( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

405 annotation, 

406 annotation_source=_source, 

407 unpack_type_aliases='skip', 

408 ) 

409 except ForbiddenQualifier as e: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

411 

412 # TODO check for classvar and error? 

413 

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

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

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

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

418 metadata = inspected_ann.metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

419 

420 if isinstance(default, FieldInfo): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

422 default.annotation = type_expr 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

423 default.metadata += metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

424 merged_default = FieldInfo.merge_field_infos( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

426 default, 

427 annotation=default.annotation, 

428 ) 

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

430 merged_default._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

431 return merged_default 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

432 

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

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

435 pydantic_field = FieldInfo._from_dataclass_field(default) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

436 pydantic_field.annotation = type_expr 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

437 pydantic_field.metadata += metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

438 pydantic_field = FieldInfo.merge_field_infos( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

440 pydantic_field, 

441 annotation=pydantic_field.annotation, 

442 ) 

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

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

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

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

447 pydantic_field._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

448 return pydantic_field 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

449 

450 if not metadata: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

453 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

454 return field_info 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

455 

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

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

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

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

460 for a in metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

461 if typing_objects.is_deprecated(a): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

462 field_info.deprecated = a.message 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

464 field_metadata.append(a) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

465 else: 

466 field_metadata.extend(a.metadata) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

467 field_info.metadata = field_metadata 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

468 field_info._qualifiers = inspected_ann.qualifiers 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

469 return field_info 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

470 

471 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

474 

475 Later `FieldInfo` instances override earlier ones. 

476 

477 Returns: 

478 FieldInfo: A merged FieldInfo instance. 

479 """ 

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

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

482 field_info = copy(field_infos[0]) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

483 field_info._attributes_set.update(overrides) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

484 

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

486 if default_override is Ellipsis: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

487 default_override = PydanticUndefined 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

488 if default_override is not PydanticUndefined: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

489 field_info.default = default_override 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

490 

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

492 setattr(field_info, k, v) 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

493 return field_info # type: ignore 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

494 

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

496 metadata = {} 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

497 for field_info in field_infos: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

499 

500 try: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

503 

504 if existing_json_schema_extra is None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

505 merged_field_info_kwargs['json_schema_extra'] = json_schema_extra 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

506 if isinstance(existing_json_schema_extra, dict): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

507 if isinstance(json_schema_extra, dict): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

508 merged_field_info_kwargs['json_schema_extra'] = { 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

509 **existing_json_schema_extra, 

510 **json_schema_extra, 

511 } 

512 if callable(json_schema_extra): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

513 warn( 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

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

517 PydanticJsonSchemaWarning, 

518 ) 

519 elif callable(json_schema_extra): 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

521 merged_field_info_kwargs['json_schema_extra'] = json_schema_extra 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

522 except KeyError: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

523 pass 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

524 

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

526 merged_field_info_kwargs.update(attributes_set) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

527 

528 for x in field_info.metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

531 

532 merged_field_info_kwargs.update(overrides) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

533 field_info = FieldInfo(**merged_field_info_kwargs) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

535 return field_info 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

536 

537 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

540 

541 Args: 

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

543 

544 Returns: 

545 The corresponding `FieldInfo` instance. 

546 

547 Raises: 

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

549 """ 

550 default = dc_field.default 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

551 if default is dataclasses.MISSING: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

552 default = _Unset 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

553 

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

555 default_factory = _Unset 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

556 else: 

557 default_factory = dc_field.default_factory 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

558 

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

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

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

562 

563 @staticmethod 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

565 """Collect annotations from kwargs. 

566 

567 Args: 

568 kwargs: Keyword arguments passed to the function. 

569 

570 Returns: 

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

572 `PydanticMetadata`. 

573 """ 

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

575 general_metadata = {} 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

577 try: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

578 marker = FieldInfo.metadata_lookup[key] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

579 except KeyError: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

580 continue 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

581 

582 del kwargs[key] 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

583 if value is not None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

584 if marker is None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

585 general_metadata[key] = value 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

586 else: 

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

588 if general_metadata: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

590 return metadata 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

591 

592 @property 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

595 if self.deprecated is None: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

596 return None 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

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

600 

601 @property 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

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

604 

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

606 """ 

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

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

609 

610 @overload 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

611 def get_default( 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

613 ) -> Any: ... 21 ctx1jkabcqplmdefKLMJnoghi

614 

615 @overload 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

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

617 

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

619 """Get the default value. 

620 

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

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

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

624 

625 Args: 

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

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

628 

629 Returns: 

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

631 """ 

632 if self.default_factory is None: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

635 if self.default_factory_takes_validated_data: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

638 raise ValueError( 

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

640 ) 

641 return fac(validated_data) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

642 else: 

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

644 return fac() 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

645 else: 

646 return None 

647 

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

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

650 

651 Returns: 

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

653 """ 

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

655 

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

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

658 

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

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

661 

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

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

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

665 

666 Returns: 

667 The rebuilt annotation. 

668 """ 

669 if not self.metadata: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

670 return self.annotation 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

671 else: 

672 # Annotated arguments must be a tuple 

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

674 

675 def apply_typevars_map( 40 ctx1xyzArsjkabcBCDEtulmdefNOPKLMJFGHIvwnoghi

676 self, 

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

678 globalns: GlobalsNamespace | None = None, 

679 localns: MappingNamespace | None = None, 

680 ) -> None: 

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

682 

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

684 

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

686 

687 Args: 

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

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

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

691 

692 See Also: 

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

694 their concrete types. 

695 """ 

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

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

698 self.annotation = annotation 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

699 if not evaluated: 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

700 self._complete = False 21 ctx1rsjkabctulmdefvwnoghi

701 self._original_annotation = self.annotation 21 ctx1rsjkabctulmdefvwnoghi

702 

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

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

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

706 

707 for s in self.__slots__: 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

709 # By yielding a three-tuple: 

710 if s in ( 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

711 'annotation', 

712 '_attributes_set', 

713 '_qualifiers', 

714 '_complete', 

715 '_original_assignment', 

716 '_original_annotation', 

717 ): 

718 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

720 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

722 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

724 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

726 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

728 continue 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

730 yield 'default', self.default 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

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

733 else: 

734 value = getattr(self, s) 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

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

736 yield s, value 35 ctx1xyzArsjkabcqpBCDEtulmdefFGHIvwnoghi

737 

738 

739class _EmptyKwargs(typing_extensions.TypedDict): 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

740 """This class exists solely to ensure that type checking warns about passing `**extra` in `Field`.""" 

741 

742 

743_DefaultValues = { 42 ctx1xyzArsjkabcqpBCDEtulmdefNOPKLMJFGHIvwnoghi

744 'default': ..., 

745 'default_factory': None, 

746 'alias': None, 

747 'alias_priority': None, 

748 'validation_alias': None, 

749 'serialization_alias': None, 

750 'title': None, 

751 'description': None,