feat(core): update pydantic to v2, django-ninja to v1

Author: trumpchifan

core/router.py

@@ -1,6 +1,7 @@
 from typing import Any, List, Optional, Type, TypeVar, Union
 
-from core.schemas import DictId, PageFilter, PageSchema, StandResponse
+
+from core.schemas import DictId, PageFilter, PageSchema, StandResponse, OptionalDictResponseType
 from core.service import GenericCURD
 from ninja import Body, Query, Router, Schema
 from ninja.constants import NOT_SET_TYPE
@@ -41,18 +42,19 @@ def create_obj(request, payload: self.in_schema):
             f"{self.path}/{{id}}", response=StandResponse[Union[self.out_schema, None]]
         )
         def get_obj(request, id: int):
-            return self.service_impl.get_obj(id)
+            obj = self.service_impl.get_obj(id)
+            return StandResponse[Union[self.out_schema, None]](data=obj.data)
 
         # get a list of objs
         @self.get(self.path, response=StandResponse[PageSchema[self.out_schema]])
         def list_obj(request, filters: self.filters_class = Query(...)):
             objs = self.service_impl.list_obj(filters, self.out_schema)
-            return StandResponse(data=objs)
+            return StandResponse[PageSchema[self.out_schema]](data=objs)
 
         # full update obj
         @self.put(
             f"{self.path}/{{id}}",
-            response=StandResponse[Union[DictId, dict]],
+            response=OptionalDictResponseType,
             description="full obj update",
         )
         def update_obj(request, id: int, payload: self.in_schema):
@@ -63,7 +65,7 @@ def update_obj(request, id: int, payload: self.in_schema):
         # partial update obj
         @self.patch(
             f"{self.path}/{{id}}",
-            response=StandResponse[Union[DictId, None]],
+            response=OptionalDictResponseType,
             description="partial obj update",
         )
         def partial_update_obj(request, id: int, payload: dict = Body(...)):

core/schemas.py

@@ -1,8 +1,6 @@
-from enum import IntEnum
-from typing import TypeVar, Generic, List, Optional
+from typing import TypeVar, Generic, List, Optional, Union
 from ninja import Schema
-from pydantic import conint, validator, BaseModel, Field
-from pydantic.generics import GenericModel
+from pydantic import conint, BaseModel, Field, field_validator
 
 
 class ErrorMsg(BaseModel):
@@ -13,15 +11,18 @@ class ErrorMsg(BaseModel):
 GenericResultsType = TypeVar("GenericResultsType")
 
 
-class StandResponse(ErrorMsg, GenericModel, Generic[GenericResultsType]):
+class StandResponse(ErrorMsg, Generic[GenericResultsType]):
     data: GenericResultsType
 
 
 class DictId(BaseModel):
     id: conint(ge=-1)
 
 
-class PageSchema(GenericModel, Generic[GenericResultsType]):
+OptionalDictResponseType = StandResponse[Union[Optional[DictId], dict]]
+
+
+class PageSchema(BaseModel, Generic[GenericResultsType]):
     total: int
     page_size: int
     page_index: int
@@ -33,7 +34,7 @@ class PageFilter(Schema):
     page_size: conint(ge=1, le=100) = 10
     ordering: str = Field("", alias="ordering", description="排序字段，多个时用,分割")
 
-    @validator("page_index")
+    @field_validator("page_index")
     def page_index_check(cls, page_index):
         if page_index <= 1:
             return 1
@@ -43,17 +44,17 @@ def dict(
         self,
         *,
         exclude_none=True,
-        exclude={"page_index", "page_size", "ordering"},
+        exclude=None,
         by_alias: bool = False,
-        skip_defaults: bool = None,
         exclude_unset: bool = False,
         exclude_defaults: bool = False,
     ) -> "DictStrAny":
