Merge pull request #315 from eadwinCode/chores_22_nove

chores: Refactored Url Namespace and Unique Route Operation Id

Author: eadwinCode

docs/api_controller/index.md

@@ -45,7 +45,7 @@ The fifth argument, `auto_import`, defaults to true, which automatically adds yo
 
 The sixth argument, `urls_namespace`, defaults to `Controller Class Name`, or if set will nest the routes of this controller under their own namespace.
 
-The seventh argument, `append_unique_op_id`, defaults to true, which appends a unique operation id suffix to the controller's routes to avoid conflicts.
+The seventh argument, `use_unique_op_id`, defaults to true, which appends a unique operation id suffix to the controller's routes to avoid conflicts.
 
 for example:
 

ninja_extra/controllers/base.py

@@ -404,7 +404,7 @@ def __init__(
         permissions: Optional[List[BasePermissionType]] = None,
         auto_import: bool = True,
         urls_namespace: Optional[str] = None,
-        append_unique_op_id: bool = True
+        use_unique_op_id: bool = True,
     ) -> None:
         self.prefix = prefix
         # Optional controller-level URL namespace. Applied to all route paths.
@@ -414,7 +414,7 @@ def __init__(
 
         self.tags = tags  # type: ignore
         self.throttle = throttle
-        self.append_unique_op_id = append_unique_op_id
+        self.use_unique_op_id = use_unique_op_id
 
         self.auto_import: bool = auto_import  # set to false and it would be ignored when api.auto_discover is called
         # `controller_class` target class that the APIController wraps
@@ -496,11 +496,14 @@ def __call__(self, cls: ControllerClassType) -> ControllerClassType:
                 item(**throttling_init_kwargs) for item in cls.throttling_classes
             ]
 
+        class_name = str(cls.__name__).lower().replace("controller", "")
         if not self.tags:
-            tag = str(cls.__name__).lower().replace("controller", "")
-            self.tags = [tag]
+            self.tags = [class_name]
 
         self._controller_class = cls
+        if not self.urls_namespace:
+            # if urls_namespace is not provided, use the class name as the namespace
+            self.urls_namespace = class_name
 
         if issubclass(cls, ModelControllerBase):
             if cls.model_config:
@@ -560,6 +563,7 @@ def add_controller_route_function(self, route_function: RouteFunction) -> None:
 
     def urls_paths(self, prefix: str) -> Iterator[Union[URLPattern, URLResolver]]:
         namespaced_patterns: List[URLPattern] = []
+        assert self.urls_namespace, "urls_namespace is required"
 
         for path, path_view in self.path_operations.items():
             path = path.replace("{", "<").replace("}", ">")
@@ -576,15 +580,15 @@ def urls_paths(self, prefix: str) -> Iterator[Union[URLPattern, URLResolver]]:
                 else:
                     pattern = django_path(route, view)
 
-                if self.urls_namespace:
-                    namespaced_patterns.append(pattern)
-                else:
-                    yield pattern
+                namespaced_patterns.append(pattern)
 
-        if self.urls_namespace and namespaced_patterns:
+        if namespaced_patterns:
             yield django_path(
                 "",
-                include((namespaced_patterns, self.urls_namespace), namespace=self.urls_namespace),
+                include(
+                    (namespaced_patterns, self.urls_namespace),
+                    namespace=self.urls_namespace,
+                ),
             )
 
     def __repr__(self) -> str:  # pragma: no cover
@@ -602,7 +606,7 @@ def _add_operation_from_route_function(self, route_function: RouteFunction) -> N
             route_function.route.route_params.operation_id = (
                 f"{controller_name}_{route_function.route.view_func.__name__}"
             )
-            if self.append_unique_op_id:
+            if self.use_unique_op_id:
                 route_function.route.route_params.operation_id += (
                     f"_{uuid.uuid4().hex[:8]}"
                 )
@@ -695,7 +699,7 @@ def api_controller(
     permissions: Optional[List[BasePermissionType]] = None,
     auto_import: bool = True,
     urls_namespace: Optional[str] = None,
-    append_unique_op_id: bool = True,
+    use_unique_op_id: bool = True,
 ) -> Callable[
     [Union[Type, Type[T]]], Union[Type[ControllerBase], Type[T]]
 ]:  # pragma: no cover
@@ -710,7 +714,7 @@ def api_controller(
     permissions: Optional[List[BasePermissionType]] = None,
     auto_import: bool = True,
     urls_namespace: Optional[str] = None,
-    append_unique_op_id: bool = True,
+    use_unique_op_id: bool = True,
 ) -> Union[ControllerClassType, Callable[[ControllerClassType], ControllerClassType]]:
     if isinstance(prefix_or_class, type):
         return APIController(
@@ -720,7 +724,7 @@ def api_controller(
             permissions=permissions,
             auto_import=auto_import,
             throttle=throttle,
-            append_unique_op_id=append_unique_op_id,
+            use_unique_op_id=use_unique_op_id,
             urls_namespace=urls_namespace,
         )(prefix_or_class)
 
@@ -732,7 +736,7 @@ def _decorator(cls: ControllerClassType) -> ControllerClassType:
             permissions=permissions,
             auto_import=auto_import,
             throttle=throttle,
-            append_unique_op_id=append_unique_op_id,
+            use_unique_op_id=use_unique_op_id,
             urls_namespace=urls_namespace,
         )(cls)
 

tests/test_controller.py

@@ -75,7 +75,7 @@ def example(self):
         pass
 
 
-@api_controller(append_unique_op_id=False)
+@api_controller(use_unique_op_id=False)
 class SomeControllerWithoutUniqueSuffix:
     @http_get("/example")
     def example(self):
@@ -373,8 +373,11 @@ def test_namespaced_controller_detail(client):
     response = client.get("/api/inventory-items/5")
     assert response.status_code == 200
     assert response.json() == {"id": 5, "name": "sample-5"}
-    assert reverse("api-1.0.0:inventory:inventory-item-detail", kwargs={"item_id": 5}) == "/api/inventory-items/5"
+    assert (
+        reverse("api-1.0.0:inventory:inventory-item-detail", kwargs={"item_id": 5})
+        == "/api/inventory-items/5"
+    )
 
 
 def test_default_url_name(client):
-    assert reverse("api-1.0.0:get_event", kwargs={"id": 5}) == "/api/events/5"
+    assert reverse("api-1.0.0:event:get_event", kwargs={"id": 5}) == "/api/events/5"

tests/test_django_model.py

@@ -26,9 +26,9 @@ def test_with_client(client: Client):
 
 def test_reverse():
     # check that url reversing works
-    assert reverse("api-1.0.0:event-create-url-name") == "/api/events"
-    assert reverse("api-1.0.0:event-list") == "/api/events"
-    assert reverse("api-1.0.0:event-list-2") == "/api/events/list"
+    assert reverse("api-1.0.0:event:event-create-url-name") == "/api/events"
+    assert reverse("api-1.0.0:event:event-list") == "/api/events"
+    assert reverse("api-1.0.0:event:event-list-2") == "/api/events/list"
 
 
 def json_payload(data):