enforce isort

Author: Richardk2n

.github/workflows/python-package.yml

@@ -38,6 +38,10 @@ jobs:
       run: |
         # stop the build if black detect any changes
         black --check .
+    - name: Check isort sorting
+      run: |
+        # stop the build if isort detect any changes
+        isort . --check --diff
     - name: Test with pytest
       run: |
         pytest

.pre-commit-config.yaml

@@ -8,4 +8,8 @@ repos:
   - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
     rev: v1.0.1
     hooks:
-      - id: rst-linter
+      - id: rst-linter
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort

README.rst

@@ -78,6 +78,8 @@ Install development dependencies with (you might want to create a virtualenv fir
 
 The project is formatted with `black`_. You can either configure your IDE to automatically format code with it, run it manually (``black .``) or rely on pre-commit (see below) to format files on git commit.
 
+The project is formatted with `isort`_. You can either configure your IDE to automatically sort imports with it, run it manually (``isort .``) or rely on pre-commit (see below) to sort files on git commit.
+
 The project uses two rst tests in order to assure uploadability to pypi: `rst-linter`_ as a pre-commit hook and `rstcheck`_ in a GitHub workflow. This does not catch all errors.
 
 This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
@@ -89,6 +91,7 @@ This project uses `pre-commit`_ to enforce code-quality. After cloning the repos
 After that pre-commit will run `all defined hooks`_ on every ``git commit`` and keep you from committing if there are any errors.
 
 .. _black: https://github.com/psf/black
+.. _isort: https://github.com/PyCQA/isort
 .. _rst-linter: https://github.com/Lucas-C/pre-commit-hooks-markup
 .. _rstcheck: https://github.com/myint/rstcheck
 .. _pre-commit: https://pre-commit.com/

pylsp_mypy/__init__.py

@@ -1 +0,0 @@
-

pylsp_mypy/plugin.py

@@ -6,23 +6,24 @@
 
 @author: Richard Kellnberger
 """
-import re
-import tempfile
+import ast
+import atexit
+import collections
+import logging
 import os
 import os.path
+import re
+import shutil
 import subprocess
+import tempfile
+import warnings
 from pathlib import Path
-import logging
+from typing import IO, Any, Dict, List, Optional
+
 from mypy import api as mypy_api
 from pylsp import hookimpl
-from pylsp.workspace import Document, Workspace
 from pylsp.config.config import Config
-from typing import Optional, Dict, Any, IO, List
-import atexit
-import collections
-import warnings
-import shutil
-import ast
+from pylsp.workspace import Document, Workspace
 
 line_pattern: str = r"((?:^[a-z]:)?[^:]+):(?:(\d+):)?(?:(\d+):)? (\w+): (.*)"
 

pyproject.toml

@@ -12,3 +12,7 @@ exclude = '''
   | dist
 )/
 '''
+
+[tool.isort]
+profile = "black"
+line_length = 100

requirements.txt

@@ -3,3 +3,4 @@ mypy
 black
 pre-commit
 rstcheck
+isort

setup.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 from setuptools import setup
+
 from pylsp_mypy import _version
 
 if __name__ == "__main__":

test/test_plugin.py

@@ -1,11 +1,12 @@
-import pytest
+import collections
+from unittest.mock import Mock
 
-from pylsp.workspace import Workspace, Document
-from pylsp.config.config import Config
+import pytest
 from pylsp import uris
-from unittest.mock import Mock
+from pylsp.config.config import Config
+from pylsp.workspace import Document, Workspace
+
 from pylsp_mypy import plugin
-import collections
 
 DOC_URI = __file__
 DOC_TYPE_ERR = """{}.append(3)
@@ -140,8 +141,8 @@ def test_apply_overrides():
 
 def test_option_overrides(tmpdir, last_diagnostics_monkeypatch, workspace):
     import sys
-    from textwrap import dedent
     from stat import S_IRWXU
+    from textwrap import dedent
 
     sentinel = tmpdir / "ran"