+        if exclude is None:
+            exclude = {"page_index", "page_size", "ordering"}
         return super().dict(
             exclude_none=exclude_none,
             exclude=exclude,
             by_alias=by_alias,
-            skip_defaults=skip_defaults,
             exclude_unset=exclude_unset,
             exclude_defaults=exclude_defaults,
         )

core/service.py

@@ -1,10 +1,10 @@
 import uuid
 from abc import ABC, abstractmethod
-from typing import Any, Union
+from typing import Any, Union, Optional
 
 from core import cache, response
 from core.model import CoreModelSoftDelete
-from core.schemas import DictId, PageFilter, PageSchema, StandResponse
+from core.schemas import DictId, PageFilter, PageSchema, StandResponse, OptionalDictResponseType
 from django.db.models import Model
 from django.http import Http404
 from django.shortcuts import get_object_or_404
@@ -83,7 +83,7 @@ def list_obj(self, page_filter: PageFilter, page_schema: PageSchema) -> PageSche
 
     def update_obj(
         self, id: int, payload, user_email
-    ) -> StandResponse[Union[DictId, dict]]:
+    ) -> OptionalDictResponseType:
         return model_opertion.update(
             updater=user_email, model=self.model, payload=payload, obj_id=id
         )
@@ -139,10 +139,10 @@ def list_obj(self, page_filter: PageFilter, page_schema: PageSchema) -> PageSche
 
     def update_obj(
         self, id: int, payload: GenericPayload, user_email: str
-    ) -> StandResponse[Union[DictId, dict]]:
+    ) -> OptionalDictResponseType:
         obj = self._get_obj_by_id(id=id)
         if obj is None:
