drf-react-by-schema 0.29.2__tar.gz → 0.29.3__tar.gz

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: drf_react_by_schema
-Version: 0.29.2
+Version: 0.29.3
 Summary: A Django app to easily integrate with React from models.
 Home-page: https://gitlab.com/eita/drf-react-by-schema/drf-react-by-schema-django
 Author: Cooperativa EITA
@@ -164,7 +164,10 @@ Installation and quick start
        }
 
 4. Configure ``DRF_REACT_BY_SCHEMA``. The only required entry is the list of apps
-   whose models should get an endpoint (default ``['main']``):
+   whose models should get an endpoint (default ``['main']``). Each entry is an app
+   label (``'main'``) or a dotted module path (``'my_package.produtos'``) — the
+   dotted form lets a distribution ship its Django app nested inside its own
+   package instead of taking a top-level name:
 
    .. code-block:: python
 
@@ -222,9 +225,15 @@ Configuration reference
 ``DRF_REACT_BY_SCHEMA`` is the only settings block the package reads (via
 ``settings.get("DRF_REACT_BY_SCHEMA", {})``):
 
-* ``APPS`` (default ``["main"]``) — the Django app labels whose models get generated
-  serializers, viewsets and routes. Consumed by ``urls.py``, ``viewsets.py``,
-  ``serializers.py``, the autocomplete modules and ``sync_react``.
+* ``APPS`` (default ``["main"]``) — the apps whose models get generated
+  serializers, viewsets and routes. Each entry is an app label (``"main"``) or a
+  dotted module path (``"my_package.produtos"``); the dotted form lets a
+  distribution ship its Django app nested inside its own package instead of
+  occupying a top-level name. ``utils.resolve_apps()`` normalizes an entry to
+  ``(label, module_path)`` — the label keys ``apps.all_models`` and matches
+  ``Model._meta.app_label``, while the module path is imported as
+  ``<module>.viewsets`` / ``<module>.serializers``. Consumed by ``urls.py``,
+  ``viewsets.py``, ``serializers.py``, the autocomplete modules and ``sync_react``.
 * ``REACT_APP_DIR`` (default ``"frontend"``) — where ``sync_react`` writes
   ``src/drfReactBySchema/``, resolved as ``os.path.join(settings.BASE_DIR, REACT_APP_DIR)``.
 * ``PERMISSIONS`` — the permission source for the generated viewsets (and for

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/README.rst

@@ -131,7 +131,10 @@ Installation and quick start
        }
 
 4. Configure ``DRF_REACT_BY_SCHEMA``. The only required entry is the list of apps
-   whose models should get an endpoint (default ``['main']``):
+   whose models should get an endpoint (default ``['main']``). Each entry is an app
+   label (``'main'``) or a dotted module path (``'my_package.produtos'``) — the
+   dotted form lets a distribution ship its Django app nested inside its own
+   package instead of taking a top-level name:
 
    .. code-block:: python
 
@@ -189,9 +192,15 @@ Configuration reference
 ``DRF_REACT_BY_SCHEMA`` is the only settings block the package reads (via
 ``settings.get("DRF_REACT_BY_SCHEMA", {})``):
 
