Enable isort in the pre-commit tool settings

Author: webknjaz

.flake8

@@ -28,7 +28,6 @@ extend-exclude =
 # IMPORTANT: avoid using ignore option, always use extend-ignore instead
 # Completely and unconditionally ignore the following errors:
 extend-ignore =
-  I  # flake8-isort is drunk + we have isort integrated into pre-commit
   B009    # FIXME: `getattr()` called with a constant arg
   C812    # FIXME: missing trailing comma
   C819    # FIXME: inline trailing comma

.isort.cfg

@@ -0,0 +1,25 @@
+# https://github.com/timothycrosley/isort/wiki/isort-Settings
+[settings]
+default_section = THIRDPARTY
+# force_to_top=file1.py,file2.py
+# forced_separate = django.contrib,django.utils
+include_trailing_comma = true
+indent = 4
+known_first_party = proxy
+# known_future_library = future,pies
+# known_standard_library = std,std2
+known_testing = pytest,unittest
+# length_sort = 1
+# Should be: 80 - 1
+#line_length = 79
+line_length = 127
+lines_after_imports = 2
+# https://pycqa.github.io/isort/docs/configuration/multi_line_output_modes.html
+# NOTE: Another mode could be "5" for grouping multiple "import from" under
+# NOTE: a single instruction.
+multi_line_output = 9
+no_lines_before = LOCALFOLDER
+sections=FUTURE,STDLIB,TESTING,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+# skip=file3.py,file4.py
+use_parentheses = true
+verbose = true

.pre-commit-config.yaml

@@ -7,12 +7,12 @@ repos:
     args:
     - --py36-plus
 
-# - repo: https://github.com/timothycrosley/isort.git
-#   rev: 5.4.2
-#   hooks:
-#   - id: isort
-#     args:
-#     - --honor-noqa
+- repo: https://github.com/timothycrosley/isort.git
+  rev: 5.10.0
+  hooks:
+  - id: isort
+    args:
+    - --honor-noqa
 
 - repo: https://github.com/Lucas-C/pre-commit-hooks.git
   rev: v1.1.7

check.py

@@ -8,12 +8,13 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import sys
 import subprocess
-
+import sys
 from pathlib import Path
+
 from proxy.common.version import __version__ as lib_version
 
+
 # This script ensures our versions never run out of sync.
 #
 # 1. TODO: Version is hardcoded in homebrew stable package

examples/https_connect_tunnel.py

@@ -9,14 +9,13 @@
     :license: BSD, see LICENSE for more details.
 """
 import time
-
 from typing import Any, Optional
 
 from proxy import Proxy
 from proxy.common.utils import build_http_response
+from proxy.core.base import BaseTcpTunnelHandler
 from proxy.http import httpStatusCodes
 from proxy.http.parser import httpParserStates
-from proxy.core.base import BaseTcpTunnelHandler
 
 
 class HttpsConnectTunnelHandler(BaseTcpTunnelHandler):

examples/pubsub_eventing.py

@@ -8,15 +8,15 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import time
-import multiprocessing
 import logging
-
-from typing import Dict, Any, Optional
+import multiprocessing
+import time
+from typing import Any, Dict, Optional
 
 from proxy.common.constants import DEFAULT_LOG_FORMAT
 from proxy.core.event import EventManager, EventQueue, EventSubscriber, eventNames
 
+
 logging.basicConfig(level=logging.DEBUG, format=DEFAULT_LOG_FORMAT)
 
 logger = logging.getLogger(__name__)

examples/ssl_echo_client.py

@@ -10,8 +10,9 @@
 """
 import logging
 
-from proxy.core.connection import TcpServerConnection
 from proxy.common.constants import DEFAULT_BUFFER_SIZE
+from proxy.core.connection import TcpServerConnection
+
 
 logger = logging.getLogger(__name__)
 

examples/ssl_echo_server.py

@@ -13,9 +13,8 @@
 
 from proxy import Proxy
 from proxy.common.utils import wrap_socket
-from proxy.core.connection import TcpClientConnection
-
 from proxy.core.base import BaseTcpServerHandler
