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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/PKG-INFO +1 -1
  2. drf_react_by_schema-0.29.2/drf_react_by_schema/autocomplete_viewsets.py +135 -0
  3. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema.egg-info/PKG-INFO +1 -1
  4. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/setup.cfg +1 -1
  5. drf_react_by_schema-0.29.1/drf_react_by_schema/autocomplete_viewsets.py +0 -22
  6. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/LICENSE +0 -0
  7. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/MANIFEST.in +0 -0
  8. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/README.rst +0 -0
  9. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/__init__.py +0 -0
  10. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/admin.py +0 -0
  11. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/apps.py +0 -0
  12. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/auth.py +0 -0
  13. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/autocomplete_serializers.py +0 -0
  14. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/checks.py +0 -0
  15. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/date_utils.py +0 -0
  16. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/__init__.py +0 -0
  17. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/array.py +0 -0
  18. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/boolean.py +0 -0
  19. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/date.py +0 -0
  20. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/file.py +0 -0
  21. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/geometry.py +0 -0
  22. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/number.py +0 -0
  23. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/relational.py +0 -0
  24. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/serializers.py +0 -0
  25. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/fields/text.py +0 -0
  26. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/filters.py +0 -0
  27. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/management/__init__.py +0 -0
  28. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/management/commands/__init__.py +0 -0
  29. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/management/commands/sync_react.py +0 -0
  30. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/metadata.py +0 -0
  31. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/migrations/0001_initial.py +0 -0
  32. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/migrations/__init__.py +0 -0
  33. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/mixins.py +0 -0
  34. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/models.py +0 -0
  35. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/pagination.py +0 -0
  36. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/patches/__init__.py +0 -0
  37. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/patches/drf_serializers.py +0 -0
  38. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/renderers.py +0 -0
  39. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/schema_bundle.py +0 -0
  40. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/serializers.py +0 -0
  41. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/tests.py +0 -0
  42. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/typescript_generator.py +0 -0
  43. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/urls.py +0 -0
  44. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/utils.py +0 -0
  45. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/utils_cache.py +0 -0
  46. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/views.py +0 -0
  47. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema/viewsets.py +0 -0
  48. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema.egg-info/SOURCES.txt +0 -0
  49. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema.egg-info/dependency_links.txt +0 -0
  50. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema.egg-info/requires.txt +0 -0
  51. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/drf_react_by_schema.egg-info/top_level.txt +0 -0
  52. {drf_react_by_schema-0.29.1 → drf_react_by_schema-0.29.2}/setup.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: drf_react_by_schema
3
- Version: 0.29.1
3
+ Version: 0.29.2
4
4
  Summary: A Django app to easily integrate with React from models.
5
5
  Home-page: https://gitlab.com/eita/drf-react-by-schema/drf-react-by-schema-django
6
6
  Author: Cooperativa EITA
