feat: new export mixin

BREAKING CHANGE: Uncompatible with previous version!

Author: cursor12345

.travis.yml

@@ -0,0 +1,27 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.{html,css,scss,json,yml,xml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+
+[nginx.conf]
+indent_style = space
+indent_size = 2

.editorconfig

@@ -0,0 +1 @@
+* text=auto

.gitattributes

@@ -8,10 +8,8 @@ repos:
       - 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
 
@@ -21,12 +19,6 @@ repos:
       - 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:

.pre-commit-config.yaml

@@ -123,4 +123,4 @@ $ ./manage.py test
 
 ## Thanks
 
-[![PyCharm](docs/pycharm.svg)](https://www.jetbrains.com/?from=drfexts)
+[![PyCharm](docs/pycharm.svg)](https://www.jetbrains.com/?from=drfexts)

MANIFEST.in

@@ -1 +1 @@
-__version__ = '0.15.0'
+__version__ = "0.15.1"

README.md

@@ -6,13 +6,13 @@
 from django.conf import settings
 from rest_framework.response import Response
 from rest_framework.status import HTTP_500_INTERNAL_SERVER_ERROR
-from rest_framework.views import set_rollback, exception_handler
+from rest_framework.views import exception_handler, set_rollback
 
 
 def _get_detail(detail):
     if isinstance(detail, list):
-        return ''.join([x if isinstance(x, str) else _get_detail(x) for x in detail])
-    result = ''
+        return "".join([x if isinstance(x, str) else _get_detail(x) for x in detail])
+    result = ""
     for v in detail.values():
         result += _get_detail(v)
     return result

drfexts/__init__.py

@@ -2,27 +2,27 @@
 from functools import partial
 
 from django.conf import settings
-from django.contrib.postgres.fields import ArrayField as PGArrayField
 from django.contrib.contenttypes import fields as ct_fields
-from django.db import models
+from django.contrib.postgres.fields import ArrayField as PGArrayField
 from django.core import checks
+from django.db import models
 from django.db.models import CASCADE
 from django_currentuser.db.models import CurrentUserField
 
-from .constants import CommonStatus, AuditStatus
+from .constants import AuditStatus, CommonStatus
 from .utils import get_serial_code
 
 
 class DefaultHelpTextMixin:
     def __init__(self, verbose_name, *args, **kwargs):
-        kwargs.setdefault('help_text', verbose_name)
+        kwargs.setdefault("help_text", verbose_name)
         super().__init__(verbose_name, *args, **kwargs)
 
 
 class NullHelpTextMixin:
     def __init__(self, verbose_name, *args, **kwargs):
-        kwargs['null'] = False
-        kwargs.setdefault('help_text', verbose_name)
+        kwargs["null"] = False
+        kwargs.setdefault("help_text", verbose_name)
         super().__init__(verbose_name, *args, **kwargs)
 
 
@@ -48,7 +48,7 @@ def _check_related_name(self, **kwargs):
 
 class AutoField(models.AutoField):
     def __init__(self, verbose_name="主键", **kwargs):
-        kwargs.setdefault('help_text', verbose_name)
+        kwargs.setdefault("help_text", verbose_name)
         super().__init__(verbose_name, **kwargs)
 
 
@@ -142,16 +142,16 @@ class JSONField(DefaultHelpTextMixin, models.JSONField):
 
 class ArrayField(PGArrayField):
     def __init__(self, verbose_name, base_field, **kwargs):
-        kwargs.setdefault('help_text', verbose_name)
-        kwargs.setdefault('verbose_name', verbose_name)
+        kwargs.setdefault("help_text", verbose_name)
+        kwargs.setdefault("verbose_name", verbose_name)
         super().__init__(base_field, **kwargs)
 
 
 class AutoUUIDField(models.UUIDField):
     def __init__(self, verbose_name="主键", **kwargs):
-        kwargs['blank'] = True
+        kwargs["blank"] = True
         kwargs["default"] = uuid.uuid4
-        kwargs.setdefault('help_text', verbose_name)
+        kwargs.setdefault("help_text", verbose_name)
         kwargs.setdefault("primary_key", True)
         super().__init__(verbose_name, **kwargs)
 
@@ -165,18 +165,18 @@ class DefaultCodeField(models.CharField):
 
     def __init__(self, verbose_name="编号", prefix="", **kwargs):
         self.prefix = prefix
-        kwargs['blank'] = True
+        kwargs["blank"] = True
         kwargs["default"] = partial(get_serial_code, prefix)
         kwargs["max_length"] = self.DEFAULT_LENGTH + len(prefix)
-        kwargs['editable'] = False
+        kwargs["editable"] = False
         kwargs.setdefault("help_text", verbose_name)
         super().__init__(verbose_name, **kwargs)
 
     def deconstruct(self):
         name, path, args, kwargs = super().deconstruct()
         # Only include kwarg if it's not the default
         if self.prefix != "":
-            kwargs['prefix'] = self.prefix
+            kwargs["prefix"] = self.prefix
         return name, path, args, kwargs
 
 
@@ -186,8 +186,8 @@ class DescriptionField(models.TextField):
     """
 
     def __init__(self, verbose_name="描述", **kwargs):
-        kwargs.setdefault('blank', True)
-        kwargs.setdefault('help_text', verbose_name)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("help_text", verbose_name)
         super().__init__(verbose_name, **kwargs)
 
 
@@ -200,7 +200,7 @@ def __init__(self, verbose_name="关联的用户", to=None, on_delete=None, **kw
         to = to or settings.AUTH_USER_MODEL
         on_delete = on_delete or CASCADE
         kwargs.setdefault("db_constraint", False)
-        kwargs.setdefault('help_text', verbose_name)
+        kwargs.setdefault("help_text", verbose_name)
         super().__init__(to=to, verbose_name=verbose_name, on_delete=on_delete, **kwargs)
 
 
@@ -210,10 +210,10 @@ class UpdatedAtField(models.DateTimeField):
     """
 
     def __init__(self, verbose_name="修改时间", **kwargs):
-        kwargs['editable'] = False
-        kwargs['auto_now'] = True
-        kwargs.setdefault('help_text', '该记录的最后修改时间')
-        kwargs.setdefault('blank', True)
+        kwargs["editable"] = False
+        kwargs["auto_now"] = True
+        kwargs.setdefault("help_text", "该记录的最后修改时间")
+        kwargs.setdefault("blank", True)
         super().__init__(verbose_name, **kwargs)
 
 
@@ -223,10 +223,10 @@ class CreatedAtField(models.DateTimeField):
     """
 
     def __init__(self, verbose_name="创建时间", **kwargs):
-        kwargs['editable'] = False
-        kwargs['auto_now_add'] = True
-        kwargs.setdefault('help_text', '该记录的创建时间')
-        kwargs.setdefault('blank', True)
+        kwargs["editable"] = False
+        kwargs["auto_now_add"] = True
+        kwargs.setdefault("help_text", "该记录的创建时间")
+        kwargs.setdefault("blank", True)
         super().__init__(verbose_name, **kwargs)
 
 
@@ -236,11 +236,11 @@ class CreatedByField(CurrentUserField):
     """
 
     def __init__(self, *args, **kwargs):
-        kwargs.setdefault('verbose_name', '创建人')
-        kwargs.setdefault('help_text', '该记录的创建者')
-        kwargs.setdefault('related_name', '%(class)s_created_by')
+        kwargs.setdefault("verbose_name", "创建人")
+        kwargs.setdefault("help_text", "该记录的创建者")
+        kwargs.setdefault("related_name", "%(class)s_created_by")
         kwargs.setdefault("on_delete", models.CASCADE)
-        kwargs['db_constraint'] = False
+        kwargs["db_constraint"] = False
         super().__init__(*args, **kwargs)
 
     def _warn_for_shadowing_args(self, *args, **kwargs):
@@ -253,12 +253,12 @@ class UpdatedByField(CurrentUserField):
     """
 
     def __init__(self, *args, **kwargs):
-        kwargs.setdefault('on_update', True)
-        kwargs.setdefault('verbose_name', '修改人')
-        kwargs.setdefault('help_text', '该记录的修改人')
-        kwargs.setdefault('related_name', '%(class)s_updated_by')
+        kwargs.setdefault("on_update", True)
+        kwargs.setdefault("verbose_name", "修改人")
+        kwargs.setdefault("help_text", "该记录的修改人")
+        kwargs.setdefault("related_name", "%(class)s_updated_by")
         kwargs.setdefault("on_delete", models.CASCADE)
-        kwargs['db_constraint'] = False
+        kwargs["db_constraint"] = False
         super().__init__(*args, **kwargs)
 
     def _warn_for_shadowing_args(self, *args, **kwargs):
@@ -271,11 +271,11 @@ class CreatorCharField(models.CharField):
     """
 
     def __init__(self, *args, **kwargs):
-        kwargs.setdefault('max_length', 128)
-        kwargs.setdefault('null', True)
-        kwargs.setdefault('blank', True)
-        kwargs.setdefault('verbose_name', '创建者')
-        kwargs.setdefault('help_text', '该记录的创建者')
+        kwargs.setdefault("max_length", 128)
+        kwargs.setdefault("null", True)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("verbose_name", "创建者")
+        kwargs.setdefault("help_text", "该记录的创建者")
         super().__init__(*args, **kwargs)
 
 
@@ -285,11 +285,11 @@ class ModifierCharField(models.CharField):
     """
 
     def __init__(self, *args, **kwargs):
-        kwargs.setdefault('max_length', 128)
-        kwargs.setdefault('null', True)
-        kwargs.setdefault('blank', True)
-        kwargs.setdefault('verbose_name', '修改者')
-        kwargs.setdefault('help_text', '该记录最后修改者')
+        kwargs.setdefault("max_length", 128)
+        kwargs.setdefault("null", True)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("verbose_name", "修改者")
+        kwargs.setdefault("help_text", "该记录最后修改者")
         super().__init__(*args, **kwargs)
 
 
@@ -299,9 +299,9 @@ class StatusField(models.PositiveSmallIntegerField):
     """
 
     def __init__(self, verbose_name="状态", **kwargs):
-        kwargs.setdefault('choices', CommonStatus.choices)
-        kwargs.setdefault('default', CommonStatus.VALID)
-        kwargs.setdefault('help_text', '100：已失效，75：待失效，50：有效，25：暂停中，10：待生效，5：待提交，0：删除')
+        kwargs.setdefault("choices", CommonStatus.choices)
+        kwargs.setdefault("default", CommonStatus.VALID)
+        kwargs.setdefault("help_text", "100：已失效，75：待失效，50：有效，25：暂停中，10：待生效，5：待提交，0：删除")
         super().__init__(verbose_name, **kwargs)
 
 
@@ -311,17 +311,17 @@ class AuditStatusField(models.PositiveSmallIntegerField):
     """
 
     def __init__(self, verbose_name="审核状态", **kwargs):
-        kwargs.setdefault('choices', AuditStatus.choices)
-        kwargs.setdefault('null', True)
-        kwargs.setdefault('blank', True)
-        kwargs.setdefault('help_text', '该记录的审核状态')
+        kwargs.setdefault("choices", AuditStatus.choices)
+        kwargs.setdefault("null", True)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("help_text", "该记录的审核状态")
         super().__init__(verbose_name, **kwargs)
 
 
 class VirtualForeignKey(models.ForeignKey):
     def __init__(self, verbose_name, to, *args, **kwargs):
         kwargs.setdefault("verbose_name", verbose_name)
-        kwargs['db_constraint'] = False
+        kwargs["db_constraint"] = False
 
         if kwargs.get("null"):
             kwargs.setdefault("blank", True)
@@ -356,17 +356,21 @@ def __init__(self, verbose_name, to, *args, **kwargs):
 
 
 class GenericForeignKey(ct_fields.GenericForeignKey):
-    def __init__(self, ct_field='content_type', fk_field='object_id', for_concrete_model=True):
-        super().__init__(ct_field=ct_field, fk_field=fk_field, for_concrete_model=for_concrete_model)
+    def __init__(
+        self, ct_field="content_type", fk_field="object_id", for_concrete_model=True
+    ):
+        super().__init__(
+            ct_field=ct_field, fk_field=fk_field, for_concrete_model=for_concrete_model
+        )
 
 
 class GenericRelation(ct_fields.GenericRelation):
     def __init__(
         self,
         verbose_name,
         to,
-        object_id_field='object_id',
-        content_type_field='content_type',
+        object_id_field="object_id",
+        content_type_field="content_type",
         for_concrete_model=True,
         related_query_name=None,
         limit_choices_to=None,