Merge pull request #12 from freemindcore/feat/django-model-config

Feat/django model config

Author: freemindcore

.bumpversion.cfg

@@ -1,9 +1,9 @@
 [bumpversion]
-current_version = 0.1.34
+current_version = 0.1.36
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<feat>\d+)\.(?P<patch>\d+)
-serialize =
+serialize = 
 	{major}.{feat}.{patch}
 
 [bumpversion:file:easy/__init__.py]

easy/__init__.py

@@ -1,6 +1,6 @@
 """Django Easy API - Easy and Fast Django REST framework based on Django-ninja-extra"""
 
-__version__ = "0.1.34"
+__version__ = "0.1.36"
 
 from easy.main import EasyAPI
 

easy/controller/auto_api.py

@@ -8,15 +8,12 @@
 from easy.controller.base import CrudAPIController
 from easy.controller.meta_conf import (
     GENERATE_CRUD_ATTR,
-    GENERATE_CRUD_ATTR_DEFAULT,
+    MODEL_EXCLUDE_ATTR,
     MODEL_FIELDS_ATTR,
-    MODEL_FIELDS_ATTR_DEFAULT,
     MODEL_JOIN_ATTR,
-    MODEL_JOIN_ATTR_DEFAULT,
     MODEL_RECURSIVE_ATTR,
-    MODEL_RECURSIVE_ATTR_DEFAULT,
     SENSITIVE_FIELDS_ATTR,
-    SENSITIVE_FIELDS_ATTR_DEFAULT,
+    ModelOptions,
 )
 from easy.permissions import AdminSitePermission, BaseApiPermission
 
@@ -31,16 +28,22 @@ def create_api_controller(
 ) -> Union[Type[ControllerBase], Type]:
     """Create APIController class dynamically, with specified permission class"""
     model_name = model.__name__  # type:ignore
+
+    model_opts: ModelOptions = ModelOptions.get_model_options(
+        getattr(model, "ApiMeta", None)
+    )
+
     Meta = type(
         "Meta",
         (object,),
         {
             "model": model,
-            GENERATE_CRUD_ATTR: GENERATE_CRUD_ATTR_DEFAULT,
-            MODEL_FIELDS_ATTR: MODEL_FIELDS_ATTR_DEFAULT,
-            MODEL_RECURSIVE_ATTR: MODEL_RECURSIVE_ATTR_DEFAULT,
-            MODEL_JOIN_ATTR: MODEL_JOIN_ATTR_DEFAULT,
-            SENSITIVE_FIELDS_ATTR: SENSITIVE_FIELDS_ATTR_DEFAULT,
+            GENERATE_CRUD_ATTR: model_opts.generate_crud,
+            MODEL_EXCLUDE_ATTR: model_opts.model_exclude,
+            MODEL_FIELDS_ATTR: model_opts.model_fields,
+            MODEL_RECURSIVE_ATTR: model_opts.model_recursive,
+            MODEL_JOIN_ATTR: model_opts.model_join,
+            SENSITIVE_FIELDS_ATTR: model_opts.model_fields,
         },
     )
 

easy/controller/meta_conf.py

@@ -49,7 +49,7 @@ def __init__(self, options: Dict = None):
         )
 
     @classmethod
-    def get_model_options(cls, meta: Dict) -> Any:
+    def get_model_options(cls, meta: Optional[Any]) -> "ModelOptions":
         return ModelOptions(meta)
 
     @classmethod

tests/easy_app/models.py

@@ -10,6 +10,9 @@ class Category(TestBaseModel):
     title = models.CharField(max_length=100)
     status = models.PositiveSmallIntegerField(default=1, null=True)
 
+    class ApiMeta:
+        generate_crud = False
+
 
 class Client(TestBaseModel):
     key = models.CharField(max_length=20, unique=True)

tests/test_async_auto_crud_apis.py

@@ -228,6 +228,7 @@ async def test_crud_default_create_some_fields(
         assert response.json()["data"]["key"] == "Type"
         with pytest.raises(KeyError):
             print(response.json()["data"]["password"])
+        with pytest.raises(KeyError):
             print(response.json()["data"]["category"])
 
     async def test_crud_default_patch(self, transactional_db, easy_api_client):

tests/test_auto_api_creation.py

@@ -1,3 +1,4 @@
+import pytest
 from ninja_extra.operation import AsyncOperation
 
 from easy import EasyAPI
@@ -34,31 +35,34 @@ def test_auto_generate_admin_api():
 
 async def test_auto_apis(transactional_db, user, easy_api_client):
     for controller_class in controllers:
-        if not str(controller_class).endswith("ClientAdminAPIController"):
-            continue
-        client = easy_api_client(controller_class, api_user=user, has_perm=True)
-        response = await client.get("/", data={}, json={}, user=user)
-        assert response.status_code == 403
+        if str(controller_class).endswith("ClientAdminAPIController"):
+            client = easy_api_client(controller_class, api_user=user, has_perm=True)
+            response = await client.get("/", data={}, json={}, user=user)
+            assert response.status_code == 403
 
-        client = easy_api_client(
-            controller_class, api_user=user, has_perm=True, is_staff=True
-        )
-        response = await client.get("/", data={}, json={}, user=user)
-        assert response.status_code == 200
-        assert response.json()["data"] == []
+            client = easy_api_client(
+                controller_class, api_user=user, has_perm=True, is_staff=True
+            )
+            response = await client.get("/", data={}, json={}, user=user)
+            assert response.status_code == 200
+            assert response.json()["data"] == []
 
-        client = easy_api_client(
-            controller_class, api_user=user, has_perm=True, is_staff=True
-        )
-        response = await client.delete("/20000")
-        assert response.status_code == 403
+            client = easy_api_client(
+                controller_class, api_user=user, has_perm=True, is_staff=True
+            )
+            response = await client.delete("/20000")
+            assert response.status_code == 403
 
-        client = easy_api_client(
-            controller_class, api_user=user, has_perm=True, is_staff=True
-        )
-        response = await client.delete("/20000", data={}, json={}, user=user)
-        assert response.status_code == 200
-        assert response.json()["code"] == 404
+            client = easy_api_client(
+                controller_class, api_user=user, has_perm=True, is_staff=True
+            )
+            response = await client.delete("/20000", data={}, json={}, user=user)
+            assert response.status_code == 200
+            assert response.json()["code"] == 404
+        elif str(controller_class).endswith("CategoryAdminAPIController"):
+            client = easy_api_client(controller_class, api_user=user, has_perm=True)
+            with pytest.raises(Exception):
+                await client.get("/", data={}, json={}, user=user)
 
 
 async def test_auto_generation_settings(settings):