@@ -0,0 +1,135 @@
1
+ import importlib
2
+
3
+ from django.apps import apps
4
+ from django.core.exceptions import FieldDoesNotExist
5
+ from rest_framework import serializers as drf_serializers
6
+
7
+ from . import settings, autocomplete_serializers, viewsets
8
+ from .utils import camel_to_snake, to_pascal_case
9
+
10
+ # ``settings`` is ``django.conf.settings.__dict__`` (see the package ``__init__``):
11
+ # ``override_settings`` clears that dict when it swaps ``_wrapped``, so the apps
12
+ # list is snapshotted here (as the generation loop below already implicitly is).
13
+ _APPS = tuple(settings["APPS"])
14
+
15
+
16
+ for app in _APPS:
17
+ for name, model in apps.all_models[app].items():
18
+ model_name = model.__name__
19
+ if isinstance(model, type):
20
+ viewset_name = f"{model_name}ViewSet"
21
+ if viewset_name not in globals():
22
+ generated_class = type(
23
+ viewset_name,
24
+ (viewsets.GenericAutocompleteViewSet,),
25
+ {
26
+ "model_name": model_name,
27
+ "app": app,
28
+ "serializer_class": getattr(
29
+ autocomplete_serializers, f"{model_name}Serializer"
30
+ ),
31
+ },
32
+ )
33
+ globals()[viewset_name] = generated_class
34
+
35
+
36
+ def _is_nested_field(field):
37
+ """Whether a declared serializer field exposes a related model (a relation).
38
+
39
+ Nested model serializers (FK/M2M/O2O and declared reverse relations) are
40
+ ``BaseSerializer`` instances; ``NestedSerializerMethodField`` wraps a
41
+ serializer class in ``serializer_class``. Plain scalars and ``source``-based
42
+ ``CharField``s are not relations and carry no autocomplete route.
43
+ """
44
+ return isinstance(field, drf_serializers.BaseSerializer) or hasattr(
45
+ field, "serializer_class"
46
+ )
47
+
48
+
49
+ def _related_model(serializer_model, field_name):
50
+ """The related model of ``field_name`` on ``serializer_model``, if any."""
51
+ try:
52
+ model_field = serializer_model._meta.get_field(field_name)
53
+ except FieldDoesNotExist:
54
+ return None
55
+ return getattr(model_field, "related_model", None)
56
+
57
+
58
+ def _iter_serializer_classes():
59
+ """Serializer classes whose model belongs to the configured apps.
60
+
61
+ Covers the package-generated serializers (whose forward relations are
62
+ auto-populated) and the app's own ``serializers`` module (which declares the
63
+ reverse relations rendered as nested/inline serializers).
64
+ """
65
+ from . import serializers as generated_serializers
66
+
67
+ modules = [generated_serializers]
68
+ for app in _APPS:
69
+ try:
70
+ modules.append(importlib.import_module(f"{app}.serializers"))
71
+ except ImportError:
72
+ pass
73
+
74
+ seen = set()
75
+ for module in modules:
76
+ for obj in vars(module).values():
77
+ if not isinstance(obj, type) or obj in seen:
78
+ continue
79
+ seen.add(obj)
80
+ yield obj
81
+
82
+
83
+ def generate_field_name_viewsets(serializer_classes):
84
+ """Autocomplete viewsets named after the relation field they serve.
85
+
86
+ The React client asks ``/autocomplete/<field>/`` using the serializer field
87
+ name, but the package only registers ``/autocomplete/<model>/``. A relation
88
+ field whose name differs from its related model — a reverse FK/M2M/O2O with a
89
+ custom ``related_name`` (``projetos`` for ``Projeto``), or a forward FK named
90
+ differently (``responsavel`` for ``Pessoa``) — therefore has no route and had
91
+ to be declared by hand in the consuming app.
92
+
93
+ This derives that route from the related model's autocomplete viewset, so its
94
+ ``serializer_class`` and configuration are inherited. An app-defined viewset
95
+ of the same name still wins: the app's ``autocomplete_viewsets`` module is
96
+ registered first and the router skips an already-registered basename.
97
+ """
98
+ for serializer_class in serializer_classes:
99
+ meta = getattr(serializer_class, "Meta", None)
100
+ serializer_model = getattr(meta, "model", None)
101
+ if (
102
+ serializer_model is None
103
+ or serializer_model._meta.app_label not in _APPS
104
+ ):
105
+ continue
106
+
107
+ for field_name, field in getattr(
108
+ serializer_class, "_declared_fields", {}
109
+ ).items():
110
+ if not _is_nested_field(field):
111
+ continue
112
+ related_model = _related_model(serializer_model, field_name)
113
+ if (
114
+ related_model is None
115
+ or related_model._meta.app_label not in _APPS
116
+ ):
117
+ continue
118
+ # The related model's own route already serves this name.
119
+ if camel_to_snake(related_model.__name__) == field_name:
120
+ continue
121
+
122
+ base_viewset = globals().get(f"{related_model.__name__}ViewSet")
123
+ if base_viewset is None:
124
+ continue
125
+ viewset_name = f"{to_pascal_case(field_name)}ViewSet"
126
+ if viewset_name in globals():
127
+ continue
128
+ globals()[viewset_name] = type(
129
+ viewset_name,
130
+ (base_viewset,),
131
+ {"__module__": __name__},
132
+ )
133
+
134
+
135
+ generate_field_name_viewsets(_iter_serializer_classes())
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: drf-react-by-schema
3
- Version: 0.29.1
3
+ Version: 0.29.2
4
4
  Summary: A Django app to easily integrate with React from models.
5
5
  Home-page: https://gitlab.com/eita/drf-react-by-schema/drf-react-by-schema-django
6
6
  Author: Cooperativa EITA
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = drf_react_by_schema
3
- version = 0.29.1
3
+ version = 0.29.2
4
4
  description = A Django app to easily integrate with React from models.
5
5
  long_description = file: README.rst
6
6
  long_description_content_type = text/x-rst
@@ -1,22 +0,0 @@
1
- from django.apps import apps
2
-
3
- from . import settings, autocomplete_serializers, viewsets
4
-
5
- for app in settings["APPS"]:
6
- for name, model in apps.all_models[app].items():
7
- model_name = model.__name__
8
- if isinstance(model, type):
9
- viewset_name = f"{model_name}ViewSet"
10
- if viewset_name not in globals():
11
- generated_class = type(
12
- viewset_name,
13
- (viewsets.GenericAutocompleteViewSet,),
14
- {
15
- "model_name": model_name,
16
- "app": app,
17
- "serializer_class": getattr(
18
- autocomplete_serializers, f"{model_name}Serializer"
19
- ),
20
- },
21
- )
22
- globals()[viewset_name] = generated_class