Remove pydantic_kwargs, fix backward compatibility, fix tests

Author: YuriiMotov

sqlmodel/main.py

@@ -3,6 +3,7 @@
 import inspect as inspect_module
 import ipaddress
 import uuid
+import warnings
 import weakref
 from datetime import date, datetime, time, timedelta
 from decimal import Decimal
@@ -262,14 +263,11 @@ def Field(
         deprecated(
             """
             This parameter is deprecated.
-            Use `json_schema_extra` to add extra information to the JSON schema.
-            Use `pydantic_kwargs` to pass additional parameters to `Field` that are not
-            part of this interface, but accepted by Pydantic's Field.
+            Use `json_schema_extra` to add extra information to JSON schema.
             """
         ),
     ] = None,
     json_schema_extra: Optional[Dict[str, Any]] = None,
-    pydantic_kwargs: Optional[Dict[str, Any]] = None,
 ) -> Any: ...
 
 
@@ -320,14 +318,11 @@ def Field(
         deprecated(
             """
             This parameter is deprecated.
-            Use `json_schema_extra` to add extra information to the JSON schema.
-            Use `pydantic_kwargs` to pass additional parameters to `Field` that are not
-            part of this interface, but accepted by Pydantic's Field.
+            Use `json_schema_extra` to add extra information to JSON schema.
             """
         ),
     ] = None,
     json_schema_extra: Optional[Dict[str, Any]] = None,
-    pydantic_kwargs: Optional[Dict[str, Any]] = None,
 ) -> Any: ...
 
 
@@ -378,14 +373,11 @@ def Field(
         deprecated(
             """
             This parameter is deprecated.
-            Use `json_schema_extra` to add extra information to the JSON schema.
-            Use `pydantic_kwargs` to pass additional parameters to `Field` that are not
-            part of this interface, but accepted by Pydantic's Field.
+            Use `json_schema_extra` to add extra information to JSON schema.
             """
         ),
     ] = None,
     json_schema_extra: Optional[Dict[str, Any]] = None,
-    pydantic_kwargs: Optional[Dict[str, Any]] = None,
 ) -> Any: ...
 
 
@@ -434,38 +426,40 @@ def Field(
         deprecated(
             """
             This parameter is deprecated.
-            Use `json_schema_extra` to add extra information to the JSON schema.
-            Use `pydantic_kwargs` to pass additional parameters to `Field` that are not
-            part of this interface, but accepted by Pydantic's Field.
+            Use `json_schema_extra` to add extra information to JSON schema.
             """
         ),
     ] = None,
     json_schema_extra: Optional[Dict[str, Any]] = None,
-    pydantic_kwargs: Optional[Dict[str, Any]] = None,
 ) -> Any:
