Coverage for pydantic/fields.py: 91.23%

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

2 

3from __future__ import annotations as _annotations 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

4 

5import dataclasses 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

6import inspect 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

7import sys 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

8import typing 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

9from collections.abc import Callable, Mapping 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

10from copy import copy 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

11from dataclasses import Field as DataclassField 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

12from functools import cached_property 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

14from warnings import warn 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

15 

16import annotated_types 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

17import typing_extensions 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

18from pydantic_core import PydanticUndefined 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

20from typing_inspection import typing_objects 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

22 

23from . import types 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

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

27from .config import JsonDict 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

28from .errors import PydanticForbiddenQualifier, PydanticUserError 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

29from .json_schema import PydanticJsonSchemaWarning 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

30from .warnings import PydanticDeprecatedSince20 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

31 

32if typing.TYPE_CHECKING: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

39 

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

41 

42 

43_Unset: Any = PydanticUndefined 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

44 

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

46 import warnings 16 ctx1abstMcdyzNPefEFO

47 

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

49else: 

50 Deprecated: TypeAlias = deprecated 26 ctx1GHopqrghniIJuvwxjkKLABCDlm

51 

52 

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

59 alias: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

60 alias_priority: int | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

62 serialization_alias: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

63 title: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

65 description: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

66 examples: list[Any] | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

67 exclude: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

68 gt: annotated_types.SupportsGt | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

69 ge: annotated_types.SupportsGe | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

70 lt: annotated_types.SupportsLt | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

71 le: annotated_types.SupportsLe | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

72 multiple_of: float | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

73 strict: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

74 min_length: int | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

75 max_length: int | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

77 allow_inf_nan: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

78 max_digits: int | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

79 decimal_places: int | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

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

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

84 frozen: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

85 validate_default: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

86 repr: bool 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

87 init: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

88 init_var: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

89 kw_only: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

90 coerce_numbers_to_str: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

91 fail_fast: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

92 

93 

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

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

96 

97 default: Any 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

98 

99 

100@final 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

101class FieldInfo(_repr.Representation): 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

139 default: Any 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

141 alias: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

142 alias_priority: int | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

144 serialization_alias: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

145 title: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

147 description: str | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

148 examples: list[Any] | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

149 exclude: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

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

153 frozen: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

154 validate_default: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

155 repr: bool 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

156 init: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

157 init_var: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

158 kw_only: bool | None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

159 metadata: list[Any] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

160 

