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_party = 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

examples/https_connect_tunnel.py

@@ -11,13 +11,13 @@
 import time
 from typing import Any, Optional
 
-from proxy.proxy import Proxy
 from proxy.common.utils import build_http_response
-from proxy.http.codes import httpStatusCodes
-from proxy.http.parser import httpParserStates
-from proxy.http.methods import httpMethods
 from proxy.core.acceptor import AcceptorPool
 from proxy.core.base import BaseTcpTunnelHandler
+from proxy.http.codes import httpStatusCodes
+from proxy.http.methods import httpMethods
+from proxy.http.parser import httpParserStates
+from proxy.proxy import Proxy
 
 
 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
+import multiprocessing
+import time
+from typing import Any, Dict
 
 from proxy.core.event import EventQueue, EventSubscriber, eventNames
 from proxy.core.event.manager import EventManager
 
+
 # Enable debug logging to view core event logs
 logging.basicConfig(level=logging.DEBUG)
 

examples/ssl_echo_client.py

@@ -8,8 +8,9 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-from proxy.core.connection import TcpServerConnection
 from proxy.common.constants import DEFAULT_BUFFER_SIZE
+from proxy.core.connection import TcpServerConnection
+
 
 if __name__ == '__main__':
     client = TcpServerConnection('::', 12345)

examples/ssl_echo_server.py

@@ -11,12 +11,11 @@
 import time
 from typing import Optional
 
-from proxy.proxy import Proxy
 from proxy.common.utils import wrap_socket
 from proxy.core.acceptor import AcceptorPool
-from proxy.core.connection import TcpClientConnection
-
 from proxy.core.base import BaseTcpServerHandler
+from proxy.core.connection import TcpClientConnection
+from proxy.proxy import Proxy
 
 
 class EchoSSLServerHandler(BaseTcpServerHandler):

examples/tcp_echo_client.py

@@ -8,8 +8,9 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-from proxy.common.utils import socket_connection
 from proxy.common.constants import DEFAULT_BUFFER_SIZE
+from proxy.common.utils import socket_connection
+
 
 if __name__ == '__main__':
     with socket_connection(('::', 12345)) as client:

examples/tcp_echo_server.py

@@ -11,9 +11,9 @@
 import time
 from typing import Optional
 
-from proxy.proxy import Proxy
 from proxy.core.acceptor import AcceptorPool
 from proxy.core.base import BaseTcpServerHandler
+from proxy.proxy import Proxy
 
 
 class EchoServerHandler(BaseTcpServerHandler):

examples/websocket_client.py

@@ -9,6 +9,7 @@
     :license: BSD, see LICENSE for more details.
 """
 import time
+
 from proxy.http.websocket import WebsocketClient, WebsocketFrame, websocketOpcodes
 
 

proxy/__init__.py

@@ -8,9 +8,10 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-from .proxy import entry_point, main, Proxy
+from .proxy import Proxy, entry_point, main
 from .testing.test_case 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/constants.py

@@ -8,15 +8,15 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
+import ipaddress
 import os
-import time
 import pathlib
-import ipaddress
-
+import time
 from typing import List
 
 from .version import __version__
 
+
 PROXY_PY_START_TIME = time.time()
 
 # /path/to/proxy.py/proxy folder

proxy/common/flag.py

@@ -9,10 +9,11 @@
     :license: BSD, see LICENSE for more details.
 """
 import argparse
-from typing import Optional, List, Any
+from typing import Any, List, Optional
 
 from .version import __version__
 
+
 __homepage__ = 'https://github.com/abhinavsingh/proxy.py'
 
 

proxy/common/pki.py

@@ -8,19 +8,19 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import time
-import sys
 import argparse
 import contextlib
+import logging
 import os
-import uuid
 import subprocess
+import sys
 import tempfile
-import logging
-from typing import List, Generator, Optional, Tuple
+import time
+import uuid
+from typing import Generator, List, Optional, Tuple
 
-from .utils import bytes_
 from .constants import COMMA
+from .utils import bytes_
 from .version import __version__
 
 

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

@@ -8,18 +8,17 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import ssl
-import socket
-import logging
+import contextlib
 import functools
 import ipaddress
-import contextlib
-
+import logging
+import socket
+import ssl
 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 .constants import HTTP_1_1, COLON, WHITESPACE, CRLF, DEFAULT_TIMEOUT
