Merge pull request #57 from cloudblue/LITE-25848-add-isort

ffaraone · web-flow · commit 37b27f2fa534 · 2022-12-20T12:45:54.000+01:00
LITE-25848 Add isort
diff --git a/README.md b/README.md
@@ -27,6 +27,11 @@ $ pip install connect-openapi-client
 ```
 
 
+## Development
+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 `poetry run isort .` to order imports.
+
+
 ## Documentation
 
 [`Connect Python OpenAPI Client` documentation](https://connect-openapi-client.readthedocs.io/en/latest/) is hosted on the _Read the Docs_ service.
diff --git a/connect/client/__init__.py b/connect/client/__init__.py
@@ -5,5 +5,5 @@
 #
 from connect.client.exceptions import ClientError  # noqa
 from connect.client.fluent import AsyncConnectClient, ConnectClient  # noqa
+from connect.client.logger import RequestLogger  # noqa
 from connect.client.rql import R  # noqa
-from connect.client.logger import RequestLogger # noqa
diff --git a/connect/client/contrib/locust/user.py b/connect/client/contrib/locust/user.py
@@ -1,7 +1,6 @@
 import time
 
 from locust import HttpUser
-
 from requests import RequestException
 
 from connect.client import ConnectClient
diff --git a/connect/client/fluent.py b/connect/client/fluent.py
@@ -8,15 +8,19 @@
 from json.decoder import JSONDecodeError
 
 import httpx
-
 import requests
 
 from connect.client.constants import CONNECT_ENDPOINT_URL, CONNECT_SPECS_URL
-from connect.client.mixins import AsyncClientMixin, SyncClientMixin
-from connect.client.models import AsyncCollection, AsyncNS, Collection, NS
-from connect.client.utils import get_headers
 from connect.client.help_formatter import DefaultFormatter
+from connect.client.mixins import AsyncClientMixin, SyncClientMixin
+from connect.client.models import (
+    NS,
+    AsyncCollection,
+    AsyncNS,
+    Collection,
+)
 from connect.client.openapi import OpenAPISpecs
+from connect.client.utils import get_headers
 
 
 class _ConnectClientBase(threading.local):
diff --git a/connect/client/help_formatter.py b/connect/client/help_formatter.py
@@ -4,20 +4,20 @@
 # Copyright (c) 2021 Ingram Micro. All Rights Reserved.
 #
 import inflect
+from connect.utils.terminal.markdown import render
 
 from connect.client.models import (
+    NS,
     Action,
     AsyncAction,
     AsyncCollection,
     AsyncNS,
     AsyncResource,
     AsyncResourceSet,
     Collection,
-    NS,
     Resource,
     ResourceSet,
 )
-from connect.utils.terminal.markdown import render
 
 
 _COL_HTTP_METHOD_TO_METHOD = {
diff --git a/connect/client/mixins.py b/connect/client/mixins.py
@@ -6,7 +6,6 @@
 import time
 
 from httpx import HTTPError
-
 from requests.exceptions import RequestException, Timeout
 
 from connect.client.exceptions import ClientError
diff --git a/connect/client/models/__init__.py b/connect/client/models/__init__.py
@@ -4,14 +4,14 @@
 # Copyright (c) 2021 Ingram Micro. All Rights Reserved.
 #
 from connect.client.models.base import (  # noqa
+    NS,
     Action,
     AsyncAction,
     AsyncCollection,
     AsyncNS,
     AsyncResource,
     Collection,
-    NS,
     Resource,
 )
 from connect.client.models.exceptions import NotYetEvaluatedError  # noqa
-from connect.client.models.resourceset import AsyncResourceSet, ResourceSet  # noqa
+from connect.client.models.resourceset import AsyncResourceSet, ResourceSet  # noqa
diff --git a/connect/client/models/resourceset.py b/connect/client/models/resourceset.py
@@ -13,8 +13,8 @@
     ValuesListIterator,
     aiter,
 )
-from connect.client.utils import parse_content_range, resolve_attribute
 from connect.client.rql import R
+from connect.client.utils import parse_content_range, resolve_attribute
 
 
 class _ResourceSetBase:
diff --git a/connect/client/openapi.py b/connect/client/openapi.py
@@ -3,11 +3,10 @@
 #
 # Copyright (c) 2021 Ingram Micro. All Rights Reserved.
 #
-from io import StringIO
 from functools import partial
+from io import StringIO
 
 import requests
-
 import yaml
 
 
diff --git a/connect/client/testing/fluent.py b/connect/client/testing/fluent.py
@@ -6,14 +6,11 @@
 import json
 
 import httpx
-
 import responses
-from responses import matchers
-
 from pytest import MonkeyPatch
-
 from pytest_httpx import HTTPXMock
 from pytest_httpx._httpx_mock import _PytestAsyncTransport
+from responses import matchers
 
 from connect.client.fluent import _ConnectClientBase
 from connect.client.testing.models import CollectionMock, NSMock
diff --git a/connect/client/testing/models/base.py b/connect/client/testing/models/base.py
@@ -3,12 +3,13 @@
 #
 # Copyright (c) 2021 Ingram Micro. All Rights Reserved.
 #
-from connect.client.models.base import _ActionBase, _CollectionBase, _NSBase, _ResourceBase
-from connect.client.testing.models.mixins import (
-    ActionMixin,
-    CollectionMixin,
-    ResourceMixin,
+from connect.client.models.base import (
+    _ActionBase,
+    _CollectionBase,
+    _NSBase,
+    _ResourceBase,
 )
+from connect.client.testing.models.mixins import ActionMixin, CollectionMixin, ResourceMixin
 from connect.client.testing.models.resourceset import ResourceSetMock
 
 
diff --git a/connect/client/utils.py b/connect/client/utils.py
@@ -8,6 +8,7 @@
 
 from connect.client.version import get_version
 
+
 ContentRange = namedtuple('ContentRange', ('first', 'last', 'count'))
 
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -56,8 +56,9 @@ flake8-bugbear = ">=20,<23"
 flake8-cognitive-complexity = "^0.1"
 flake8-commas = "~2.0"
 flake8-future-import = "~0.4"
-flake8-import-order = "~0.18"
+flake8-isort = "^5.0"
 flake8-broken-line = ">=0.3,<0.7"
+isort = "^5.10"
 pytest-asyncio = "^0.15.1"
 mock = { version = "^4.0.3", markers = "python_version < '3.8'" }
 mkdocs = "^1.3.1"
@@ -99,3 +100,15 @@ exclude_lines = [
     "raise NotImplementedError",
     "if __name__ == .__main__.:",
 ]
+
+[tool.isort]
+src_paths = "*"
+sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
+group_by_package = true
+multi_line_output = 3
+force_grid_wrap = 4
+combine_as_imports = true
+use_parentheses = true
+include_trailing_comma = true
+line_length = 100
+lines_after_imports = 2
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -16,7 +16,7 @@ flake8-bugbear==20.11.1 ; python_version >= "3.7" and python_version < "4"
 flake8-cognitive-complexity==0.1.0 ; python_version >= "3.7" and python_version < "4"
 flake8-commas==2.0.0 ; python_version >= "3.7" and python_version < "4"
 flake8-future-import==0.4.7 ; python_version >= "3.7" and python_version < "4"
-flake8-import-order==0.18.1 ; python_version >= "3.7" and python_version < "4"
+flake8-isort==5.0.3 ; python_version >= "3.7" and python_version < "4"
 flake8==3.8.4 ; python_version >= "3.7" and python_version < "4"
 ghp-import==2.1.0 ; python_version >= "3.7" and python_version < "4"
 h11==0.12.0 ; python_version >= "3.7" and python_version < "4"
@@ -26,6 +26,7 @@ idna==3.4 ; python_version >= "3.7" and python_version < "4"
 importlib-metadata==4.12.0 ; python_version >= "3.7" and python_version < "4"
 inflect==6.0.0 ; python_version >= "3.7" and python_version < "4"
 iniconfig==1.1.1 ; python_version >= "3.7" and python_version < "4"
+isort==5.10.1 ; python_version >= "3.7" and python_version < "4"
 jinja2==3.1.2 ; python_version >= "3.7" and python_version < "4"
 markdown-it-py==2.1.0 ; python_version >= "3.7" and python_version < "4"
 markdown==3.3.7 ; python_version >= "3.7" and python_version < "4"
diff --git a/tests/async_client/test_models.py b/tests/async_client/test_models.py
@@ -9,8 +9,8 @@
     AsyncResourceSet,
     NotYetEvaluatedError,
 )
-from connect.client.utils import ContentRange
 from connect.client.rql import R
+from connect.client.utils import ContentRange
 
 
 def test_ns_ns_invalid_type(async_ns_factory):
diff --git a/tests/client/test_fluent.py b/tests/client/test_fluent.py
@@ -1,15 +1,13 @@
 import io
 
 import pytest
-
 import responses
-
 from requests import RequestException, Timeout
 
 from connect.client.exceptions import ClientError
 from connect.client.fluent import ConnectClient
 from connect.client.logger import RequestLogger
-from connect.client.models import Collection, NS
+from connect.client.models import NS, Collection
 
 
 def test_default_headers():
diff --git a/tests/client/test_logger.py b/tests/client/test_logger.py
@@ -1,7 +1,6 @@
 import io
 
 from requests.models import Response
-
 from urllib3.response import HTTPResponse
 
 from connect.client.logger import RequestLogger
diff --git a/tests/client/test_models.py b/tests/client/test_models.py
@@ -1,9 +1,15 @@
 import pytest
 
 from connect.client.exceptions import ClientError
-from connect.client.models import Action, Collection, NS, Resource, ResourceSet
-from connect.client.utils import ContentRange
+from connect.client.models import (
+    NS,
+    Action,
+    Collection,
+    Resource,
+    ResourceSet,
+)
 from connect.client.rql import R
+from connect.client.utils import ContentRange
 
 
 def test_ns_ns_invalid_type(ns_factory):
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,12 +1,13 @@
 import sys
 
 import pytest
-
 import responses
 
 from connect.client.openapi import OpenAPISpecs
-from connect.client.testing.fixtures import async_client_mocker_factory, client_mocker_factory  # noqa
-
+from connect.client.testing.fixtures import (  # noqa
+    async_client_mocker_factory,
+    client_mocker_factory,
+)
 from tests.fixtures.client_models import (  # noqa
     action_factory,
     async_action_factory,
@@ -16,8 +17,8 @@
     async_res_factory,
     async_rs_factory,
     col_factory,
-    res_factory,
     ns_factory,
+    res_factory,
     rs_factory,
 )
 
diff --git a/tests/fixtures/client_models.py b/tests/fixtures/client_models.py
@@ -1,14 +1,14 @@
 import pytest
 
 from connect.client.models import (
+    NS,
     Action,
     AsyncAction,
     AsyncCollection,
     AsyncNS,
     AsyncResource,
     AsyncResourceSet,
     Collection,
-    NS,
     Resource,
     ResourceSet,
 )
diff --git a/tox.ini b/tox.ini
@@ -2,6 +2,5 @@
 exclude = .eggs,build,dist,.idea,.vscode,.git,pg_data,venv,*/settings/*.py,*/migrations/*.py,docs/*
 show-source = True
 max-line-length = 100
-application-import-names = smarkets
 max-cognitive-complexity = 15
-ignore = FI1,I100,W503
+ignore = FI1,W503

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,5 @@`
`5`	`5`	`#`
`6`	`6`	`from connect.client.exceptions import ClientError # noqa`
`7`	`7`	`from connect.client.fluent import AsyncConnectClient, ConnectClient # noqa`
	`8`	`+from connect.client.logger import RequestLogger # noqa`
`8`	`9`	`from connect.client.rql import R # noqa`
`9`		`-from connect.client.logger import RequestLogger # noqa`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,8 @@`
`13`	`13`	`ValuesListIterator,`
`14`	`14`	`aiter,`
`15`	`15`	`)`
`16`		`-from connect.client.utils import parse_content_range, resolve_attribute`
`17`	`16`	`from connect.client.rql import R`
	`17`	`+from connect.client.utils import parse_content_range, resolve_attribute`
`18`	`18`
`19`	`19`
`20`	`20`	`class _ResourceSetBase:`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,10 @@`
`3`	`3`	`#`
`4`	`4`	`# Copyright (c) 2021 Ingram Micro. All Rights Reserved.`
`5`	`5`	`#`
`6`		`-from io import StringIO`
`7`	`6`	`from functools import partial`
	`7`	`+from io import StringIO`
`8`	`8`
`9`	`9`	`import requests`
`10`		`-`
`11`	`10`	`import yaml`
`12`	`11`
`13`	`12`