Merge pull request #4 from haplo/black

Format codebase with black

Author: Richardk2n

.github/workflows/python-package.yml

@@ -34,6 +34,10 @@ jobs:
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Check black formatting
+      run: |
+        # stop the build if black detect any changes
+        black --check .
     - name: Test with pytest
       run: |
         pytest

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/psf/black
+    rev: 21.5b1
+    hooks:
+      - id: black

README.rst

@@ -26,7 +26,7 @@ Configuration
 
 ``live_mode`` (default is True) provides type checking as you type. This writes to a tempfile every time a check is done.
 
-Turning off live_mode means you must save your changes for mypy diagnostics to update correctly.
+Turning off ``live_mode`` means you must save your changes for mypy diagnostics to update correctly.
 
 Depending on your editor, the configuration (found in a file called mypy-ls.cfg in your workspace or a parent directory) should be roughly like this:
 
@@ -37,3 +37,26 @@ Depending on your editor, the configuration (found in a file called mypy-ls.cfg
         "live_mode": True,
         "strict": False
     }
+
+Developing
+-------------
+
+Install development dependencies with (you might want to create a virtualenv first):
+
+::
+
+   pip install -r requirements.txt
+
+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.
+
+This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
+
+::
+
+   pre-commit install
+
+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
+.. _pre-commit: https://pre-commit.com/
+.. _all defined hooks: .pre-commit-config.yaml

mypy_ls/plugin.py

@@ -27,7 +27,9 @@
 tmpFile: Optional[IO[str]] = None
 
 
-def parse_line(line: str, document: Optional[Document] = None) -> Optional[Dict[str, Any]]:
+def parse_line(
+    line: str, document: Optional[Document] = None
+) -> Optional[Dict[str, Any]]:
     """
     Return a language-server diagnostic from a line of the Mypy error report.
 
@@ -54,42 +56,44 @@ def parse_line(line: str, document: Optional[Document] = None) -> Optional[Dict[
         if file_path != "<string>":  # live mode
             # results from other files can be included, but we cannot return
             # them.
-            if document and document.path and not document.path.endswith(
-                    file_path):
-                log.warning("discarding result for %s against %s", file_path,
-                            document.path)
+            if document and document.path and not document.path.endswith(file_path):
+                log.warning(
+                    "discarding result for %s against %s", file_path, document.path
+                )
                 return None
 
         lineno = int(linenoStr or 1) - 1  # 0-based line number
         offset = int(offsetStr or 1) - 1  # 0-based offset
         errno = 2
-        if severity == 'error':
+        if severity == "error":
             errno = 1
         diag: Dict[str, Any] = {
-            'source': 'mypy',
-            'range': {
-                'start': {'line': lineno, 'character': offset},
+            "source": "mypy",
+            "range": {
+                "start": {"line": lineno, "character": offset},
                 # There may be a better solution, but mypy does not provide end
-                'end': {'line': lineno, 'character': offset + 1}
+                "end": {"line": lineno, "character": offset + 1},
             },
-            'message': msg,
-            'severity': errno
+            "message": msg,
+            "severity": errno,
         }
         if document:
             # although mypy does not provide the end of the affected range, we
             # can make a good guess by highlighting the word that Mypy flagged
-            word = document.word_at_position(diag['range']['start'])
+            word = document.word_at_position(diag["range"]["start"])
             if word:
-                diag['range']['end']['character'] = (
-                    diag['range']['start']['character'] + len(word))
+                diag["range"]["end"]["character"] = diag["range"]["start"][
+                    "character"
+                ] + len(word)
 
         return diag
     return None
 
 
 @hookimpl
-def pylsp_lint(config: Config, workspace: Workspace, document: Document,
-              is_saved: bool) -> List[Dict[str, Any]]:
+def pylsp_lint(
+    config: Config, workspace: Workspace, document: Document, is_saved: bool
+) -> List[Dict[str, Any]]:
     """
     Lints.
 
