Introduce isort to check import order

.github/workflows/static.yml

@@ -39,9 +39,11 @@ jobs:
       # This error cannot be resolved by adding a pylint: disable=unused-argument comment ...
       - run: |
           pip install -e .[pylint,pycodestyle,pyflakes]
-          pip install black
+          pip install isort black
       - name: Pylint checks
         run: pylint pylsp test
+      - name: Check import order with isort
+        run: isort --check --profile black pylsp test
       - name: Code style checks with black
         run: black --check pylsp test
       - name: Pyflakes checks

pylsp/__init__.py

@@ -2,7 +2,9 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import os
+
 import pluggy
+
 from . import _version
 from ._version import __version__
 

pylsp/__main__.py

@@ -12,13 +12,13 @@
 except Exception:  # pylint: disable=broad-except
     import json
 
+from ._version import __version__
 from .python_lsp import (
     PythonLSPServer,
     start_io_lang_server,
     start_tcp_lang_server,
     start_ws_lang_server,
 )
-from ._version import __version__
 
 LOG_FORMAT = "%(asctime)s {0} - %(levelname)s - %(name)s - %(message)s".format(
     time.localtime().tm_zone

pylsp/config/config.py

@@ -10,7 +10,7 @@
 import pluggy
 from pluggy._hooks import HookImpl
 
-from pylsp import _utils, hookspecs, uris, PYLSP
+from pylsp import PYLSP, _utils, hookspecs, uris
 
 # See compatibility note on `group` keyword:
 #   https://docs.python.org/3/library/importlib.metadata.html#entry-points

pylsp/config/flake8_conf.py

@@ -3,7 +3,9 @@
 
 import logging
 import os
+
 from pylsp._utils import find_parents
+
 from .source import ConfigSource
 
 log = logging.getLogger(__name__)

pylsp/config/pycodestyle_conf.py

@@ -2,9 +2,10 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import pycodestyle
+
 from pylsp._utils import find_parents
-from .source import ConfigSource
 
+from .source import ConfigSource
 
 CONFIG_KEY = "pycodestyle"
 USER_CONFIGS = [pycodestyle.USER_CONFIG] if pycodestyle.USER_CONFIG else []

pylsp/plugins/_resolvers.py

@@ -1,15 +1,14 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
 
-from collections import defaultdict
 import logging
+from collections import defaultdict
 from time import time
 
 from jedi.api.classes import Completion
 
 from pylsp import lsp
 
-
 log = logging.getLogger(__name__)
 
 

pylsp/plugins/_rope_task_handle.py

@@ -1,13 +1,12 @@
 from __future__ import annotations
 
 import logging
-
 from typing import Callable, ContextManager, List, Optional, Sequence
 
 from rope.base.taskhandle import BaseJobSet, BaseTaskHandle
 
-from pylsp.workspace import Workspace
 from pylsp._utils import throttle
+from pylsp.workspace import Workspace
 
 log = logging.getLogger(__name__)
 Report = Callable[[str, int], None]

pylsp/plugins/autopep8_format.py

@@ -4,7 +4,8 @@
 import logging
 
 import pycodestyle
-from autopep8 import fix_code, continued_indentation as autopep8_c_i
+from autopep8 import continued_indentation as autopep8_c_i
+from autopep8 import fix_code
 
 from pylsp import hookimpl
 from pylsp._utils import get_eol_chars

pylsp/plugins/definition.py

@@ -1,16 +1,18 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
 from __future__ import annotations
+
 import logging
-from typing import Any, Dict, List, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Dict, List
 
 import jedi
 
-from pylsp import hookimpl, uris, _utils
+from pylsp import _utils, hookimpl, uris
 
 if TYPE_CHECKING:
     from jedi.api import Script
     from jedi.api.classes import Name
+
     from pylsp.config.config import Config
     from pylsp.workspace import Document
 

pylsp/plugins/highlight.py

@@ -2,7 +2,8 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import logging
-from pylsp import hookimpl, lsp, _utils
+
+from pylsp import _utils, hookimpl, lsp
 
 log = logging.getLogger(__name__)
 

pylsp/plugins/hover.py

@@ -3,7 +3,7 @@
 
 import logging
 
-from pylsp import hookimpl, _utils
+from pylsp import _utils, hookimpl
 
 log = logging.getLogger(__name__)
 

pylsp/plugins/jedi_rename.py

@@ -3,7 +3,7 @@
 
 import logging
 
-from pylsp import hookimpl, uris, _utils
+from pylsp import _utils, hookimpl, uris
 
 log = logging.getLogger(__name__)
 

pylsp/plugins/mccabe_lint.py

@@ -3,7 +3,9 @@
 
 import ast
 import logging
+
 import mccabe
+
 from pylsp import hookimpl, lsp
 
 log = logging.getLogger(__name__)

pylsp/plugins/preload_imports.py

@@ -2,6 +2,7 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import logging
+
 from pylsp import hookimpl
 
 log = logging.getLogger(__name__)

pylsp/plugins/pydocstyle_lint.py

@@ -8,6 +8,7 @@
 import sys
 
 import pydocstyle
+
 from pylsp import hookimpl, lsp
 
 log = logging.getLogger(__name__)

pylsp/plugins/pyflakes_lint.py

@@ -1,7 +1,9 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
 
-from pyflakes import api as pyflakes_api, messages
+from pyflakes import api as pyflakes_api
+from pyflakes import messages
+
 from pylsp import hookimpl, lsp
 
 # Pyflakes messages that should be reported as Errors instead of Warns

pylsp/plugins/pylint_lint.py

@@ -5,11 +5,11 @@
 """Linter plugin for pylint."""
 import collections
 import logging
-import sys
-import re
-from subprocess import Popen, PIPE
 import os
+import re
 import shlex
+import sys
+from subprocess import PIPE, Popen
 
 from pylsp import hookimpl, lsp
 

pylsp/plugins/references.py

@@ -2,7 +2,8 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import logging
-from pylsp import hookimpl, uris, _utils
+
+from pylsp import _utils, hookimpl, uris
 
 log = logging.getLogger(__name__)
 

pylsp/plugins/rope_autoimport.py

@@ -1,8 +1,8 @@
 # Copyright 2022- Python Language Server Contributors.
 
 import logging
-from typing import Any, Dict, Generator, List, Optional, Set, Union
 import threading
+from typing import Any, Dict, Generator, List, Optional, Set, Union
 
 import parso
 from jedi import Script

pylsp/plugins/rope_completion.py

@@ -2,11 +2,11 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import logging
+
 from rope.contrib.codeassist import code_assist, sorted_proposals
 
 from pylsp import _utils, hookimpl, lsp
 
-
 log = logging.getLogger(__name__)
 
 

pylsp/plugins/rope_rename.py

@@ -6,7 +6,7 @@
 from rope.base import libutils
 from rope.refactor.rename import Rename
 
-from pylsp import hookimpl, uris, _utils
+from pylsp import _utils, hookimpl, uris
 
 log = logging.getLogger(__name__)
 

pylsp/plugins/signature.py

@@ -3,7 +3,8 @@
 
 import logging
 import re
-from pylsp import hookimpl, _utils
+
+from pylsp import _utils, hookimpl
 
 log = logging.getLogger(__name__)
 

pylsp/plugins/yapf_format.py

@@ -4,11 +4,10 @@
 import logging
 import os
 
+import whatthepatch
 from yapf.yapflib import file_resources, style
 from yapf.yapflib.yapf_api import FormatCode
 
-import whatthepatch
-
 from pylsp import hookimpl
 from pylsp._utils import get_eol_chars
 

pylsp/python_lsp.py

@@ -1,23 +1,23 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
 
-from functools import partial
 import logging
 import os
 import socketserver
 import threading
 import uuid
-from typing import List, Dict, Any
-import ujson as json
+from functools import partial
+from typing import Any, Dict, List
 
+import ujson as json
 from pylsp_jsonrpc.dispatchers import MethodDispatcher
 from pylsp_jsonrpc.endpoint import Endpoint
 from pylsp_jsonrpc.streams import JsonRpcStreamReader, JsonRpcStreamWriter
 
-from . import lsp, _utils, uris
-from .config import config
-from .workspace import Workspace, Document, Notebook, Cell
+from . import _utils, lsp, uris
 from ._version import __version__
+from .config import config
+from .workspace import Cell, Document, Notebook, Workspace
 
 log = logging.getLogger(__name__)
 
@@ -109,6 +109,7 @@ def start_ws_lang_server(port, check_parent_process, handler_class):
     try:
         import asyncio
         from concurrent.futures import ThreadPoolExecutor
+
         import websockets
     except ImportError as e:
         raise ImportError(

pylsp/uris.py

@@ -7,6 +7,7 @@
 """
 import re
 from urllib import parse
+
 from pylsp import IS_WIN
 
 RE_DRIVE_LETTER_PATH = re.compile(r"^\/[a-zA-Z]:")

pylsp/workspace.py

@@ -1,19 +1,19 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
 
+import functools
 import io
 import logging
-from contextlib import contextmanager
 import os
 import re
 import uuid
-import functools
-from typing import Optional, Generator, Callable, List
+from contextlib import contextmanager
 from threading import RLock
+from typing import Callable, Generator, List, Optional
 
 import jedi
 
-from . import lsp, uris, _utils
+from . import _utils, lsp, uris
 
 log = logging.getLogger(__name__)
 

pyproject.toml

@@ -104,3 +104,6 @@ addopts = "--cov-report html --cov-report term --junitxml=pytest.xml --cov pylsp
 
 [tool.coverage.run]
 concurrency = ["multiprocessing", "thread"]
+
+[tool.isort]
+profile = "black"

setup.py

@@ -3,8 +3,7 @@
 # Copyright 2017-2020 Palantir Technologies, Inc.
 # Copyright 2021- Python Language Server Contributors.
 
-from setuptools import setup, find_packages
-
+from setuptools import find_packages, setup
 
 if __name__ == "__main__":
     setup(

test/__init__.py

@@ -2,8 +2,8 @@
 # Copyright 2021- Python Language Server Contributors.
 
 import pytest
-from pylsp import IS_WIN
 
+from pylsp import IS_WIN
 
 unix_only = pytest.mark.skipif(IS_WIN, reason="Unix only")
 windows_only = pytest.mark.skipif(not IS_WIN, reason="Windows only")

test/conftest.py

@@ -3,6 +3,7 @@
 
 """ py.test configuration"""
 import logging
+
 from pylsp.__main__ import LOG_FORMAT
 
 logging.basicConfig(level=logging.DEBUG, format=LOG_FORMAT)