extra -> json_schema_extra on Field

pydantic · samuelcolvin · Nov 2, 2022 · Sep 12, 2022 · Sep 14, 2022 · Sep 14, 2022
commit 708c77bd5a94c5ca2d79faf726aa593ba2c8ca16
diff --git a/pydantic/_internal/_utils.py b/pydantic/_internal/_utils.py
@@ -1,5 +1,7 @@
 """
 Bucket of reusable internal utilities.
+
+This should be reduced as much as possible with functions only used in one place, moved to that place.
 """
 from __future__ import annotations as _annotations
 
@@ -23,10 +25,8 @@
 
 __all__ = (
     'sequence_like',
-    'validate_field_name',
     'lenient_isinstance',
     'lenient_issubclass',
-    'in_ipython',
     'is_valid_identifier',
     'deep_update',
     'update_not_none',
@@ -84,18 +84,6 @@ def sequence_like(v: Any) -> bool:
     return isinstance(v, (list, tuple, set, frozenset, GeneratorType, deque))
 
 
-def validate_field_name(bases: list[type[BaseModel]], field_name: str) -> None:
-    """
-    Ensure that the field's name does not shadow an existing attribute of the model.
-    """
-    for base in bases:
-        if getattr(base, field_name, None):
-            raise NameError(
-                f'Field name "{field_name}" shadows a BaseModel attribute; '
-                f'use a different field name with "alias=\'{field_name}\'".'
-            )
-
-
 def lenient_isinstance(o: Any, class_or_tuple: type[Any] | tuple[type[Any], ...] | None) -> bool:
     try:
         return isinstance(o, class_or_tuple)  # type: ignore[arg-type]
@@ -112,18 +100,6 @@ def lenient_issubclass(cls: Any, class_or_tuple: Any) -> bool:
         raise  # pragma: no cover
 
 
-def in_ipython() -> bool:
-    """
-    Check whether we're in an ipython environment, including jupyter notebooks.
-    """
-    try:
-        eval('__IPYTHON__')
-    except NameError:
-        return False
-    else:  # pragma: no cover
-        return True
-
-
 def is_valid_identifier(identifier: str) -> bool:
     """
     Checks that a string is a valid identifier and not a Python keyword.

diff --git a/pydantic/fields.py b/pydantic/fields.py
@@ -17,7 +17,8 @@
 
 class FieldInfo(_repr.Representation):
     """
-    Captures extra information about a field.
+    Hold information about a field, FieldInfo is used however a field is defined, whether or not the `Field()`
+    function below is explicitly used.
     """
 
     __slots__ = (
@@ -33,7 +34,7 @@ class FieldInfo(_repr.Representation):
         'metadata',
         'repr',
         'discriminator',
-        'extra',
+        'json_schema_extra',
     )
 
     # used to convert kwargs to metadata/constraints,
@@ -57,29 +58,29 @@ class FieldInfo(_repr.Representation):
     }
 
     def __init__(self, **kwargs: Any) -> None:
-        self.annotation, annotation_metadata = self._extract_metadata(kwargs.pop('annotation', None))
+        self.annotation, annotation_metadata = self._extract_metadata(kwargs.get('annotation'))
 
         default = kwargs.pop('default', Undefined)
         if default is Ellipsis:
             self.default = Undefined
         else:
             self.default = default
 
-        self.default_factory = kwargs.pop('default_factory', None)
+        self.default_factory = kwargs.get('default_factory')
 
         if self.default is not Undefined and self.default_factory is not None:
             raise ValueError('cannot specify both default and default_factory')
 
-        self.alias = kwargs.pop('alias', None)
-        
8000
self.alias_priority = kwargs.pop('alias_priority', 2 if self.alias is not None else None)
-        self.title = kwargs.pop('title', None)
-        self.description = kwargs.pop('description', None)
-        self.exclude = kwargs.pop('exclude', None)
-        self.include = kwargs.pop('include', None)
+        self.alias = kwargs.get('alias')
+        self.alias_priority = kwargs.get('alias_priority', 2 if self.alias is not None else None)
+        self.title = kwargs.get('title')
+        self.description = kwargs.get('description')
+        self.exclude = kwargs.get('exclude')
+        self.include = kwargs.get('include')
         self.metadata = self._collect_metadata(kwargs) + annotation_metadata
-        self.discriminator = kwargs.pop('discriminator', None)
-        self.repr = kwargs.pop('repr', True)
-        self.extra = kwargs
+        self.discriminator = kwargs.get('discriminator')
+        self.repr = kwargs.get('repr', True)
+        self.json_schema_extra = kwargs.get('json_schema_extra')
 
     @classmethod
     def from_field(cls, default: Any = Undefined, **kwargs: Any) -> 'FieldInfo':
@@ -227,7 +228,7 @@ def __repr_args__(self) -> 'ReprArgs':
                 continue
             if s == 'default_factory' and self.default_factory is not None:
                 yield 'default_factory', _repr.PlainRepr(_repr.display_as_type(self.default_factory))
-            elif s != 'extra' or self.extra:
+            else:
                 value = getattr(self, s)
                 if value is not None and value is not Undefined:
                     yield s, value
@@ -258,7 +259,7 @@ def Field(
     pattern: str = None,
     discriminator: str = None,
     repr: bool = True,
-    **extra: Any,
+    json_schema_extra: dict[str, Any] | None = None,
 ) -> Any:
     """
     Used to provide extra information about a field, either for the model schema or complex validation. Some arguments
@@ -306,7 +307,7 @@ def Field(
     :param discriminator: only useful with a (discriminated a.k.a. tagged) `Union` of sub models with a common field.
       The `discriminator` is the name of this common field to shorten validation and improve generated schema
     :param repr: show this field in the representation
-    :param **extra: any additional keyword arguments will be added as is to the schema
+    :param json_schema_extra: extra dict to be merged with the JSON Schema for this field
     """
     return FieldInfo.from_field(
         default,
@@ -332,7 +333,7 @@ def Field(
         pattern=pattern,
         discriminator=discriminator,
         repr=repr,
-        **extra,
+        json_schema_extra=json_schema_extra,
     )
 
 

diff --git a/tests/mypy/modules/success.py b/tests/mypy/modules/success.py
@@ -141,7 +141,7 @@ class WrapperModel(GenericModel, Generic[T]):
 
 class WithField(B
77F4
aseModel):
     age: int
-    first_name: str = Field('John', const=True)
+    first_name: str = Field('John', max_length=42)
 
 
 # simple decorator

diff --git a/tests/test_main.py b/tests/test_main.py
@@ -1848,3 +1848,10 @@ def model_post_init(self, **kwargs) -> None:
     m = Model(c=1, d='2', sub={'a': 3, 'b': '4'})
     assert m.dict() == {'c': 1, 'd': 2, 'sub': {'a': 3, 'b': 4}}
     assert calls == ['submodel_post_init', 'model_post_init']
+
+
+def test_extra_args_to_field_type_error():
+    with pytest.raises(TypeError, match='unexpected keyword argument'):
+
+        class Model(BaseModel):
+            a: int = Field(thing=1)