@@ -110,27 +114,25 @@ def pylsp_lint(config: Config, workspace: Workspace, document: Document,
         List of the linting data.
 
     """
-    settings = config.plugin_settings('mypy-ls')
-    live_mode = settings.get('live_mode', True)
-    args = ['--incremental',
-            '--show-column-numbers',
-            '--follow-imports', 'silent']
+    settings = config.plugin_settings("mypy-ls")
+    live_mode = settings.get("live_mode", True)
+    args = ["--incremental", "--show-column-numbers", "--follow-imports", "silent"]
 
     global tmpFile
     if live_mode and not is_saved and tmpFile:
         tmpFile = open(tmpFile.name, "w")
         tmpFile.write(document.source)
         tmpFile.close()
-        args.extend(['--shadow-file', document.path, tmpFile.name])
+        args.extend(["--shadow-file", document.path, tmpFile.name])
     elif not is_saved:
         return []
 
     if mypyConfigFile:
-        args.append('--config-file')
+        args.append("--config-file")
         args.append(mypyConfigFile)
     args.append(document.path)
-    if settings.get('strict', False):
-        args.append('--strict')
+    if settings.get("strict", False):
+        args.append("--strict")
 
     report, errors, _ = mypy_api.run(args)
 
@@ -187,10 +189,11 @@ def init(workspace: str) -> Dict[str, str]:
             configuration = eval(file.read())
     global mypyConfigFile
     mypyConfigFile = findConfigFile(workspace, "mypy.ini")
-    if (("enabled" not in configuration or configuration["enabled"])
-       and ("live_mode" not in configuration or configuration["live_mode"])):
+    if ("enabled" not in configuration or configuration["enabled"]) and (
+        "live_mode" not in configuration or configuration["live_mode"]
+    ):
         global tmpFile
-        tmpFile = tempfile.NamedTemporaryFile('w', delete=False)
+        tmpFile = tempfile.NamedTemporaryFile("w", delete=False)
         tmpFile.close()
     return configuration
 

pyproject.toml

@@ -0,0 +1,14 @@
+[tool.black]
+line-length = 90
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | build
+  | dist
+)/
+'''

requirements.txt

@@ -1,2 +1,4 @@
 python-lsp-server
 mypy
+black
+pre-commit

test/test_plugin.py

@@ -12,10 +12,8 @@
 TYPE_ERR_MSG = '"Dict[<nothing>, <nothing>]" has no attribute "append"'
 
 TEST_LINE = 'test_plugin.py:279:8: error: "Request" has no attribute "id"'
-TEST_LINE_WITHOUT_COL = ('test_plugin.py:279: '
-                         'error: "Request" has no attribute "id"')
-TEST_LINE_WITHOUT_LINE = ('test_plugin.py: '
-                          'error: "Request" has no attribute "id"')
+TEST_LINE_WITHOUT_COL = "test_plugin.py:279: " 'error: "Request" has no attribute "id"'
+TEST_LINE_WITHOUT_LINE = "test_plugin.py: " 'error: "Request" has no attribute "id"'
 
 
 @pytest.fixture
@@ -27,7 +25,6 @@ def workspace(tmpdir):
 
 
 class FakeConfig(object):
-
     def __init__(self):
         self._root_path = "C:"
 
@@ -50,40 +47,40 @@ def test_plugin(workspace):
 
     assert len(diags) == 1
     diag = diags[0]
-    assert diag['message'] == TYPE_ERR_MSG
-    assert diag['range']['start'] == {'line': 0, 'character': 0}
-    assert diag['range']['end'] == {'line': 0, 'character': 1}
+    assert diag["message"] == TYPE_ERR_MSG
+    assert diag["range"]["start"] == {"line": 0, "character": 0}
+    assert diag["range"]["end"] == {"line": 0, "character": 1}
 
 
 def test_parse_full_line(workspace):
     doc = Document(DOC_URI, workspace)
     diag = plugin.parse_line(TEST_LINE, doc)
-    assert diag['message'] == '"Request" has no attribute "id"'
-    assert diag['range']['start'] == {'line': 278, 'character': 7}
-    assert diag['range']['end'] == {'line': 278, 'character': 8}
+    assert diag["message"] == '"Request" has no attribute "id"'
+    assert diag["range"]["start"] == {"line": 278, "character": 7}
+    assert diag["range"]["end"] == {"line": 278, "character": 8}
 
 
 def test_parse_line_without_col(workspace):
     doc = Document(DOC_URI, workspace)
     diag = plugin.parse_line(TEST_LINE_WITHOUT_COL, doc)
-    assert diag['message'] == '"Request" has no attribute "id"'
-    assert diag['range']['start'] == {'line': 278, 'character': 0}
-    assert diag['range']['end'] == {'line': 278, 'character': 1}
+    assert diag["message"] == '"Request" has no attribute "id"'
+    assert diag["range"]["start"] == {"line": 278, "character": 0}
+    assert diag["range"]["end"] == {"line": 278, "character": 1}
 
 
 def test_parse_line_without_line(workspace):
     doc = Document(DOC_URI, workspace)
     diag = plugin.parse_line(TEST_LINE_WITHOUT_LINE, doc)
-    assert diag['message'] == '"Request" has no attribute "id"'
-    assert diag['range']['start'] == {'line': 0, 'character': 0}
-    assert diag['range']['end'] == {'line': 0, 'character': 6}
+    assert diag["message"] == '"Request" has no attribute "id"'
+    assert diag["range"]["start"] == {"line": 0, "character": 0}
+    assert diag["range"]["end"] == {"line": 0, "character": 6}
 
 
-@pytest.mark.parametrize('word,bounds', [('', (7, 8)), ('my_var', (7, 13))])
+@pytest.mark.parametrize("word,bounds", [("", (7, 8)), ("my_var", (7, 13))])
 def test_parse_line_with_context(monkeypatch, word, bounds, workspace):
     doc = Document(DOC_URI, workspace)
-    monkeypatch.setattr(Document, 'word_at_position', lambda *args: word)
+    monkeypatch.setattr(Document, "word_at_position", lambda *args: word)
     diag = plugin.parse_line(TEST_LINE, doc)
-    assert diag['message'] == '"Request" has no attribute "id"'
-    assert diag['range']['start'] == {'line': 278, 'character': bounds[0]}
-    assert diag['range']['end'] == {'line': 278, 'character': bounds[1]}
+    assert diag["message"] == '"Request" has no attribute "id"'
+    assert diag["range"]["start"] == {"line": 278, "character": bounds[0]}
+    assert diag["range"]["end"] == {"line": 278, "character": bounds[1]}