refactor: Meta -> APIMeta

Author: freemindcore

README.md

@@ -88,7 +88,7 @@ Apps in the `CRUD_API_EXCLUDE_APPS` list, will be always excluded.
 
 If `CRUD_API_ENABLED_ALL_APPS` is set to False, only apps in the `CRUD_API_INCLUDE_APPS` list will have CRUD apis generated.
 
-Also, configuration is possible for each model, via ApiMeta class:
+Also, configuration is possible for each model, via APIMeta class:
 - `generate_crud`:      whether to create crud api, default to True
 - `model_exclude`:      fields to be excluded in Schema
 - `model_fields`:       fields to be included in Schema, default to `"__all__"`
@@ -102,7 +102,7 @@ class Category(TestBaseModel):
     title = models.CharField(max_length=100)
     status = models.PositiveSmallIntegerField(default=1, null=True)
 
-    class ApiMeta:
+    class APIMeta:
         generate_crud = True
         model_fields = ["field_1", "field_2",] # if not configured default to "__all__"
         model_join = True
@@ -112,7 +112,7 @@ class Category(TestBaseModel):
 
 ### Adding CRUD APIs to a specific API Controller
 By inheriting `CrudAPIController` class, CRUD APIs can be added to any API controller.
-Configuration is available via `Meta` inner class in your Controller, same as the above `ApiMeta` inner class defined in your Django models.
+Configuration is available via `APIMeta` inner class in your Controller, same as the above `APIMeta` inner class defined in your Django models.
 
 Example:
 
@@ -122,7 +122,7 @@ class EventAPIController(CrudAPIController):
     def __init__(self, service: EventService):
         super().__init__(service)
 
-    class Meta:
+    class APIMeta:
         model = Event # django model
         generate_crud = True # whether to create crud api, default to True
         model_fields = ["field_1", "field_2",] # if not configured default to "__all__"

easy/controller/auto_api.py

@@ -30,11 +30,11 @@ def create_api_controller(
     model_name = model.__name__  # type:ignore
 
     model_opts: ModelOptions = ModelOptions.get_model_options(
-        getattr(model, "ApiMeta", None)
+        getattr(model, "APIMeta", None)
     )
 
-    Meta = type(
-        "Meta",
+    APIMeta = type(
+        "APIMeta",
         (object,),
         {
             "model": model,
@@ -54,7 +54,7 @@ def create_api_controller(
         class_name,
         (CrudAPIController,),
         {
-            "Meta": Meta,
+            "APIMeta": APIMeta,
         },
     )
 

easy/controller/base.py

@@ -1,13 +1,13 @@
 import logging
 
-from easy.controller.meta import CrudApiMetaclass
+from easy.controller.meta import CrudAPIMetaclass
 
 logger = logging.getLogger(__name__)
 
 
-class CrudAPIController(metaclass=CrudApiMetaclass):
+class CrudAPIController(metaclass=CrudAPIMetaclass):
     """
-    Base APIController for auto creating CRUD APIs, configurable via Meta class
+    Base APIController for auto creating CRUD APIs, configurable via APIMeta class
     APIs auto generated:
         Creat
             PUT /{id}       - Create a single Object
@@ -32,7 +32,7 @@ class CrudAPIController(metaclass=CrudApiMetaclass):
         sensitive_fields:   fields to be ignored
 
     Example:
-        class Meta
+        class APIMeta
             model = Event
             generate_crud = False
             model_exclude = ["field1", "field2"]

easy/controller/meta.py

@@ -27,7 +27,7 @@ def __init__(self, service=None):  # type: ignore
         # Critical to set __Meta
         self.service = service
 
-        _model_opts: ModelOptions = ModelOptions.get_model_options(self.Meta)
+        _model_opts: ModelOptions = ModelOptions.get_model_options(self.APIMeta)
         if self.model and _model_opts:
             ModelOptions.set_model_meta(self.model, _model_opts)
 
@@ -36,10 +36,10 @@ def __init__(self, service=None):  # type: ignore
         super().__init__(model=self.model)
 
 
-class CrudApiMetaclass(ABCMeta):
+class CrudAPIMetaclass(ABCMeta):
     def __new__(mcs, name: str, bases: Tuple[Type[Any], ...], attrs: dict) -> Any:
-        # Get configs from Meta
-        attrs_meta = attrs.get("Meta", None)
+        # Get configs from APIMeta
+        attrs_meta = attrs.get("APIMeta", None)
         model_opts: ModelOptions = ModelOptions.get_model_options(attrs_meta)
 
         # Get all attrs from parents excluding private ones

easy/domain/meta.py

@@ -3,7 +3,7 @@
 
 
 class CrudModel(object):
-    Meta: Dict = {}
+    APIMeta: Dict = {}
 
     def __init__(self, model: Any):
         self.model = model

tests/easy_app/controllers.py

@@ -28,7 +28,7 @@ class AutoGenCrudAPIController(CrudAPIController):
     def __init__(self, service: EventService):
         super().__init__(service)
 
-    class Meta:
+    class APIMeta:
         model = Event
         model_join = True
 
@@ -42,7 +42,7 @@ class RecursiveAPIController(CrudAPIController):
     def __init__(self, service: EventService):
         super().__init__(service)
 
-    class Meta:
+    class APIMeta:
         model = Event
         model_fields = "__all__"
         model_join = True
@@ -58,7 +58,7 @@ class InheritedRecursiveAPIController(AutoGenCrudAPIController):
     def __init__(self, service: EventService):
         super().__init__(service)
 
-    class Meta:
+    class APIMeta:
         model = Event
         model_fields = "__all__"
         model_join = True
@@ -74,7 +74,7 @@ class AutoGenCrudNoJoinAPIController(CrudAPIController):
     def __init__(self, service: EventService):
         super().__init__(service)
 
-    class Meta:
+    class APIMeta:
         model = Event
         model_fields = "__all__"
         model_join = False
@@ -88,7 +88,7 @@ class AutoGenCrudSomeFieldsAPIController(CrudAPIController):
     For unit testings of the no-m2m-fields model
     """
 
-    class Meta:
+    class APIMeta:
         model = Client
         model_fields = [
             "key",
@@ -105,7 +105,7 @@ class EasyCrudAPIController(CrudAPIController):
     def __init__(self, service: EventService):
         super().__init__(service)
 
-    class Meta:
+    class APIMeta:
         model = Event
         model_exclude = [
             "category",
@@ -149,7 +149,7 @@ def __init__(self, service: EventService):
         super().__init__(service)
         self.service = service
 
-    class Meta:
+    class APIMeta:
         model = Event
 
     @http_get("/must_be_authenticated/", permissions=[IsAuthenticated])
@@ -189,7 +189,7 @@ def __init__(self, service: EventService):
         super().__init__(service)
         self.service = service
 
-    class Meta:
+    class APIMeta:
         model = Event
 
 
@@ -203,7 +203,7 @@ def __init__(self, service: EventService):
         super().__init__(service)
         self.service = service
 
-    class Meta:
+    class APIMeta:
         model = Event
         generate_crud = False
 
@@ -218,7 +218,7 @@ def __init__(self, service: EventService):
         super().__init__(service)
         self.service = service
 
-    class Meta:
+    class APIMeta:
         model = Event
         generate_crud = False
         model_exclude = [

tests/easy_app/models.py

@@ -10,7 +10,7 @@ class Category(TestBaseModel):
     title = models.CharField(max_length=100)
     status = models.PositiveSmallIntegerField(default=1, null=True)
 
-    class ApiMeta:
+    class APIMeta:
         generate_crud = False