+from proxy.core.connection import TcpClientConnection
 
 
 class EchoSSLServerHandler(BaseTcpServerHandler):

examples/tcp_echo_client.py

@@ -10,8 +10,9 @@
 """
 import logging
 
-from proxy.common.utils import socket_connection
 from proxy.common.constants import DEFAULT_BUFFER_SIZE
+from proxy.common.utils import socket_connection
+
 
 logger = logging.getLogger(__name__)
 

examples/web_scraper.py

@@ -8,14 +8,13 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import time
 import socket
-
+import time
 from typing import Dict
 
 from proxy import Proxy
-from proxy.core.acceptor import Work
 from proxy.common.types import Readables, Writables
+from proxy.core.acceptor import Work
 
 
 class WebScraper(Work):

examples/websocket_client.py

@@ -8,11 +8,12 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import time
 import logging
+import time
 
 from proxy.http.websocket import WebsocketClient, WebsocketFrame, websocketOpcodes
 
+
 # globals
 client: WebsocketClient
 last_dispatch_time: float

proxy/__init__.py

@@ -14,9 +14,10 @@
        Submodules
        Subpackages
 """
-from .proxy import entry_point, main, Proxy
+from .proxy import Proxy, entry_point, main
 from .testing import TestCase
 
+
 __all__ = [
     # PyPi package entry_point. See
     # https://github.com/abhinavsingh/proxy.py#from-command-line-when-installed-using-pip

proxy/__main__.py

@@ -10,5 +10,6 @@
 """
 from .proxy import entry_point
 
+
 if __name__ == '__main__':
     entry_point()

proxy/common/_scm_version.pyi

@@ -2,5 +2,6 @@
 # autogenerated on build and absent on mypy checks time
 from typing import Tuple, Union
 
+
 version: str
 version_tuple: Tuple[Union[int, str], ...]

proxy/common/_version.py

@@ -12,9 +12,11 @@
 """
 from typing import Tuple, Union
 
+
 try:
     # pylint: disable=unused-import
-    from ._scm_version import version as __version__, version_tuple as _ver_tup  # noqa: WPS433, WPS436
+    from ._scm_version import version as __version__  # noqa: WPS433, WPS436
+    from ._scm_version import version_tuple as _ver_tup
 except ImportError:
     from pkg_resources import get_distribution as _get_dist  # noqa: WPS433
     __version__ = _get_dist('proxy.py').version  # noqa: WPS440

proxy/common/constants.py

@@ -8,14 +8,13 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
+import ipaddress
 import os
-import sys
-import time
-import secrets
 import pathlib
+import secrets
+import sys
 import sysconfig
-import ipaddress
-
+import time
 from typing import Any, List
 
 from ._compat import IS_WINDOWS  # noqa: WPS436

proxy/common/flag.py

@@ -8,30 +8,28 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import os
-import sys
-import base64
-import socket
 import argparse
-import ipaddress
+import base64
 import collections
+import ipaddress
 import multiprocessing
-
-from typing import Optional, List, Any, cast
+import os
+import socket
+import sys
+from typing import Any, List, Optional, cast
 
 from ._compat import IS_WINDOWS  # noqa: WPS436
+from .constants import COMMA, DEFAULT_DATA_DIRECTORY_PATH, DEFAULT_DEVTOOLS_WS_PATH, DEFAULT_DISABLE_HEADERS
+from .constants import DEFAULT_MIN_COMPRESSION_LIMIT, DEFAULT_NUM_ACCEPTORS, DEFAULT_NUM_WORKERS, PLUGIN_DASHBOARD
+from .constants import PLUGIN_DEVTOOLS_PROTOCOL, PLUGIN_HTTP_PROXY, PLUGIN_INSPECT_TRAFFIC, PLUGIN_PAC_FILE, PLUGIN_PROXY_AUTH
+from .constants import PLUGIN_WEB_SERVER, PY2_DEPRECATION_MESSAGE
+from .logger import Logger
 from .plugins import Plugins
 from .types import IpAddress
 from .utils import bytes_, is_py2, set_open_file_limit
-from .constants import COMMA, DEFAULT_DATA_DIRECTORY_PATH, DEFAULT_NUM_ACCEPTORS, DEFAULT_NUM_WORKERS
-from .constants import DEFAULT_DEVTOOLS_WS_PATH, DEFAULT_DISABLE_HEADERS, PY2_DEPRECATION_MESSAGE
-from .constants import PLUGIN_DASHBOARD, PLUGIN_DEVTOOLS_PROTOCOL, DEFAULT_MIN_COMPRESSION_LIMIT
-from .constants import PLUGIN_HTTP_PROXY, PLUGIN_INSPECT_TRAFFIC, PLUGIN_PAC_FILE
-from .constants import PLUGIN_WEB_SERVER, PLUGIN_PROXY_AUTH
-from .logger import Logger
-
 from .version import __version__
 
+
 __homepage__ = 'https://github.com/abhinavsingh/proxy.py'
 
 

proxy/common/logger.py

@@ -9,11 +9,11 @@
     :license: BSD, see LICENSE for more details.
 """
 import logging
-
-from typing import Optional, Any
+from typing import Any, Optional
 
 from .constants import DEFAULT_LOG_FILE, DEFAULT_LOG_FORMAT, DEFAULT_LOG_LEVEL
 
+
 SINGLE_CHAR_TO_LEVEL = {
     'D': 'DEBUG',
     'I': 'INFO',

proxy/common/pki.py

@@ -12,20 +12,19 @@
 
        pki
 """
-import os
-import sys
-import uuid
-import time
-import logging
-import tempfile
 import argparse
 import contextlib
+import logging
+import os
 import subprocess
+import sys
+import tempfile
+import time
+import uuid
+from typing import Generator, List, Optional, Tuple
 
-from typing import List, Generator, Optional, Tuple
-
-from .utils import bytes_
 from .constants import COMMA
+from .utils import bytes_
 from .version import __version__
 
 

proxy/common/plugins.py

@@ -8,17 +8,17 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import os
 import abc
-import logging
+import importlib
 import inspect
 import itertools
-import importlib
-
-from typing import Any, List, Dict, Optional, Tuple, Union
+import logging
+import os
+from typing import Any, Dict, List, Optional, Tuple, Union
 
+from .constants import COMMA, DEFAULT_ABC_PLUGINS, DOT
 from .utils import bytes_, text_
-from .constants import DOT, DEFAULT_ABC_PLUGINS, COMMA
+
 
 logger = logging.getLogger(__name__)
 

proxy/common/types.py

@@ -8,11 +8,11 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import queue
 import ipaddress
+import queue
 import sys
+from typing import TYPE_CHECKING, Any, Dict, List, Union
 
-from typing import TYPE_CHECKING, Dict, Any, List, Union
 
 # NOTE: Using try/except causes linting problems which is why it's necessary
 # NOTE: to use this mypy/pylint idiom for py36-py38 compatibility

proxy/common/utils.py

@@ -15,19 +15,19 @@
        Websocket
        WebSocket
 """
-import sys
-import ssl
-import socket
-import logging
+import contextlib
 import functools
 import ipaddress
-import contextlib
-
+import logging
+import socket
+import ssl
+import sys
 from types import TracebackType
-from typing import Optional, Dict, Any, List, Tuple, Type, Callable
+from typing import Any, Callable, Dict, List, Optional, Tuple, Type
 
 from ._compat import IS_WINDOWS  # noqa: WPS436
-from .constants import HTTP_1_1, COLON, WHITESPACE, CRLF, DEFAULT_TIMEOUT, DEFAULT_THREADLESS
+from .constants import COLON, CRLF, DEFAULT_THREADLESS, DEFAULT_TIMEOUT, HTTP_1_1, WHITESPACE
+
 
 if not IS_WINDOWS:
     import resource

proxy/common/version.py

@@ -8,7 +8,7 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-from ._version import __version__, VERSION  # noqa: WPS436
+from ._version import VERSION, __version__  # noqa: WPS436
 
 
 __all__ = '__version__', 'VERSION'