Update docs, remove future imports

Qu4tro · Jun 17, 2022 · 7ed8f00 · 7ed8f00
1 parent 5a3392c
commit 7ed8f00
Show file tree

Hide file tree

Showing 70 changed files with 395 additions and 328 deletions.
diff --git a/.github/workflows/updaterelease.yaml b/.github/workflows/updaterelease.yaml
@@ -0,0 +1,15 @@
+name: changerelease
+on:
+  workflow_dispatch: {}
+  push:
+    paths: [CHANGELOG.md]
+    tags: ["*"]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: dropseed/changerelease@v1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        changelog: CHANGELOG.md
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,25 +3,24 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.2.0
     hooks:
-      - id: check-added-large-files
-        args: [--maxkb=1024]
-      - id: check-byte-order-marker
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
       - id: check-builtin-literals
       - id: check-case-conflict
       - id: check-docstring-first
       - id: check-executables-have-shebangs
       - id: check-json
-      - id: pretty-format-json
-        args: [--autofix, --indent=2]
       - id: check-merge-conflict
       - id: check-xml
       - id: check-yaml
         args: [--allow-multiple-documents]
-      - id: debug-statements
-      - id: end-of-file-fixer
-      - id: fix-encoding-pragma
-      - id: mixed-line-ending
-      - id: trailing-whitespace
+      - id: check-added-large-files
+        args: [--maxkb=1024]
+      - id: pretty-format-json
+        args: [--autofix, --indent=2]
 
   - repo: https://github.com/pycqa/flake8
     rev: '4.0.1'
@@ -37,3 +36,13 @@ repos:
     rev: '22.3.0'
     hooks:
       - id: black
+
+  - repo: https://github.com/python-poetry/poetry
+    rev: '1.2.0b1'
+    hooks:
+      - id: poetry-check
+
+  - repo: https://github.com/mschmieder/python-kacl
+    rev: 'v0.2.24'
+    hooks:
+      - id: kacl-verify
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/README.rst b/README.rst
@@ -58,7 +58,7 @@ with Django REST Framework but it can be used without DRF (see below).
 
 ::
 
-  from django_ufilter.integrations.drf import DjangoFilterBackend
+  from django_ufilter.integrations.drf import DRFFilterBackend
 
 
   class UserViewSet(ModelViewSet):

diff --git a/django_ufilter/__init__.py b/django_ufilter/__init__.py
@@ -1,4 +1 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
-__version__ = "0.4.0"
+__version__ = "0.3.99"
diff --git a/django_ufilter/backends/__init__.py b/django_ufilter/backends/__init__.py
@@ -1,2 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals

diff --git a/django_ufilter/backends/base.py b/django_ufilter/backends/base.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import abc
 
 import six

diff --git a/django_ufilter/backends/django.py b/django_ufilter/backends/django.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 from django.core.exceptions import FieldDoesNotExist
 from django.db.models.constants import LOOKUP_SEP
 

diff --git a/django_ufilter/backends/plain.py b/django_ufilter/backends/plain.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import re
 
 from ..utils import dictify

diff --git a/django_ufilter/constants.py b/django_ufilter/constants.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import enum
 
 

diff --git a/django_ufilter/exceptions.py b/django_ufilter/exceptions.py
@@ -1,7 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
-
 class SkipFilter(Exception):
     """
     Exception to be used when any particular filter

diff --git a/django_ufilter/fields.py b/django_ufilter/fields.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 from django import forms
 
 from .validators import MaxLengthValidator, MinLengthValidator

diff --git a/django_ufilter/filters.py b/django_ufilter/filters.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import abc
 import re
 from functools import wraps

diff --git a/django_ufilter/filtersets/__init__.py b/django_ufilter/filtersets/__init__.py
@@ -1,5 +1,2 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 from .base import *  # noqa
 from .django import *  # noqa
diff --git a/django_ufilter/filtersets/base.py b/django_ufilter/filtersets/base.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import abc
 import re
 from collections import defaultdict

diff --git a/django_ufilter/filtersets/django.py b/django_ufilter/filtersets/django.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import operator
 
 from django import forms
@@ -33,7 +30,7 @@
 
 class DjangoModelFilterSetOptions(ModelFilterSetOptions):
     """
-    Custom options for ``FilterSet``s used for Django models.
+    Custom options for FilterSets used for Django models.
 
     Attributes
     ----------

diff --git a/django_ufilter/filtersets/plain.py b/django_ufilter/filtersets/plain.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 from datetime import date, datetime, time
 from decimal import Decimal
 

diff --git a/django_ufilter/integrations/drf.py b/django_ufilter/integrations/drf.py
@@ -1,14 +1,11 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 from django.core.exceptions import ValidationError as DjangoValidationError
 from rest_framework.exceptions import ValidationError
 from rest_framework.filters import BaseFilterBackend
 
 from ..filtersets import ModelFilterSet
 
 
