fix: pydantic v2 pydantic_model_creator nullable field not optional. (#1454) (#1465)

Author: waketzheng

CHANGELOG.rst

@@ -16,6 +16,10 @@ Added
 - Add binary compression support for `UUIDField` in `MySQL`. (#1458)
 - Only `Model`, `Tortoise`, `BaseDBAsyncClient`, `__version__`, and `connections` are now exported from `tortoise`
 
+Fixed
+^^^^^
+- Fix pydantic v2 pydantic_model_creator nullable field not optional. (#1454)
+
 0.20.0
 ------
 Added

examples/blacksheep/models.py

@@ -1,6 +1,10 @@
+import tortoise
 from tortoise import fields, models
 from tortoise.contrib.pydantic import pydantic_model_creator
 
+if tortoise.__version__ >= "0.20":
+    raise RuntimeError("blacksheep not support pydantic V2, use tortoise-orm<0.20 instead!")
+
 
 class Users(models.Model):
     id = fields.UUIDField(pk=True)

examples/fastapi/main.py

@@ -22,7 +22,7 @@ async def get_users():
 
 @app.post("/users", response_model=User_Pydantic)
 async def create_user(user: UserIn_Pydantic):
-    user_obj = await Users.create(**user.dict(exclude_unset=True))
+    user_obj = await Users.create(**user.model_dump(exclude_unset=True))
     return await User_Pydantic.from_tortoise_orm(user_obj)
 
 
@@ -33,7 +33,7 @@ async def get_user(user_id: int):
 
 @app.put("/user/{user_id}", response_model=User_Pydantic)
 async def update_user(user_id: int, user: UserIn_Pydantic):
-    await Users.filter(id=user_id).update(**user.dict(exclude_unset=True))
+    await Users.filter(id=user_id).update(**user.model_dump(exclude_unset=True))
     return await User_Pydantic.from_queryset_single(Users.get(id=user_id))
 
 

examples/pydantic/recursive.py

@@ -75,7 +75,7 @@ async def run():
     await _2_1.gets_talked_to.add(_2_2, _1_1, loose)
 
     p = await Employee_Pydantic.from_tortoise_orm(await Employee.get(name="Root"))
-    print(p.json(indent=4))
+    print(p.model_dump_json(indent=4))
 
 
 if __name__ == "__main__":

examples/pydantic/tutorial_1.py

@@ -40,7 +40,7 @@ async def run():
     # As Python dict with Python objects (e.g. datetime)
     print(tourpy.model_dump())
     # As serialised JSON (e.g. datetime is ISO8601 string representation)
-    print(tourpy.json(indent=4))
+    print(tourpy.model_dump_json(indent=4))
 
 
 if __name__ == "__main__":

examples/pydantic/tutorial_2.py

@@ -48,7 +48,7 @@ async def run():
     # Note that the root element is 'root' that contains the root element.
     print(tourpy.model_dump())
     # As serialised JSON (e.g. datetime is ISO8601 string representation)
-    print(tourpy.json(indent=4))
+    print(tourpy.model_dump_json(indent=4))
 
 
 if __name__ == "__main__":

examples/pydantic/tutorial_3.py

@@ -68,13 +68,13 @@ async def run():
     tourpy = await Tournament_Pydantic.from_tortoise_orm(tournament)
 
     # As serialised JSON
-    print(tourpy.json(indent=4))
+    print(tourpy.model_dump_json(indent=4))
 
     # Serialise Event
     eventpy = await Event_Pydantic.from_tortoise_orm(event)
 
     # As serialised JSON
-    print(eventpy.json(indent=4))
+    print(eventpy.model_dump_json(indent=4))
 
 
 if __name__ == "__main__":

examples/pydantic/tutorial_4.py

@@ -98,7 +98,7 @@ async def run():
     tourpy = await Tournament_Pydantic.from_tortoise_orm(tournament)
 
     # As serialised JSON
-    print(tourpy.json(indent=4))
+    print(tourpy.model_dump_json(indent=4))
 
 
 if __name__ == "__main__":

tortoise/contrib/pydantic/creator.py

@@ -8,7 +8,7 @@
 
 from tortoise.contrib.pydantic.base import PydanticListModel, PydanticModel
 from tortoise.contrib.pydantic.utils import get_annotations
-from tortoise.fields import JSONField, relational
+from tortoise.fields import IntField, JSONField, TextField, relational
 
 if TYPE_CHECKING:  # pragma: nocoverage
     from tortoise.models import Model
@@ -348,11 +348,13 @@ def get_submodel(_model: "Type[Model]") -> Optional[Type[PydanticModel]]:
             return pmodel
 
         # Foreign keys and OneToOne fields are embedded schemas
+        is_to_one_relation = False
         if (
             field_type is relational.ForeignKeyFieldInstance
             or field_type is relational.OneToOneFieldInstance
             or field_type is relational.BackwardOneToOneRelation
         ):
+            is_to_one_relation = True
             model = get_submodel(fdesc["python_type"])
             if model:
                 if fdesc.get("nullable"):
@@ -410,6 +412,15 @@ def get_submodel(_model: "Type[Model]") -> Optional[Type[PydanticModel]]:
             if field_default is not None and not callable(field_default):
                 properties[fname] = (ftype, Field(default=field_default, **fconfig))
             else:
+                if (j := fconfig.get("json_schema_extra")) and (
+                    (
+                        j.get("nullable")
+                        and not is_to_one_relation
+                        and field_type not in (IntField, TextField)
+                    )
+                    or (exclude_readonly and j.get("readOnly"))
+                ):
+                    fconfig["default_factory"] = lambda: None
                 properties[fname] = (ftype, Field(**fconfig))
 
     # Here we endure that the name is unique, but complete objects are still labeled verbatim