-* ``APPS`` (default ``["main"]``) — the Django app labels whose models get generated
-  serializers, viewsets and routes. Consumed by ``urls.py``, ``viewsets.py``,
-  ``serializers.py``, the autocomplete modules and ``sync_react``.
+* ``APPS`` (default ``["main"]``) — the apps whose models get generated
+  serializers, viewsets and routes. Each entry is an app label (``"main"``) or a
+  dotted module path (``"my_package.produtos"``); the dotted form lets a
+  distribution ship its Django app nested inside its own package instead of
+  occupying a top-level name. ``utils.resolve_apps()`` normalizes an entry to
+  ``(label, module_path)`` — the label keys ``apps.all_models`` and matches
+  ``Model._meta.app_label``, while the module path is imported as
+  ``<module>.viewsets`` / ``<module>.serializers``. Consumed by ``urls.py``,
+  ``viewsets.py``, ``serializers.py``, the autocomplete modules and ``sync_react``.
 * ``REACT_APP_DIR`` (default ``"frontend"``) — where ``sync_react`` writes
   ``src/drfReactBySchema/``, resolved as ``os.path.join(settings.BASE_DIR, REACT_APP_DIR)``.
 * ``PERMISSIONS`` — the permission source for the generated viewsets (and for

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/autocomplete_serializers.py

@@ -2,6 +2,7 @@ from django.apps import apps
 from django.core.exceptions import ImproperlyConfigured
 from rest_framework import serializers
 from . import settings
+from .utils import resolve_apps
 
 # Field-level kwargs configuring the inline formset rendered for a declared
 # writable nested serializer (see ``Metadata``). DRF would otherwise forward them
@@ -106,7 +107,7 @@ class GenericAutocompleteSerializer(serializers.ModelSerializer):
 
 ######################
 
-for app in settings["APPS"]:
+for app, _app_module in resolve_apps():
     for name, model in apps.all_models[app].items():
         model_name = model.__name__
         if isinstance(model, type):

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/autocomplete_viewsets.py

@@ -5,15 +5,18 @@ from django.core.exceptions import FieldDoesNotExist
 from rest_framework import serializers as drf_serializers
 
 from . import settings, autocomplete_serializers, viewsets
-from .utils import camel_to_snake, to_pascal_case
+from .utils import camel_to_snake, resolve_apps, to_pascal_case
 
 # ``settings`` is ``django.conf.settings.__dict__`` (see the package ``__init__``):
 # ``override_settings`` clears that dict when it swaps ``_wrapped``, so the apps
 # list is snapshotted here (as the generation loop below already implicitly is).
-_APPS = tuple(settings["APPS"])
+# Entries are normalized to ``(label, module_path)`` pairs; see
+# ``utils.resolve_app_entry``.
+_APP_ENTRIES = tuple(resolve_apps())
+_APPS = tuple(label for label, _module in _APP_ENTRIES)
 
 
-for app in _APPS:
+for app, app_module in _APP_ENTRIES:
     for name, model in apps.all_models[app].items():
         model_name = model.__name__
         if isinstance(model, type):
@@ -25,6 +28,7 @@ for app in _APPS:
                     {
                         "model_name": model_name,
                         "app": app,
+                        "app_module": app_module,
                         "serializer_class": getattr(
                             autocomplete_serializers, f"{model_name}Serializer"
                         ),
@@ -65,9 +69,9 @@ def _iter_serializer_classes():
     from . import serializers as generated_serializers
 
     modules = [generated_serializers]
-    for app in _APPS:
+    for _label, app_module in _APP_ENTRIES:
         try:
-            modules.append(importlib.import_module(f"{app}.serializers"))
+            modules.append(importlib.import_module(f"{app_module}.serializers"))
         except ImportError:
             pass
 

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/checks.py

@@ -28,8 +28,12 @@ def _first_geometry_field(model):
 def geodjango_libraries_available(app_configs, **kwargs):
     from django.conf import settings
 
+    from .utils import resolve_apps
+
     drf_settings = getattr(settings, "DRF_REACT_BY_SCHEMA", {}) or {}
-    app_labels = drf_settings.get("APPS", ["main"])
+    app_labels = [
+        label for label, _module in resolve_apps(drf_settings.get("APPS", ["main"]))
+    ]
 
     for app_label in app_labels:
         try:

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/serializers.py

@@ -27,6 +27,7 @@ from .utils import (
     fill_required_related_ids,
     is_tmp_id,
     register_nested_write,
+    resolve_apps,
     update_related_fields,
 )
 
@@ -942,7 +943,7 @@ def list_serializer_for(detail_class):
 ######################
 
 
-for app in settings["APPS"]:
+for app, _app_module in resolve_apps():
     for name, model in apps.all_models[app].items():
         model_name = model.__name__
         if isinstance(model, type):

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/tests.py

@@ -18,11 +18,11 @@ class NonEditableRelatedFieldTest(TestCase):
     def test_non_editable_related_fields_listed_but_not_written(self):
         from django.apps import apps
 
-        from drf_react_by_schema import settings
         from drf_react_by_schema import serializers as pkg_serializers
+        from drf_react_by_schema.utils import resolve_apps
 
         checked = 0
-        for app in settings["APPS"]:
+        for app, _app_module in resolve_apps():
             for model in apps.all_models[app].values():
                 if not isinstance(model, type):
                     continue

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/urls.py

@@ -4,8 +4,7 @@ from rest_framework_nested import routers
 import importlib
 import traceback
 
-from . import settings
-from .utils import camel_to_snake
+from .utils import camel_to_snake, resolve_apps
 from .views import SchemaBundleView, UploadView
 from .viewsets import __nested_viewsets__
 
@@ -15,9 +14,9 @@ nested_routers = {}
 
 modules = []
 autocomplete_modules = []
-for app in settings["APPS"]:
-    modules.append(f"{app}.viewsets")
-    autocomplete_modules.append(f"{app}.autocomplete_viewsets")
+for _label, app_module in resolve_apps():
+    modules.append(f"{app_module}.viewsets")
+    autocomplete_modules.append(f"{app_module}.autocomplete_viewsets")
 modules.append("drf_react_by_schema.viewsets")
 autocomplete_modules.append("drf_react_by_schema.autocomplete_viewsets")
 

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/utils.py

@@ -376,6 +376,43 @@ def get_model(app, model_name):
     return apps.get_model(app_label=app, model_name=model_name)
 
 
+def resolve_app_entry(entry):
+    """Normalize one ``DRF_REACT_BY_SCHEMA["APPS"]`` entry.
+
+    An entry is either an app label (``"main"``) or a dotted module path
+    (``"eita_balaio.produtos"``). The dotted form lets a distribution ship its
+    Django app nested inside its own package instead of occupying a top-level
+    name; Django only requires the app *label* to be a bare identifier.
+
+    Returns ``(label, module_path)``. The label keys ``apps.all_models`` and
+    matches ``Model._meta.app_label``; the module path is what gets imported as
+    ``<module_path>.viewsets`` / ``<module_path>.serializers`` /
+    ``<module_path>.autocomplete_viewsets``.
+    """
+    if "." not in entry:
+        return entry, entry
+    app_config = apps.get_containing_app_config(entry)
+    if app_config is not None:
+        return app_config.label, app_config.name
+    # Not an installed app (typo, or installed under another name): fall back to
+    # the conventional label so the caller's import fails the same way a bad
+    # plain label would.
+    return entry.rpartition(".")[2], entry
+
+
+def resolve_apps(entries=None):
+    """``[(label, module_path), ...]`` for the configured apps.
+
+    ``entries`` defaults to the package's ``settings["APPS"]`` (the list injected
+    from ``DRF_REACT_BY_SCHEMA`` at import time).
+    """
+    if entries is None:
+        from . import settings
+
+        entries = settings.get("APPS", ["main"])
+    return [resolve_app_entry(entry) for entry in entries]
+
+
 def camel_to_snake(name, suffix=None):
     if suffix:
         name = name.removesuffix(suffix)

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema/viewsets.py

@@ -52,6 +52,11 @@ class DRFReactBySchemaBaseModelViewSet(
     serializer_list_class = None
     model = None
     app = None
+    #: Import path for ``<module>.viewsets``/``<module>.serializers``. Differs
+    #: from ``app`` only when the app is configured by a dotted module path
+    #: (``eita_balaio.produtos`` -> label ``produtos``); see
+    #: ``utils.resolve_app_entry``.
+    app_module = None
     model_name = None
     many = True
     reverse_many = False
@@ -80,7 +85,8 @@ class DRFReactBySchemaBaseModelViewSet(
         super().__init__(*args, **kwargs)
         if not self.model and self.model_name:
             self.model = utils.get_model(self.app, self.model_name)
-        if self.app and self.serializer_class is not None:
+        app_module = self.app_module or self.app
+        if app_module and self.serializer_class is not None:
             module_name = (
                 "autocomplete_serializers"
                 if self.is_autocomplete
@@ -88,7 +94,7 @@ class DRFReactBySchemaBaseModelViewSet(
             )
             try:
                 app_serializers = importlib.import_module(
-                    f"{self.app}.{module_name}"
+                    f"{app_module}.{module_name}"
                 )
             except ImportError:
                 return
@@ -768,7 +774,7 @@ class PasswordResetViewSet(viewsets.ViewSet):
 ##########################
 __nested_viewsets__ = []
 
-for app in settings["APPS"]:
+for app, app_module in utils.resolve_apps():
     for name, model in apps.all_models[app].items():
         model_name = model.__name__
         if isinstance(model, type):
@@ -780,6 +786,7 @@ for app in settings["APPS"]:
                     {
                         "model_name": model_name,
                         "app": app,
+                        "app_module": app_module,
                         "serializer_class": getattr(
                             serializers, f"{model_name}Serializer"
                         ),
@@ -810,6 +817,7 @@ for app in settings["APPS"]:
                                 {
                                     "model": field.related_model,
                                     "app": app,
+                                    "app_module": app_module,
                                     "serializer_class": getattr(
                                         serializers, f"{related_model_name}Serializer"
                                     ),
@@ -829,7 +837,7 @@ for app in settings["APPS"]:
 class EndpointsViewSet(viewsets.ViewSet):
     def list(self, request):
         endpoints = []
-        for app in settings["APPS"]:
+        for app, _app_module in utils.resolve_apps():
             for name, model in apps.all_models[app].items():
                 endpoint = {
                     "model_name": utils.camel_to_snake(model.__name__),

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/drf_react_by_schema.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: drf-react-by-schema
-Version: 0.29.2
+Version: 0.29.3
 Summary: A Django app to easily integrate with React from models.
 Home-page: https://gitlab.com/eita/drf-react-by-schema/drf-react-by-schema-django
 Author: Cooperativa EITA
@@ -164,7 +164,10 @@ Installation and quick start
        }
 
 4. Configure ``DRF_REACT_BY_SCHEMA``. The only required entry is the list of apps
-   whose models should get an endpoint (default ``['main']``):
+   whose models should get an endpoint (default ``['main']``). Each entry is an app
+   label (``'main'``) or a dotted module path (``'my_package.produtos'``) — the
+   dotted form lets a distribution ship its Django app nested inside its own
+   package instead of taking a top-level name:
 
    .. code-block:: python
 
@@ -222,9 +225,15 @@ Configuration reference
 ``DRF_REACT_BY_SCHEMA`` is the only settings block the package reads (via
 ``settings.get("DRF_REACT_BY_SCHEMA", {})``):
 
-* ``APPS`` (default ``["main"]``) — the Django app labels whose models get generated
-  serializers, viewsets and routes. Consumed by ``urls.py``, ``viewsets.py``,
-  ``serializers.py``, the autocomplete modules and ``sync_react``.
+* ``APPS`` (default ``["main"]``) — the apps whose models get generated
+  serializers, viewsets and routes. Each entry is an app label (``"main"``) or a
+  dotted module path (``"my_package.produtos"``); the dotted form lets a
+  distribution ship its Django app nested inside its own package instead of
+  occupying a top-level name. ``utils.resolve_apps()`` normalizes an entry to
+  ``(label, module_path)`` — the label keys ``apps.all_models`` and matches
+  ``Model._meta.app_label``, while the module path is imported as
+  ``<module>.viewsets`` / ``<module>.serializers``. Consumed by ``urls.py``,
+  ``viewsets.py``, ``serializers.py``, the autocomplete modules and ``sync_react``.
 * ``REACT_APP_DIR`` (default ``"frontend"``) — where ``sync_react`` writes
   ``src/drfReactBySchema/``, resolved as ``os.path.join(settings.BASE_DIR, REACT_APP_DIR)``.
 * ``PERMISSIONS`` — the permission source for the generated viewsets (and for

{drf_react_by_schema-0.29.2 → drf_react_by_schema-0.29.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = drf_react_by_schema
-version = 0.29.2
+version = 0.29.3
 description = A Django app to easily integrate with React from models.
 long_description = file: README.rst
 long_description_content_type = text/x-rst