feat(serializer): support dynamicly set fields on serializer

Author: cursor12345

.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+exclude: "^docs/|/migrations/"
+default_stages: [commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-ast
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: mixed-line-ending
+      - id: detect-private-key
+      - id: debug-statements
+      - id: check-yaml
+      - id: check-toml
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.28.0
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.34.0
+    hooks:
+      - id: pyupgrade
+        args: [--py39-plus]
+
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        args: [--config=pyproject.toml]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        args: [--settings-path=pyproject.toml]
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        args: ["--config=setup.cfg"]
+        additional_dependencies: [flake8-isort]
+
+# sets up .pre-commit-ci.yaml to ensure pre-commit dependencies stay up to date
+ci:
+  autoupdate_schedule: weekly
+  skip: []
+  submodules: false

drfexts/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '0.13.0'

drfexts/filtersets/backends.py

@@ -107,8 +107,6 @@ def get_filterset_class(self, view, queryset=None):
         filterset_class = getattr(view, 'filterset_class', None)
         filterset_fields_overwrite = getattr(view, 'filterset_fields_overwrite', {})
 
-        # full text search
-
         if filterset_class:
             filterset_model = filterset_class._meta.model  # noqa
 
@@ -131,42 +129,52 @@ def get_filterset_class(self, view, queryset=None):
         overwrite_fields = {k: v for k, v in filterset_fields_overwrite.items() if isinstance(v, Filter)}
         overwrite_kwargs = {k: v for k, v in filterset_fields_overwrite.items() if isinstance(v, dict)}
 
-        for filter_name, field in serializer.fields.items():
-            if (
-                getattr(field, "write_only", False)
-                or field.source == "*"
-                or isinstance(field, serializers.BaseSerializer)
-            ):
-                continue
+        def filters_from_serializer(_serializer, field_name_prefix='', filter_name_prefix=''):
+            if isinstance(_serializer, serializers.ListSerializer):
+                _serializer = _serializer.child
 
-            field_name = field.source.replace(".", "__") or filter_name
-            if get_model_field(filterset_model, field_name) is None and (
-                queryset is not None and filter_name not in queryset.query.annotations
-            ):
-                continue
+            for filter_name, field in _serializer.fields.items():
+                if getattr(field, "write_only", False) or field.source == "*":
+                    continue
 
-            try:
-                filter_spec = FILTER_FOR_SERIALIZER_FIELD_DEFAULTS[field]
-            except KeyError:
-                warnings.warn(f"{filter_name} 字段未找到过滤器, 跳过自动成filter!")
-                continue
+                field_name = field.source.replace(".", "__") or filter_name
+                if field_name_prefix:
+                    field_name = field_name_prefix + "__" + field_name
+
+                if filter_name_prefix:
+                    filter_name = filter_name_prefix + "." + filter_name
+
+                if get_model_field(filterset_model, field_name) is None and (
+                    queryset is not None and filter_name not in queryset.query.annotations
+                ):
+                    continue
 
-            extra = filter_spec.get("extra")
-            kwargs = {"field_name": field_name, "label": field.label, "help_text": field.help_text}
-            if callable(extra):
-                kwargs.update(extra(field))
+                if isinstance(field, serializers.BaseSerializer):
+                    filters_from_serializer(field, field_name_prefix=field_name, filter_name_prefix=filter_name)
 
-            if "queryset" in kwargs and kwargs["queryset"] is None:
-                warnings.warn(f"{filter_name} 字段未提供queryset, 跳过自动成filter!")
-                continue
+                try:
+                    filter_spec = FILTER_FOR_SERIALIZER_FIELD_DEFAULTS[field]
+                except KeyError:
+                    warnings.warn(f"{filter_name} 字段未找到过滤器, 跳过自动成filter!")
+                    continue
 
-            overwrite_value = overwrite_kwargs.get(filter_name)
-            if overwrite_value:
-                kwargs.update(overwrite_value)
+                extra = filter_spec.get("extra")
+                kwargs = {"field_name": field_name, "label": field.label, "help_text": field.help_text}
+                if callable(extra):
+                    kwargs.update(extra(field))
 
-            filterset_field = filter_spec["filter_class"](**kwargs)
-            filterset_fields[filter_name] = filterset_field
+                if "queryset" in kwargs and kwargs["queryset"] is None:
+                    warnings.warn(f"{filter_name} 字段未提供queryset, 跳过自动成filter!")
+                    continue
 
+                overwrite_value = overwrite_kwargs.get(filter_name)
+                if overwrite_value:
+                    kwargs.update(overwrite_value)
+
+                filterset_field = filter_spec["filter_class"](**kwargs)
+                filterset_fields[filter_name] = filterset_field
+
+        filters_from_serializer(serializer)
         filterset_fields.update(overwrite_fields)
 
         AutoFilterSet = type("AutoFilterSet", (self.filterset_base,), filterset_fields)  # noqa
@@ -252,6 +260,7 @@ class FullTextSearchFilter(SearchFilter):
     """
     Search filter that supports fulltext search
     """
+
     search_vector = None
     search_query = None
 

drfexts/models.py

@@ -30,7 +30,7 @@ class NotNull(Func):
     arity = 1
 
 
-class StatusQueryset(models.QuerySet):
+class StatusQuerySet(models.QuerySet):
 
     def editable(self):
         return self.exclude(status__in=[CommonStatus.DELETED, CommonStatus.INVALID])
@@ -39,7 +39,7 @@ def active(self):
         return self.filter(status__in=[CommonStatus.VALID, CommonStatus.PAUSED, CommonStatus.TO_INVALID])
 
     def valid(self):
-        return self.filter(status__in=CommonStatus.VALID)
+        return self.filter(status=CommonStatus.VALID)
 
 
 class BaseModel(models.Model):
@@ -51,7 +51,7 @@ class BaseModel(models.Model):
     updated_at = UpdatedAtField()  # 修改时间
     created_at = CreatedAtField()  # 创建时间
 
-    objects = StatusQueryset.as_manager()
+    objects = StatusQuerySet.as_manager()
 
     class Meta:
         abstract = True
@@ -68,7 +68,7 @@ class BaseCodeModel(models.Model):
     updated_at = UpdatedAtField()  # 修改时间
     created_at = CreatedAtField()  # 创建时间
 
-    objects = StatusQueryset.as_manager()
+    objects = StatusQuerySet.as_manager()
 
     class Meta:
         abstract = True
@@ -87,7 +87,7 @@ class BaseCreatorModel(models.Model):
     updated_at = UpdatedAtField()  # 修改时间
     created_at = CreatedAtField()  # 创建时间
 
-    objects = StatusQueryset.as_manager()
+    objects = StatusQuerySet.as_manager()
 
     class Meta:
         abstract = True
@@ -120,7 +120,7 @@ class AuditModel(models.Model):
     updated_at = UpdatedAtField()  # 修改时间
     created_at = CreatedAtField()  # 创建时间
 
-    objects = StatusQueryset.as_manager()
+    objects = StatusQuerySet.as_manager()
 
     class Meta:
         abstract = True

drfexts/viewsets.py

@@ -121,13 +121,7 @@ class ExtGenericViewSet(GenericViewSet):
 
     def get_serializer_class(self):
         """
-        Return the class to use for the serializer.
-        Defaults to using `self.serializer_class`.
-
-        You may want to override this if you need to provide different
-        serializations depending on the incoming request.
-
-        (Eg. admins get full serialization, others get basic serialization)
+        支持针对不同action指定不同的序列化器
         """
         assert self.serializer_class is not None, (
                 "'%s' should either include a `serializer_class` attribute, "
@@ -144,6 +138,19 @@ def get_serializer_class(self):
 
         return self.serializer_class
 
+    def get_serializer(self, *args, **kwargs):
+        """
+        支持动态设置序列化器字段
+        """
+        serializer_class = self.get_serializer_class()
+        if hasattr(serializer_class, "get_dynamic_fields") and callable(serializer_class.get_dynamic_fields):
+            dynamic_fields = serializer_class.get_dynamic_fields(self.request)
+            if dynamic_fields:
+                kwargs["fields"] = dynamic_fields
+
+        kwargs.setdefault('context', self.get_serializer_context())
+        return serializer_class(*args, **kwargs)
+
     def data_permissions(self, request, view, queryset):
         """
         检查数据权限

pyproject.toml

@@ -1,6 +1,47 @@
+[tool.black]
+line-length = 89
+target-version = ['py38', 'py39']
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+
+  # The following are specific to Black, you probably don't want those.
+  | blib2to3
+  | tests/data
+  | profiling
+)/
+'''
+
+[tool.isort]
+profile = "black"
+known_first_party = ["scf", "config"]
+default_section = "THIRDPARTY"
+skip = ["venv/", ".venv/"]
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+
+[tool.commitizen]
+version = "0.13.0"
+tag_format = "v$major.$minor.$patch$prerelease"
+version_files = [
+    "pyproject.toml:version",
+    "__init__.py"
+]
+
 [tool.poetry]
 name = "drfexts"
-version = "0.10.7"
+version = "0.13.0"
 readme = "README.md"
 description = "Django Restframework Utils"
 authors = ["aiden <allaher@icloud.com>"]
@@ -29,6 +70,13 @@ conditions = "^0.2.0"
 
 [tool.poetry.dev-dependencies]
 #pytest = "^4.0"
+flake8 = "^4.0.1"
+flake8-isort = "^4.1.1"
+coverage = "^6.2"
+black = "^22.3.0"
+pylint-django = "^2.5.0"
+pre-commit = "^2.16.0"
+commitizen = "^2.28.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]