161 __slots__ = ( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

220 

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

222 if default is Ellipsis: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

223 self.default = PydanticUndefined 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

225 else: 

226 self.default = default 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

227 

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

229 

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

231 raise TypeError('cannot specify both default and default_factory') 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

232 

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

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

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

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

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

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

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

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

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

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

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

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

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

250 # currently only used on dataclasses 

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

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

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

254 

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

256 

257 # Private attributes: 

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

259 # Used to rebuild FieldInfo instances: 

260 self._complete = True 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

261 self._original_annotation: Any = PydanticUndefined 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

262 self._original_assignment: Any = PydanticUndefined 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

263 

264 @staticmethod 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

291 

292 @staticmethod 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

327 inspected_ann = inspect_annotation( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

328 annotation, 

329 annotation_source=_source, 

330 unpack_type_aliases='skip', 

331 ) 

332 except ForbiddenQualifier as e: 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

333 raise PydanticForbiddenQualifier(e.qualifier, annotation) 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

342 metadata = inspected_ann.metadata 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

343 

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

345 if final: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

346 attr_overrides['frozen'] = True 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

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

348 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

349 return field_info 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

350 

351 @staticmethod 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

352 def from_annotated_attribute( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 default: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

380 raise PydanticUserError( 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

387 inspected_ann = inspect_annotation( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

388 annotation, 

389 annotation_source=_source, 

390 unpack_type_aliases='skip', 

391 ) 

392 except ForbiddenQualifier as e: 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

393 raise PydanticForbiddenQualifier(e.qualifier, annotation) 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

401 metadata = inspected_ann.metadata 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

408 if final: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

409 attr_overrides['frozen'] = True 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

415 field_info = default._copy() 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

416 field_info._attributes_set.update(attr_overrides) 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

417 for k, v in attr_overrides.items(): 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

418 setattr(field_info, k, v) 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

419 return field_info 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

420 

421 if isinstance(default, FieldInfo): 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

423 prepend_metadata = default_copy.metadata 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

424 default_copy.metadata = [] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

425 metadata = metadata + [default_copy] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

427 from_field = FieldInfo._from_dataclass_field(default) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

429 from_field.metadata = [] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

430 metadata = metadata + [from_field] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

432 attr_overrides['init_var'] = True 39 ctx1GHopqrghabstniIJuvwxjkcdyzPKLABCDlmefEF

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

434 attr_overrides['init'] = init 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

436 attr_overrides['kw_only'] = kw_only 35 ctx1opqrghabstMiuvwxjkcdyzNPABCDlmefEFO

437 else: 

438 # `default` is the actual default value 

439 attr_overrides['default'] = default 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

440 

441 field_info = FieldInfo._construct( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

443 ) 

444 field_info._qualifiers = inspected_ann.qualifiers 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

445 return field_info 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

446 

447 @classmethod 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

477 

478 for meta in metadata: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

479 if isinstance(meta, FieldInfo): 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

480 merged_metadata.extend(meta.metadata) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

481 

482 new_js_extra: JsonDict | None = None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

483 current_js_extra = meta.json_schema_extra 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

486 existing_js_extra = merged_kwargs['json_schema_extra'] 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

487 if isinstance(existing_js_extra, dict): 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

488 if isinstance(current_js_extra, dict): 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

489 new_js_extra = { 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

494 warn( 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

501 warn( 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

509 if new_js_extra is not None: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

510 merged_kwargs['json_schema_extra'] = new_js_extra 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

511 elif typing_objects.is_deprecated(meta): 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

512 merged_kwargs['deprecated'] = meta 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

513 else: 

514 merged_metadata.append(meta) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

515 

516 merged_kwargs.update(attr_overrides) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

517 merged_field_info = cls(**merged_kwargs) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

518 merged_field_info.metadata = merged_metadata 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

519 return merged_field_info 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

520 

521 @staticmethod 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

522 @typing_extensions.deprecated( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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

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

538 field_info._attributes_set.update(overrides) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

539 

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

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

544 field_info.default = default_override 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

547 setattr(field_info, k, v) 

548 return field_info # type: ignore 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

606 if default is dataclasses.MISSING: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

607 default = _Unset 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

608 

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

610 default_factory = _Unset 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

611 else: 

612 default_factory = dc_field.default_factory 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

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 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

617 

618 @staticmethod 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

620 """Collect annotations from kwargs. 

621 

622 Args: 

623 kwargs: Keyword arguments passed to the function. 

624 

625 Returns: 

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

627 `PydanticMetadata`. 

628 """ 

629 metadata: list[Any] = [] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

630 general_metadata = {} 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

631 for key, value in list(kwargs.items()): 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

632 try: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

633 marker = FieldInfo.metadata_lookup[key] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

634 except KeyError: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

635 continue 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

636 

637 del kwargs[key] 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

638 if value is not None: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

639 if marker is None: 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

640 general_metadata[key] = value 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

641 else: 

642 metadata.append(marker(value)) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

643 if general_metadata: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

644 metadata.append(_fields.pydantic_general_metadata(**general_metadata)) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

645 return metadata 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

646 

647 @property 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

648 def deprecation_message(self) -> str | None: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

650 if self.deprecated is None: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

651 return None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

652 if isinstance(self.deprecated, bool): 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

653 return 'deprecated' if self.deprecated else None 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

654 return self.deprecated if isinstance(self.deprecated, str) else self.deprecated.message 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

655 

656 @property 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

657 def default_factory_takes_validated_data(self) -> bool | None: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

659 

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

661 """ 

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

663 return _fields.takes_validated_data_argument(self.default_factory) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

664 

665 @overload 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

666 def get_default( 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

668 ) -> Any: ... 15 ctx1ghabnijkcdPlmef

669 

670 @overload 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

672 

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

674 """Get the default value. 

675 

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

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

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

679 

680 Args: 

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

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

683 

684 Returns: 

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

686 """ 

687 if self.default_factory is None: 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

688 return _utils.smart_deepcopy(self.default) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

689 elif call_default_factory: 689 ↛ 701line 689 didn't jump to line 701 because the condition on line 689 was always true41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

690 if self.default_factory_takes_validated_data: 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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

692 if validated_data is None: 692 ↛ 693line 692 didn't jump to line 693 because the condition on line 692 was never true41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

693 raise ValueError( 

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

695 ) 

696 return fac(validated_data) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

697 else: 

698 fac = cast('Callable[[], Any]', self.default_factory) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

699 return fac() 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

700 else: 

701 return None 

702 

703 def is_required(self) -> bool: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

705 

706 Returns: 

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

708 """ 

709 return self.default is PydanticUndefined and self.default_factory is None 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

710 

711 def rebuild_annotation(self) -> Any: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

713 

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

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

716 

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

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

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

720 

721 Returns: 

722 The rebuilt annotation. 

723 """ 

724 if not self.metadata: 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

725 return self.annotation 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

726 else: 

727 # Annotated arguments must be a tuple 

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

729 

730 def apply_typevars_map( 40 ctx1GHopqrghabstMIJuvwxjkcdyzNPKLABCDlmefEFO

731 self, 

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

733 globalns: GlobalsNamespace | None = None, 

734 localns: MappingNamespace | None = None, 

735 ) -> None: 

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

737 

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

739 

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

741 

742 Args: 

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

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

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

746 

747 See Also: 

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

749 their concrete types. 

750 """ 

751 annotation = _generics.replace_types(self.annotation, typevars_map) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

752 annotation, evaluated = _typing_extra.try_eval_type(annotation, globalns, localns) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

753 self.annotation = annotation 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

754 if not evaluated: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

755 self._complete = False 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

756 self._original_annotation = self.annotation 38 ctx1GHopqrghabstniIJuvwxjkcdyzKLABCDlmefEF

757 

758 def _copy(self) -> Self: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

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

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

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

763 copied = copy(self) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

764 for attr_name in ('metadata', '_attributes_set', '_qualifiers'): 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

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

766 value = getattr(copied, attr_name).copy() 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

767 setattr(copied, attr_name, value) 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

768 

769 return copied 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

770 

771 def __repr_args__(self) -> ReprArgs: 42 ctx1GHopqrghabstMniIJuvwxjkcdyzNPKLABCDlmefEFO

772 yield 'annotation', _repr.PlainRepr(_repr.display_as_type(self.annotation)) 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

773 yield 'required', self.is_required() 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

774 

775 for s in self.__slots__: 41 ctx1GHopqrghabstMniIJuvwxjkcdyzNKLABCDlmefEFO

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