refactor: BaseApiResponse to use code instead of errno

Author: freemindcore

easy/controller/meta.py

@@ -66,21 +66,21 @@ async def get_obj(self, request: HttpRequest, id: int) -> Any:  # type: ignore
                 qs = await self.service.get_obj(id)
             except Exception as e:  # pragma: no cover
                 logger.error(f"Get Error - {e}", exc_info=True)
-                return BaseApiResponse(str(e), message="Get Failed", errno=500)
+                return BaseApiResponse(str(e), message="Get Failed", code=500)
             if qs:
                 return qs
             else:
-                return BaseApiResponse(message="Not Found", errno=404)
+                return BaseApiResponse(message="Not Found", code=404)
 
         async def del_obj(self, request: HttpRequest, id: int) -> Any:  # type: ignore
             """
             DELETE /{id}
             Delete a single Object
             """
             if await self.service.del_obj(id):
-                return BaseApiResponse("Deleted.", errno=204)
+                return BaseApiResponse("Deleted.", code=204)
             else:
-                return BaseApiResponse("Not Found.", errno=404)
+                return BaseApiResponse("Not Found.", code=404)
 
         @paginate
         async def get_objs(self, request: HttpRequest, filters: str = None) -> Any:  # type: ignore
@@ -131,9 +131,9 @@ async def add_obj(  # type: ignore
                 """
                 obj_id = await self.service.add_obj(**data.dict())
                 if obj_id:
-                    return BaseApiResponse({"id": obj_id}, errno=201)
+                    return BaseApiResponse({"id": obj_id}, code=201)
                 else:
-                    return BaseApiResponse("Add failed", errno=204)  # pragma: no cover
+                    return BaseApiResponse("Add failed", code=204)  # pragma: no cover
 
             async def patch_obj(  # type: ignore
                 self, request: HttpRequest, id: int, data: DataSchema
@@ -145,7 +145,7 @@ async def patch_obj(  # type: ignore
                 if await self.service.patch_obj(id=id, payload=data.dict()):
                     return BaseApiResponse("Updated.")
                 else:
-                    return BaseApiResponse("Update Failed", errno=400)
+                    return BaseApiResponse("Update Failed", code=400)
 
             DataSchema.__name__ = (
                 f"{model_opts.model.__name__}__AutoSchema({str(uuid.uuid4())[:4]})"

easy/main.py

@@ -126,7 +126,7 @@ def create_response(
                 data = django_serializer.serialize_data(data)
             except Exception as e:  # pragma: no cover
                 logger.error(f"Creat Response Error - {e}", exc_info=True)
-                return BaseApiResponse(str(e), errno=500)
+                return BaseApiResponse(str(e), code=500)
 
         if self.easy_output:
             if temporal_response:

easy/response.py

@@ -18,18 +18,18 @@ class BaseApiResponse(JsonResponse):
     def __init__(
         self,
         data: Union[Dict, str] = None,
-        errno: int = None,
+        code: int = None,
         message: str = None,
         **kwargs: Any
     ):
-        if errno:
+        if code:
             message = message or UNKNOWN_ERROR_MSG
         else:
             message = SUCCESS_MESSAGE
-            errno = ERRNO_SUCCESS
+            code = ERRNO_SUCCESS
 
         _data: Union[Dict, str] = {
-            "code": errno,
+            "code": code,
             "message": message,
             "data": data if data is not None else {},
         }

tests/test_api_base_response.py

@@ -32,7 +32,7 @@ def test_base_api_result_dict():
 
 def test_base_api_result_message():
     assert (
-        BaseApiResponse(errno=-1, message="error test").json_data["message"]
+        BaseApiResponse(code=-1, message="error test").json_data["message"]
         == "error test"
     )
     assert BaseApiResponse().json_data["message"]
@@ -41,7 +41,7 @@ def test_base_api_result_message():
 def test_base_api_edit():
     orig_resp = BaseApiResponse(
         {"item_id": 2, "im": 14},
-        errno=0,
+        code=0,
     )
 
     with pytest.raises(KeyError):