[isort] Lib modules (#1016)

* isort `proxy.py` main class

* isort init and main

* isort common

* pre-commit fix

* isort dashboard and testing

* isort plugins

* isort core

* Only sort top level http py files

* isort http exception and websocket

* Remove proxy auth plugin from proxy package exports and force discover `PLUGIN_PROXY_AUTH` flags

* isort parser and web server

* no setattr

* isort all

* Enable pre-commit isort hook

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: abhinavsingh

.pre-commit-config.yaml

@@ -7,12 +7,12 @@ repos:
     args:
     - --py36-plus
 
-# - repo: https://github.com/timothycrosley/isort.git
-#   rev: 5.10.0
-#   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
@@ -24,8 +24,7 @@ repos:
         helper/proxy\.pac|
         Makefile|
         proxy/common/pki\.py|
-        README\.md|
-        .+\.(plist|pbxproj)
+        README\.md
       $
 
 - repo: https://github.com/pre-commit/pre-commit-hooks.git
@@ -36,7 +35,6 @@ repos:
     exclude: |
       (?x)
       ^
-        \.github/workflows/codeql-analysis\.yml|
         dashboard/src/core/plugins/inspect_traffic\.json
       $
   - id: check-merge-conflict

benchmark/_blacksheep.py

@@ -9,7 +9,6 @@
     :license: BSD, see LICENSE for more details.
 """
 import uvicorn
-
 from blacksheep.server import Application
 from blacksheep.server.responses import text
 

benchmark/_proxy.py

@@ -10,6 +10,7 @@
 """
 import time
 import ipaddress
+
 import proxy
 
 

benchmark/_starlette.py

@@ -9,10 +9,9 @@
     :license: BSD, see LICENSE for more details.
 """
 import uvicorn
-
-from starlette.applications import Starlette
-from starlette.responses import Response
 from starlette.routing import Route
+from starlette.responses import Response
+from starlette.applications import Starlette
 
 
 async def homepage(request):    # type: ignore[no-untyped-def]

benchmark/_tornado.py

@@ -8,8 +8,8 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-import tornado.ioloop
 import tornado.web
+import tornado.ioloop
 
 
 # pylint: disable=W0223

docs/_ext/spelling_stub_ext.py

@@ -2,9 +2,9 @@
 
 from typing import List
 
+from sphinx.util.nodes import nodes
 from sphinx.application import Sphinx
 from sphinx.util.docutils import SphinxDirective
-from sphinx.util.nodes import nodes
 
 
 class SpellingNoOpDirective(SphinxDirective):

docs/conf.py

@@ -4,8 +4,8 @@
 """Configuration for the Sphinx documentation generator."""
 
 import sys
-from functools import partial
 from pathlib import Path
+from functools import partial
 
 from setuptools_scm import get_version
 

examples/web_scraper.py

@@ -11,8 +11,8 @@
 import time
 
 from proxy import Proxy
-from proxy.common.types import Readables, Writables, SelectableEvents
 from proxy.core.work import Work
+from proxy.common.types import Readables, Writables, SelectableEvents
 from proxy.core.connection import TcpClientConnection
 
 

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, sleep_loop
+from .proxy import Proxy, main, sleep_loop, entry_point
 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  # noqa: WPS433, WPS436
 except ImportError:     # pragma: no cover
     from pkg_resources import get_distribution as _get_dist  # noqa: WPS433
     __version__ = _get_dist('proxy.py').version  # noqa: WPS440

proxy/common/backports.py

@@ -10,9 +10,8 @@
 """
 import time
 import threading
-
-from typing import Any, Deque
 from queue import Empty
+from typing import Any, Deque
 from collections import deque
 
 

proxy/common/constants.py

@@ -11,16 +11,16 @@
 import os
 import sys
 import time
-import secrets
 import pathlib
+import secrets
 import platform
-import sysconfig
 import ipaddress
-
+import sysconfig
 from typing import Any, List
 
 from .version import __version__
 
+
 SYS_PLATFORM = platform.system()
 IS_WINDOWS = SYS_PLATFORM == 'Windows'
 
@@ -150,9 +150,9 @@ def _env_threadless_compliant() -> bool:
     'HttpWebServerBasePlugin',
     'WebSocketTransportBasePlugin',
 ]
-PLUGIN_PROXY_AUTH = 'proxy.http.proxy.AuthPlugin'
 PLUGIN_DASHBOARD = 'proxy.dashboard.ProxyDashboard'
 PLUGIN_HTTP_PROXY = 'proxy.http.proxy.HttpProxyPlugin'
+PLUGIN_PROXY_AUTH = 'proxy.http.proxy.auth.AuthPlugin'
 PLUGIN_WEB_SERVER = 'proxy.http.server.HttpWebServerPlugin'
 PLUGIN_PAC_FILE = 'proxy.http.server.HttpWebServerPacFilePlugin'
 PLUGIN_DEVTOOLS_PROTOCOL = 'proxy.http.inspector.devtools.DevtoolsProtocolPlugin'

proxy/common/flag.py

@@ -16,20 +16,22 @@
 import ipaddress
 import collections
 import multiprocessing
+from typing import Any, List, Optional, cast
 
-from typing import Optional, List, Any, cast
-
-from .plugins import Plugins
 from .types import IpAddress
 from .utils import bytes_, is_py2, is_threadless, 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, IS_WINDOWS, PLUGIN_WEBSOCKET_TRANSPORT
 from .logger import Logger
-
+from .plugins import Plugins
 from .version import __version__