-class DjangoFilterBackend(BaseFilterBackend):
+class DRFFilterBackend(BaseFilterBackend):
     """
     DRF filter backend which integrates with ``django-ufilter``
 
@@ -17,15 +14,15 @@ class DjangoFilterBackend(BaseFilterBackend):
         # settings.py
         REST_FRAMEWORK = {
             'DEFAULT_FILTER_BACKENDS': [
-                'django_ufilter.integrations.drf.DjangoFilterBackend',
+                'django_ufilter.integrations.drf.DRFFilterBackend',
             ]
         }
 
     Alternatively filter backend can be specified per view/viewset bases::
 
         class MyViewSet(ModelViewSet):
             queryset = MyModel.objects.all()
-            filter_backends = [DjangoFilterBackend]
+            filter_backends = [DRFFilterBackend]
             filter_fields = ['field1', 'field2']
 
     The following attributes can be specified on the view:
@@ -62,7 +59,7 @@ def get_filter_class(self, view, queryset=None):
         ----------
         view : View
             DRF view/viewset where this filter backend is being used.
-            Please refer to :class:`.DjangoFilterBackend` documentation
+            Please refer to :class:`.DRFFilterBackend` documentation
             for list of attributes which can be supplied in view
             to customize how filterset will be determined.
         queryset
@@ -163,4 +160,4 @@ def filter_queryset(self, request, queryset, view):
         return queryset
 
 
-URLFilterBackend = DjangoFilterBackend
+URLFilterBackend = DRFFilterBackend
diff --git a/django_ufilter/utils.py b/django_ufilter/utils.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 import inspect
 from contextlib import contextmanager
 
@@ -27,7 +24,7 @@ class FilterSpec(object):
         to be used in filtering of the queryset.
         For example lookup config with key
         ``user__profile__email`` will have components of
-        ``['user', 'profile', 'email'].
+        ``['user', 'profile', 'email']``.
     lookup : str
         Name of the lookup how final key/attribute from
         :attr:`.components` should be compared.

diff --git a/django_ufilter/validators.py b/django_ufilter/validators.py
@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-from __future__ import absolute_import, print_function, unicode_literals
-
 from django.core.validators import MaxLengthValidator as _MaxLengthValidator
 from django.core.validators import MinLengthValidator as _MinLengthValidator
 from django.utils.deconstruct import deconstructible

diff --git a/docs/api/url_filter.backends.base.rst → docs/api/django_ufilter.backends.base.rst b/docs/api/url_filter.backends.base.rst → docs/api/django_ufilter.backends.base.rst
@@ -1,5 +1,5 @@
-url\_filter.backends.base module
-================================
+django_ufilter.backends.base module
+============================================
 
 .. automodule:: django_ufilter.backends.base
     :members:

diff --git a/docs/api/url_filter.backends.django.rst → docs/api/django_ufilter.backends.django.rst b/docs/api/url_filter.backends.django.rst → docs/api/django_ufilter.backends.django.rst
@@ -1,5 +1,5 @@
-url\_filter.backends.django module
-==================================
+django_ufilter.backends.django module
+==============================================
 
 .. automodule:: django_ufilter.backends.django
     :members:

diff --git a/docs/api/url_filter.backends.plain.rst → docs/api/django_ufilter.backends.plain.rst b/docs/api/url_filter.backends.plain.rst → docs/api/django_ufilter.backends.plain.rst
@@ -1,5 +1,5 @@
-url\_filter.backends.plain module
-=================================
+django_ufilter.backends.plain module
+=============================================
 
 .. automodule:: django_ufilter.backends.plain
     :members:

diff --git a/docs/api/url_filter.backends.rst → docs/api/django_ufilter.backends.rst b/docs/api/url_filter.backends.rst → docs/api/django_ufilter.backends.rst
@@ -1,5 +1,5 @@
-url\_filter.backends package
-============================
+django_ufilter.backends package
+==================================
 
 .. automodule:: django_ufilter.backends
     :members:

diff --git a/docs/api/url_filter.exceptions.rst → docs/api/django_ufilter.exceptions.rst b/docs/api/url_filter.exceptions.rst → docs/api/django_ufilter.exceptions.rst
@@ -1,5 +1,5 @@
-url\_filter.exceptions module
-=============================
+django_ufilter.exceptions module
+=========================================
 
 .. automodule:: django_ufilter.exceptions
     :members:

diff --git a/docs/api/url_filter.fields.rst → docs/api/django_ufilter.fields.rst b/docs/api/url_filter.fields.rst → docs/api/django_ufilter.fields.rst
@@ -1,5 +1,5 @@
-url\_filter.fields module
-=========================
+django_ufilter.fields module
+=====================================
 
 .. automodule:: django_ufilter.fields
     :members:

diff --git a/docs/api/url_filter.filters.rst → docs/api/django_ufilter.filters.rst b/docs/api/url_filter.filters.rst → docs/api/django_ufilter.filters.rst
@@ -1,5 +1,5 @@
-url\_filter.filters module
-==========================
+django_ufilter.filters module
+======================================
 
 .. automodule:: django_ufilter.filters
     :members:

diff --git a/docs/api/url_filter.filtersets.base.rst → docs/api/django_ufilter.filtersets.base.rst b/docs/api/url_filter.filtersets.base.rst → docs/api/django_ufilter.filtersets.base.rst
@@ -1,5 +1,5 @@
-url\_filter.filtersets.base module
-==================================
+django_ufilter.filtersets.base module
+==============================================
 
 .. automodule:: django_ufilter.filtersets.base
     :members:

diff --git a/docs/api/url_filter.filtersets.django.rst → .../api/django_ufilter.filtersets.django.rst b/docs/api/url_filter.filtersets.django.rst → .../api/django_ufilter.filtersets.django.rst
@@ -1,5 +1,5 @@
-url\_filter.filtersets.django module
-====================================
+django_ufilter.filtersets.django module
+=============================================
 
 .. automodule:: django_ufilter.filtersets.django
     :members:

diff --git a/docs/api/url_filter.filtersets.plain.rst → docs/api/django_ufilter.filtersets.plain.rst b/docs/api/url_filter.filtersets.plain.rst → docs/api/django_ufilter.filtersets.plain.rst
@@ -1,5 +1,5 @@
-url\_filter.filtersets.plain module
-===================================
+django_ufilter.filtersets.plain module
+===============================================
 
 .. automodule:: django_ufilter.filtersets.plain
     :members:

diff --git a/docs/api/url_filter.filtersets.rst → docs/api/django_ufilter.filtersets.rst b/docs/api/url_filter.filtersets.rst → docs/api/django_ufilter.filtersets.rst
@@ -1,5 +1,5 @@
-url\_filter.filtersets package
-==============================
+django_ufilter.filtersets package
+==========================================
 
 .. automodule:: django_ufilter.filtersets
     :members:

diff --git a/docs/api/url_filter.integrations.drf.rst → docs/api/django_ufilter.integrations.drf.rst b/docs/api/url_filter.integrations.drf.rst → docs/api/django_ufilter.integrations.drf.rst
@@ -1,5 +1,5 @@
-url\_filter.integrations.drf module
-===================================
+django_ufilter.integrations.drf module
+===============================================
 
 .. automodule:: django_ufilter.integrations.drf
     :members:

diff --git a/docs/api/url_filter.integrations.rst → docs/api/django_ufilter.integrations.rst b/docs/api/url_filter.integrations.rst → docs/api/django_ufilter.integrations.rst
@@ -1,5 +1,5 @@
-url\_filter.integrations package
-================================
+django_ufilter.integrations package
+============================================
 
 .. automodule:: django_ufilter.integrations
     :members:

diff --git a/docs/api/url_filter.rst → docs/api/django_ufilter.rst b/docs/api/url_filter.rst → docs/api/django_ufilter.rst
@@ -1,5 +1,5 @@
-url\_filter package
-===================
+django_ufilter package
+===============================
 
 .. automodule:: django_ufilter
     :members:
@@ -20,7 +20,6 @@ Submodules
 
 .. toctree::
 
-   django_ufilter.constants
    django_ufilter.exceptions
    django_ufilter.fields
    django_ufilter.filters

diff --git a/docs/api/url_filter.utils.rst → docs/api/django_ufilter.utils.rst b/docs/api/url_filter.utils.rst → docs/api/django_ufilter.utils.rst
@@ -1,5 +1,5 @@
-url\_filter.utils module
-========================
+django_ufilter.utils module
+====================================
 
 .. automodule:: django_ufilter.utils
     :members:

diff --git a/docs/api/url_filter.validators.rst → docs/api/django_ufilter.validators.rst b/docs/api/url_filter.validators.rst → docs/api/django_ufilter.validators.rst
@@ -1,5 +1,5 @@
-url\_filter.validators module
-=============================
+django_ufilter.validators module
+=========================================
 
 .. automodule:: django_ufilter.validators
     :members:

diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -1,5 +1,5 @@
 django_ufilter
-==========
+===================
 
 .. toctree::
    :maxdepth: 4
-Original file line number
+Diff line change
@@ Expand Up @@
     ::
-      from django_ufilter.integrations.drf import DjangoFilterBackend
+      from django_ufilter.integrations.drf import DRFFilterBackend
       class UserViewSet(ModelViewSet):
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -1,2 +0,0 @@
		# -- coding: utf-8 --
		from __future__ import absolute_import, print_function, unicode_literals