-from .constants import DEFAULT_LOG_FILE, DEFAULT_LOG_FORMAT, DEFAULT_LOG_LEVEL
+from .constants import COLON, CRLF, DEFAULT_LOG_FILE, DEFAULT_LOG_FORMAT, DEFAULT_LOG_LEVEL, DEFAULT_TIMEOUT, HTTP_1_1
+from .constants import WHITESPACE
 
 
 def text_(s: Any, encoding: str = 'utf-8', errors: str = 'strict') -> Any:

proxy/core/acceptor/__init__.py

@@ -10,8 +10,9 @@
 """
 from .acceptor import Acceptor
 from .pool import AcceptorPool
-from .work import Work
 from .threadless import Threadless
+from .work import Work
+
 
 __all__ = [
     'Acceptor',

proxy/core/acceptor/acceptor.py

@@ -15,19 +15,18 @@
 import selectors
 import socket
 import threading
-
 from multiprocessing import connection
-from multiprocessing.reduction import send_handle, recv_handle
-from typing import Optional, Type, Tuple
-
-from .work import Work
-from .threadless import Threadless
+from multiprocessing.reduction import recv_handle, send_handle
+from typing import Optional, Tuple, Type
 
-from ..connection import TcpClientConnection
-from ..event import EventQueue, eventNames
 from ...common.constants import DEFAULT_THREADLESS
 from ...common.flag import flags
 from ...common.utils import setup_logger
+from ..connection import TcpClientConnection
+from ..event import EventQueue, eventNames
+from .threadless import Threadless
+from .work import Work
+
 
 logger = logging.getLogger(__name__)
 

proxy/core/acceptor/pool.py

@@ -12,18 +12,16 @@
 import logging
 import multiprocessing
 import socket
-
 from multiprocessing import connection
 from multiprocessing.reduction import send_handle
 from typing import List, Optional, Type
 
+from ...common.constants import DEFAULT_BACKLOG, DEFAULT_IPV6_HOSTNAME, DEFAULT_NUM_WORKERS, DEFAULT_PORT
+from ...common.flag import flags
+from ..event import EventQueue
 from .acceptor import Acceptor
 from .work import Work
 
-from ..event import EventQueue
-
-from ...common.flag import flags
-from ...common.constants import DEFAULT_BACKLOG, DEFAULT_IPV6_HOSTNAME, DEFAULT_NUM_WORKERS, DEFAULT_PORT
 
 logger = logging.getLogger(__name__)
 

proxy/core/acceptor/threadless.py

@@ -9,26 +9,24 @@
     :license: BSD, see LICENSE for more details.
 """
 import argparse
-import os
-import socket
-import logging
 import asyncio
-import selectors
 import contextlib
+import logging
 import multiprocessing
+import os
+import selectors
+import socket
 from multiprocessing import connection
 from multiprocessing.reduction import recv_handle
+from typing import Any, Dict, Generator, List, Optional, Tuple, Type
 
-from typing import Dict, Optional, Tuple, List, Generator, Any, Type
-
-from .work import Work
-
+from ...common.constants import DEFAULT_TIMEOUT
+from ...common.types import Readables, Writables
+from ...common.utils import setup_logger
 from ..connection import TcpClientConnection
 from ..event import EventQueue, eventNames
+from .work import Work
 
-from ...common.utils import setup_logger
-from ...common.types import Readables, Writables
-from ...common.constants import DEFAULT_TIMEOUT
 
 logger = logging.getLogger(__name__)
 

proxy/core/acceptor/work.py

@@ -10,14 +10,13 @@
 """
 import argparse
 import socket
-
 from abc import ABC, abstractmethod
-from uuid import uuid4, UUID
-from typing import Optional, Dict, Any
+from typing import Any, Dict, Optional
+from uuid import UUID, uuid4
 
-from ..event import eventNames, EventQueue
-from ..connection import TcpClientConnection
 from ...common.types import Readables, Writables
+from ..connection import TcpClientConnection
+from ..event import EventQueue, eventNames
 
 
 class Work(ABC):

proxy/core/base/__init__.py

@@ -11,6 +11,7 @@
 from .tcp_server import BaseTcpServerHandler
 from .tcp_tunnel import BaseTcpTunnelHandler
 
+
 __all__ = [
     'BaseTcpServerHandler',
     'BaseTcpTunnelHandler',