-    if schema_extra and (json_schema_extra or pydantic_kwargs):
-        raise RuntimeError(
-            "Passing schema_extra is not supported when "
-            "also passing a json_schema_extra or pydantic_kwargs"
+    if schema_extra:
+        warnings.warn(
+            "schema_extra parameter is deprecated. "
+            "Use json_schema_extra to add extra information to JSON schema.",
+            DeprecationWarning,
+            stacklevel=1,
         )
 
-    current_pydantic_kwargs = pydantic_kwargs or {}
+    field_info_kwargs = {}
     current_json_schema_extra = json_schema_extra or {}
     current_schema_extra = schema_extra or {}
 
     if IS_PYDANTIC_V2:
+        # Handle a workaround when json_schema_extra was passed via schema_extra
+        if "json_schema_extra" in current_schema_extra:
+            from_schema_extra = current_schema_extra.pop("json_schema_extra")
+            current_json_schema_extra = (
+                current_json_schema_extra or from_schema_extra
+            )
+        # Split parameters from schema_extra to field_info_kwargs and json_schema_extra
         for key, value in current_schema_extra.items():
-            # if schema_extra={"json_schema_extra": {"x-yy-zz": "zz"}}
-            if key == "json_schema_extra":
-                current_json_schema_extra.update(value)
-            elif key in FIELD_ACCEPTED_KWARGS:
-                current_pydantic_kwargs[key] = value
+            if key in FIELD_ACCEPTED_KWARGS:
+                field_info_kwargs[key] = value
             else:
                 current_json_schema_extra[key] = value
-        current_pydantic_kwargs["json_schema_extra"] = current_json_schema_extra
+        field_info_kwargs["json_schema_extra"] = current_json_schema_extra
     else:
-        current_pydantic_kwargs.update(current_json_schema_extra)
-        current_pydantic_kwargs.update(current_schema_extra)
+        field_info_kwargs.update(current_json_schema_extra or current_schema_extra)
 
     field_info = FieldInfo(
         default,
@@ -502,7 +496,7 @@ def Field(
         sa_column=sa_column,
         sa_column_args=sa_column_args,
         sa_column_kwargs=sa_column_kwargs,
-        **current_pydantic_kwargs,
+        **field_info_kwargs,
     )
     post_init_field_info(field_info)
     return field_info

tests/test_field_pd_and_json_kwarrgs.py

@@ -21,46 +21,31 @@ class Item(SQLModel):
     assert name_schema["x-custom-key"] == "Important Data"
 
 
-def test_pydantic_kwargs_applied():
-    """test pydantic_kwargs is applied to the field"""
-
-    class User(SQLModel):
-        user_name: str = Field(pydantic_kwargs={"validation_alias": "UserNameInInput"})
-
-    field_info = User.model_fields["user_name"]
-
-    assert field_info.validation_alias == "UserNameInInput"
-
-    data = {"UserNameInInput": "KimigaiiWuyi"}
-    user = User.model_validate(data)
-    assert user.user_name == "KimigaiiWuyi"
-
-
-def test_schema_extra_and_new_param_conflict():
-    """test that passing schema_extra and new params at the same time raises an error"""
+def test_schema_extra_and_new_param_conflict(caplog):
+    """
+    Test that passing schema_extra and json_schema_extra at the same time produces
+    a warning.
+    """
 
-    with pytest.raises(RuntimeError) as excinfo:
+    with pytest.warns(DeprecationWarning, match="schema_extra parameter is deprecated"):
         Field(schema_extra={"legacy": 1}, json_schema_extra={"new": 2})
-    assert "Passing schema_extra is not supported" in str(excinfo.value)
-
-    with pytest.raises(RuntimeError) as excinfo:
-        Field(schema_extra={"legacy": 1}, pydantic_kwargs={"alias": "Alias"})
-    assert "Passing schema_extra is not supported" in str(excinfo.value)
 
 
 def test_schema_extra_backward_compatibility():
     """
     test that schema_extra is backward compatible with json_schema_extra
     """
 
-    class LegacyItem(SQLModel):
-        name: str = Field(
-            schema_extra={
-                "example": "Sword of Old",
-                "x-custom-key": "Important Data",
-                "serialization_alias": "id_test",
-            }
-        )
+    with pytest.warns(DeprecationWarning, match="schema_extra parameter is deprecated"):
+
+        class LegacyItem(SQLModel):
+            name: str = Field(
+                schema_extra={
+                    "example": "Sword of Old",
+                    "x-custom-key": "Important Data",
+                    "serialization_alias": "id_test",
+                }
+            )
 
     schema = LegacyItem.model_json_schema()
 
@@ -76,16 +61,18 @@ class LegacyItem(SQLModel):
 def test_json_schema_extra_mix_in_schema_extra():
     """test that json_schema_extra is applied when it is in schema_extra"""
 
-    class Item(SQLModel):
-        name: str = Field(
-            schema_extra={
-                "json_schema_extra": {
-                    "example": "Sword of Power",
-                    "x-custom-key": "Important Data",
-                },
-                "serialization_alias": "id_test",
-            }
-        )
+    with pytest.warns(DeprecationWarning, match="schema_extra parameter is deprecated"):
+
+        class Item(SQLModel):
+            name: str = Field(
+                schema_extra={
+                    "json_schema_extra": {
+                        "example": "Sword of Power",
+                        "x-custom-key": "Important Data",
+                    },
+                    "serialization_alias": "id_test",
+                }
+            )
 
     schema = Item.model_json_schema()