Merge pull request #55 from cloudblue/LITE-25849-add-isort

LITE-25849 Add isort

Author: maxipavlovic

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
     steps:
       - name: Checkout project
         uses: actions/checkout@v2

README.md

@@ -271,7 +271,9 @@ Development
 ===========
 
 1. Python 3.6+
-0. Install dependencies `requirements/dev.txt` and `requirements/extra.txt`
+2. Install dependencies `requirements/dev.txt` and `requirements/extra.txt`
+3. We use `isort` library to order and format our imports, and we check it using `flake8-isort` library (automatically on `flake8` run).  
+For convenience you may run `isort .` to order imports.
 
 Testing
 =======

dj_rql/constants.py

@@ -3,7 +3,6 @@
 #
 
 from django.db import models
-
 from py_rql.constants import FilterLookups, FilterTypes as FT
 
 

dj_rql/drf/backend.py

@@ -3,10 +3,10 @@
 #
 from threading import Lock
 
-from dj_rql.drf._utils import get_query
-
 from rest_framework.filters import BaseFilterBackend
 
+from dj_rql.drf._utils import get_query
+
 
 lock = Lock()
 

dj_rql/drf/compat.py

@@ -4,23 +4,23 @@
 
 from collections import Counter
 
-from dj_rql.constants import DjangoLookups as DJL, FilterTypes
-from dj_rql.drf._utils import get_query
-from dj_rql.drf.backend import RQLFilterBackend
-
 from py_rql.constants import (
-    ComparisonOperators as CO,
     RQL_ANY_SYMBOL,
     RQL_FALSE,
     RQL_LIMIT_PARAM,
     RQL_NULL,
     RQL_OFFSET_PARAM,
     RQL_ORDERING_OPERATOR,
     RQL_TRUE,
+    ComparisonOperators as CO,
     SearchOperators as SO,
 )
 from py_rql.exceptions import RQLFilterParsingError
 
+from dj_rql.constants import DjangoLookups as DJL, FilterTypes
+from dj_rql.drf._utils import get_query
+from dj_rql.drf.backend import RQLFilterBackend
+
 
 class CompatibilityRQLFilterBackend(RQLFilterBackend):
     """

dj_rql/drf/paginations.py

@@ -2,17 +2,15 @@
 #  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
-from dj_rql.drf._utils import get_query
-from dj_rql.transformer import RQLLimitOffsetTransformer
-
 from lark.exceptions import LarkError
-
 from py_rql.exceptions import RQLFilterParsingError
 from py_rql.parser import RQLParser
-
 from rest_framework.pagination import LimitOffsetPagination, _positive_int
 from rest_framework.response import Response
 
+from dj_rql.drf._utils import get_query
+from dj_rql.transformer import RQLLimitOffsetTransformer
+
 
 class RQLLimitOffsetPagination(LimitOffsetPagination):
     """ RQL limit offset pagination. """

dj_rql/filter_cls.py

@@ -8,23 +8,18 @@
 from datetime import datetime
 from uuid import uuid4
 
-from dj_rql._dataclasses import FilterArgs, OptimizationArgs
-from dj_rql.constants import DjangoLookups, FilterTypes, SUPPORTED_FIELD_TYPES
-from dj_rql.fields import SelectField
-from dj_rql.openapi import RQLFilterClassSpecification
-from dj_rql.qs import Annotation, NPR, NSR
-from dj_rql.transformer import RQLToDjangoORMTransformer
-
-from django.db.models import ForeignKey, ManyToManyField, Model, OneToOneField, OneToOneRel, Q
+from django.db.models import (
+    ForeignKey,
+    ManyToManyField,
+    Model,
+    OneToOneField,
+    OneToOneRel,
+    Q,
+)
 from django.utils.dateparse import parse_date, parse_datetime
 from django.utils.functional import cached_property
-
 from lark.exceptions import LarkError
-
 from py_rql.constants import (
-    ComparisonOperators,
-    FilterLookups,
-    ListOperators,
     RESERVED_FILTER_NAMES,
     RQL_ANY_SYMBOL,
     RQL_EMPTY,
@@ -34,11 +29,21 @@
     RQL_PLUS,
     RQL_SEARCH_PARAM,
     RQL_TRUE,
+    ComparisonOperators,
+    FilterLookups,
+    ListOperators,
     SearchOperators,
 )
 from py_rql.exceptions import RQLFilterLookupError, RQLFilterParsingError, RQLFilterValueError
 from py_rql.parser import RQLParser
 
+from dj_rql._dataclasses import FilterArgs, OptimizationArgs
+from dj_rql.constants import SUPPORTED_FIELD_TYPES, DjangoLookups, FilterTypes
+from dj_rql.fields import SelectField
+from dj_rql.openapi import RQLFilterClassSpecification
+from dj_rql.qs import NPR, NSR, Annotation
+from dj_rql.transformer import RQLToDjangoORMTransformer
+
 
 iterable_types = (list, tuple)
 

dj_rql/management/commands/generate_rql_class.py

@@ -5,12 +5,12 @@
 import json
 import re
 
-from dj_rql.filter_cls import NestedAutoRQLFilterClass
-
 from django.core.management import BaseCommand
 from django.db.models import ForeignKey, OneToOneField, OneToOneRel
 from django.utils.module_loading import import_string
 
+from dj_rql.filter_cls import NestedAutoRQLFilterClass
+
 
 TEMPLATE = """from {model_package} import {model_name}
 

dj_rql/openapi.py

@@ -5,12 +5,15 @@
 from copy import copy
 from numbers import Number
 
-from dj_rql.constants import FilterTypes
-
 from py_rql.constants import (
-    FilterLookups, RQL_NULL, RQL_ORDERING_OPERATOR, RQL_SEARCH_PARAM,
+    RQL_NULL,
+    RQL_ORDERING_OPERATOR,
+    RQL_SEARCH_PARAM,
+    FilterLookups,
 )
 
+from dj_rql.constants import FilterTypes
+
 
 class RQLFilterDescriptionTemplate:
     BASE_TEMPLATE = '{description}\n\n**lookups:** {lookups}'

dj_rql/transformer.py

@@ -2,19 +2,18 @@
 #  Copyright © 2022 Ingram Micro Inc. All rights reserved.
 #
 
-from dj_rql._dataclasses import FilterArgs
-
 from lark import Tree
-
 from py_rql.constants import (
+    RQL_LIMIT_PARAM,
+    RQL_OFFSET_PARAM,
     ComparisonOperators,
     ListOperators,
     LogicalOperators,
-    RQL_LIMIT_PARAM,
-    RQL_OFFSET_PARAM,
 )
 from py_rql.transformer import BaseRQLTransformer
 
+from dj_rql._dataclasses import FilterArgs
+
 
 class RQLToDjangoORMTransformer(BaseRQLTransformer):
     """ Parsed RQL AST tree transformer to Django ORM Query.