-            return StandResponse[dict](
+            return OptionalDictResponseType(
                 message=f"{id=} not exist", success=False, data={}
             )
         return model_opertion.update_by_obj(
@@ -151,7 +151,7 @@ def update_obj(
 
     def partial_update(
         self, id: int, user_email: str, **fields_kv
-    ) -> StandResponse[Union[DictId, dict]]:
+    ) -> OptionalDictResponseType:
         obj = self._get_obj_by_id(id=id)
         return model_opertion.update_by_obj(updater=user_email, obj=obj, **fields_kv)
 

core/tests.py

@@ -35,7 +35,7 @@ def test_get_token_fresh_success(self):
             data={"refresh": response_data["data"]["refresh"]},
             content_type="application/json",
         ).json()
-        self.assertEqual(response['data']['refresh'], response_data['data']['refresh'])
+        self.assertEqual(response['refresh'], response_data['data']['refresh'])
 
     def test_auth_token_failure_wrong_user_and_password(self):
         """Test the failure of authentication token generation.

employee/schemas.py

@@ -11,7 +11,7 @@ class EmployeeIn(Schema):
     first_name: str
     last_name: str
     department_id: int = None
-    birthdate: date = None
+    birthdate: Optional[date] = None
 
 
 class EmployeeOut(EmployeeIn):
@@ -21,4 +21,4 @@ class EmployeeOut(EmployeeIn):
 class EmployeeFilters(PageFilter):
     first_name__contains: str = Field(None, alias="first_name")
     last_name__contains: str = Field(None, alias="last_name")
-    department_id: Optional[conint(ge=0)]
+    department_id: Optional[conint(ge=0)] = None

employee/tests.py

@@ -57,9 +57,11 @@ def test_get_obj(self):
         response = self.token_client.get("/employees/1")
 
         self.assertEqual(response.status_code, 200)
-        self.assertDictContainsSubset(
+        resp: dict= response.json()["data"]
+        resp.pop('id')
+        self.assertDictEqual(
             self.employee_in.dict(),
-            response.json()["data"],
+            resp,
             f"query input obj: {self.employee_in}",
         )
 

requirements.txt

@@ -1,8 +1,6 @@
 asgiref
 dataclasses
-Django~=4.2.2
-django-ninja
-pydantic~=1.10.9
+django-ninja==1.3.0
 pytz
 sqlparse
 typing-extensions
@@ -13,6 +11,6 @@ PyMySQL~=1.0.3
 django-redis
 gevent==22.10.2
 gunicorn==20.1.0
-django-ninja-jwt==5.2.7
+django-ninja-jwt==5.3.4
 
 django-celery-beat==2.6.0

utils/model_opertion.py

@@ -1,29 +1,29 @@
 import logging
-from typing import TypeVar, Union, Any
+from typing import TypeVar, Union, Any, Optional
 import traceback
 
 from django.core.exceptions import ValidationError
 from django.shortcuts import get_object_or_404
 from pydantic import conint
 
-from core.schemas import StandResponse, DictId
+from core.schemas import StandResponse, DictId, OptionalDictResponseType
 from core.model import CoreModel
 
 logger = logging.getLogger(__name__)
 
 GenericPayload = TypeVar("GenericPayload")
 
 
-def create(creator: str, model: CoreModel, payload: GenericPayload) -> StandResponse[Union[DictId, None]]:
+def create(creator: str, model: CoreModel, payload: GenericPayload) -> StandResponse[Optional[DictId]]:
     """创建对象"""
     try:
         logger.info(f"input: create={model.__name__}, payload={payload.dict()}")
         obj = model.objects.create(creator=creator, **payload.dict())
     except Exception as e:
         logger.error(traceback.format_exc())
-        return StandResponse(success=False, message=str(e), data=None)
+        return StandResponse[Optional[DictId]](success=False, message=str(e), data=None)
     logger.info(f"create {model.__name__} success, id: {obj.id}")
-    return StandResponse(data=DictId(id=obj.id))
+    return StandResponse[Optional[DictId]](data=DictId(id=obj.id))
 
 
 def create_obj_with_validate_unique(
@@ -46,10 +46,10 @@ def create_obj_with_validate_unique(
         raise e
 
     logger.info(f"create {model.__name__} success, id: {obj.id}")
-    return StandResponse(data=DictId(id=obj.id))
+    return StandResponse[Union[DictId, dict]](data=DictId(id=obj.id))
 
 
-def _update(obj, payload: dict, updater: str) -> StandResponse[Union[DictId,None]]:
+def _update(obj, payload: dict, updater: str) -> OptionalDictResponseType:
     logger.info(f"input: update={obj.__class__.__name__}, payload={payload}")
     obj.updater = updater
     for attr, value in payload.items():
@@ -58,9 +58,9 @@ def _update(obj, payload: dict, updater: str) -> StandResponse[Union[DictId,None
         obj.save()
     except Exception as e:
         logger.warning(traceback.format_exc())
-        return StandResponse(success=False, message=str(e), data=None)
+        return OptionalDictResponseType(success=False, message=str(e), data=None)
     logger.info(f"update {obj.__class__.__name__} success, id: {obj.id}")
-    return StandResponse(data=DictId(id=obj.id))
+    return OptionalDictResponseType(data=DictId(id=obj.id))
 
 
 def update(updater: str, model: CoreModel, payload: GenericPayload, obj_id: conint(ge=1)) -> StandResponse[Union[DictId, None]]:
@@ -69,10 +69,10 @@ def update(updater: str, model: CoreModel, payload: GenericPayload, obj_id: coni
     return _update(obj=obj, payload=payload.dict(), updater=updater)
 
 
-def partial_update(updater: str, model: CoreModel, obj_id: conint(ge=1), **kwargs) -> StandResponse[Union[DictId, None]]:
+def partial_update(updater: str, model: CoreModel, obj_id: conint(ge=1), **kwargs) -> OptionalDictResponseType:
     obj = get_object_or_404(model, id=obj_id)
     return _update(obj=obj, payload=kwargs, updater=updater)
 
 
-def update_by_obj(obj: CoreModel, updater: str, **kwargs) -> StandResponse[Union[DictId, None]]:
+def update_by_obj(obj: CoreModel, updater: str, **kwargs) -> OptionalDictResponseType:
     return _update(obj=obj, payload=kwargs, updater=updater)