+from .constants import (
+    COMMA, IS_WINDOWS, PLUGIN_PAC_FILE, PLUGIN_DASHBOARD, PLUGIN_HTTP_PROXY,
+    PLUGIN_PROXY_AUTH, PLUGIN_WEB_SERVER, DEFAULT_NUM_WORKERS,
+    DEFAULT_NUM_ACCEPTORS, PLUGIN_INSPECT_TRAFFIC, DEFAULT_DISABLE_HEADERS,
+    PY2_DEPRECATION_MESSAGE, DEFAULT_DEVTOOLS_WS_PATH,
+    PLUGIN_DEVTOOLS_PROTOCOL, PLUGIN_WEBSOCKET_TRANSPORT,
+    DEFAULT_DATA_DIRECTORY_PATH, DEFAULT_MIN_COMPRESSION_LIMIT,
+)
+
 
 __homepage__ = 'https://github.com/abhinavsingh/proxy.py'
 
@@ -96,13 +98,17 @@ def initialize(
             print(PY2_DEPRECATION_MESSAGE)
             sys.exit(1)
 
+        # Dirty hack to always discover --basic-auth flag
+        # defined by proxy auth plugin.
+        in_args = input_args + ['--plugin', PLUGIN_PROXY_AUTH]
+
         # Discover flags from requested plugin.
         # This will also surface external plugin flags
         # under --help.
-        Plugins.discover(input_args)
+        Plugins.discover(in_args)
 
         # Parse flags
-        args = flags.parse_args(input_args)
+        args = flags.parse_args(in_args)
 
         # Print version and exit
         if args.version:
@@ -135,9 +141,11 @@ def initialize(
             if isinstance(work_klass, str) \
             else work_klass
 
+        # TODO: Plugin flag initialization logic must be moved within plugins.
+        #
         # Generate auth_code required for basic authentication if enabled
         auth_code = None
-        basic_auth = opts.get('basic_auth', args.basic_auth)
+        basic_auth = opts.get('basic_auth', getattr(args, 'basic_auth', None))
         # Destroy passed credentials via flags or options
         args.basic_auth = None
         if 'basic_auth' in opts:

proxy/common/logger.py

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

proxy/common/pki.py

@@ -14,19 +14,18 @@
 """
 import os
 import sys
-import uuid
 import time
+import uuid
 import logging
-import tempfile
 import argparse
+import tempfile
 import contextlib
 import subprocess
-
-from typing import List, Generator, Optional, Tuple
+from typing import List, Tuple, Optional, Generator
 
 from .utils import bytes_
-from .constants import COMMA
 from .version import __version__
+from .constants import COMMA
 
 
 logger = logging.getLogger(__name__)

proxy/common/plugins.py

@@ -9,15 +9,15 @@
     :license: BSD, see LICENSE for more details.
 """
 import os
-import logging
 import inspect
-import itertools
+import logging
 import importlib
+import itertools
+from typing import Any, Dict, List, Tuple, Union, Optional
 
-from typing import Any, List, Dict, Optional, Tuple, Union
+from .utils import text_, bytes_
+from .constants import DOT, COMMA, DEFAULT_ABC_PLUGINS
 
-from .utils import bytes_, text_
-from .constants import DOT, DEFAULT_ABC_PLUGINS, COMMA
 
 logger = logging.getLogger(__name__)
 

proxy/common/types.py

@@ -10,8 +10,7 @@
 """
 import queue
 import ipaddress
-
-from typing import TYPE_CHECKING, Dict, Any, List, Tuple, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Tuple, Union
 
 
 if TYPE_CHECKING:   # pragma: no cover

proxy/common/utils.py

@@ -12,22 +12,22 @@
 
        utils
 """
-import sys
 import ssl
+import sys
 import socket
 import logging
 import functools
 import ipaddress
 import contextlib
-
 from types import TracebackType
-from typing import Optional, Dict, Any, List, Tuple, Type, Callable
+from typing import Any, Dict, List, Type, Tuple, Callable, Optional
 
 from .constants import (
-    HTTP_1_1, COLON, WHITESPACE, CRLF,
-    DEFAULT_TIMEOUT, DEFAULT_THREADLESS, IS_WINDOWS,
+    CRLF, COLON, HTTP_1_1, IS_WINDOWS, WHITESPACE, DEFAULT_TIMEOUT,
+    DEFAULT_THREADLESS,
 )
 
+
 if not IS_WINDOWS:  # pragma: no cover
     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'

proxy/core/acceptor/__init__.py

@@ -12,9 +12,10 @@
 
        pre
 """
-from .listener import Listener
-from .acceptor import Acceptor
 from .pool import AcceptorPool
+from .acceptor import Acceptor
+from .listener import Listener
+
 
 __all__ = [
     'Listener',

proxy/core/acceptor/acceptor.py

@@ -19,20 +19,17 @@
 import threading
 import multiprocessing
 import multiprocessing.synchronize
-
+from typing import List, Tuple, Optional
 from multiprocessing import connection
 from multiprocessing.reduction import recv_handle
 
-from typing import List, Optional, Tuple
-
+from ..work import LocalExecutor, start_threaded_work, delegate_work_to_pool
+from ..event import EventQueue
 from ...common.flag import flags
 from ...common.logger import Logger
 from ...common.backports import NonBlockingQueue
 from ...common.constants import DEFAULT_LOCAL_EXECUTOR
 
-from ..event import EventQueue
-
-from ..work import LocalExecutor, delegate_work_to_pool, start_threaded_work
 
 logger = logging.getLogger(__name__)