First commit

Author: rupert

.gitignore

@@ -0,0 +1,5 @@
+.mypy_cache
+*.egg-info
+*.pyc
+.pytest_cache
+.ropeproject

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rupert Bedford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,16 @@
+# pyls-black
+
+> [Black](https://github.com/ambv/black) plugin for the [Python Language Server](https://github.com/palantir/python-language-server/tree/develop/pyls).
+
+```shell
+pip3 install pyls-black
+```
+
+`pyls-black` can either format an entire file or just the selected text.
+The code will only be formatted if it is syntactically valid Python.
+Text selections are treated as if they were a separate Python file.
+Note that this means you can't format an indented block of code.
+
+## TODO
+
+* Add support for configuring the line length and fast flag.

pyls_black/__init__.py

@@ -0,0 +1,60 @@
+from typing import NamedTuple
+
+import black
+from pyls import hookimpl
+
+
+@hookimpl(hookwrapper=True)
+def pyls_format_document(document):
+    return format_document(document)
+
+
+@hookimpl(hookwrapper=True)
+def pyls_format_range(document, range):
+    selection = Selection(start=range["start"]["line"], end=range["end"]["line"] + 1)
+    return format_document(document, selection)
+
+
+class Selection(NamedTuple):
+    start: int
+    end: int
+
+    def to_range(self):
+        return {
+            "start": {"line": self.start, "character": 0},
+            "end": {"line": self.end, "character": 0},
+        }
+
+
+def format_document(document, selection=None):
+    outcome = yield
+
+    result = outcome.get_result()
+
+    if result:
+        text = result[0]["newText"]
+    else:
+        text = document.source
+
+    if selection:
+        text = select_text(text, selection)
+    else:
+        selection = Selection(0, len(document.lines))
+
+    try:
+        formatted_text = format_text(text)
+    except (ValueError, black.NothingChanged):
+        return
+
+    new_result = [{"range": selection.to_range(), "newText": formatted_text}]
+
+    outcome.force_result(new_result)
+
+
+def select_text(text, selection):
+    lines = text.splitlines(True)
+    return "".join(lines[selection.start : selection.end])
+
+
+def format_text(text):
+    return black.format_file_contents(text, line_length=88, fast=False)

pyls_black/plugin.py

@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 88
+ignore = E203
+
+[mypy]
+ignore_missing_imports = true

setup.cfg

@@ -0,0 +1,25 @@
+from setuptools import find_packages, setup
+
+with open("README.md", "r") as f:
+    long_description = f.read()
+
+setup(
+    name="pyls-black",
+    version="0.1.0",
+    description="Black plugin for the Python Language Server",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/rupert/pyls-black",
+    author="Rupert Bedford",
+    author_email="[email protected]",
+    packages=find_packages(exclude=["tests"]),
+    install_requires=["python-language-server", "black"],
+    extras_require={"dev": ["isort", "flake8", "pytest"]},
+    entry_points={"pyls": ["pyls_black = pyls_black.plugin"]},
+    classifiers=(
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent"
+    ),
+)

setup.py

@@ -0,0 +1,2 @@
+a = "hello"
+b = 42

tests/formatted.txt

@@ -0,0 +1 @@
+    x = 1+2

tests/invalid.txt

@@ -0,0 +1,176 @@
+from pathlib import Path
+from unittest.mock import Mock
+
+import pytest
+from pyls.workspace import Document
+
+from pyls_black.plugin import pyls_format_document, pyls_format_range
+
+here = Path(__file__).parent
+
+
+@pytest.fixture
+def unformatted_document():
+    path = here / "unformatted.txt"
+    uri = f"file:/{path}"
+    return Document(uri)
+
+
+@pytest.fixture
+def formatted_document():
+    path = here / "formatted.txt"
+    uri = f"file:/{path}"
+    return Document(uri)
+
+
+@pytest.fixture
+def invalid_document():
+    path = here / "invalid.txt"
+    uri = f"file:/{path}"
+    return Document(uri)
+
+
+def run(g, outcome):
+    g.send(None)
+
+    with pytest.raises(StopIteration):
+        g.send(outcome)
+
+
+def test_pyls_format_document(unformatted_document, formatted_document):
+    mock = Mock()
+    mock.get_result.return_value = None
+
+    g = pyls_format_document(unformatted_document)
+    run(g, mock)
+
+    mock.force_result.assert_called_once_with(
+        [
+            {
+                "range": {
+                    "start": {"line": 0, "character": 0},
+                    "end": {"line": 2, "character": 0},
+                },
+                "newText": formatted_document.source,
+            }
+        ]
+    )
+
+
+def test_pyls_format_document_with_result(unformatted_document):
+    mock = Mock()
+    mock.get_result.return_value = [
+        {
+            "range": {
+                "start": {"line": 0, "character": 0},
+                "end": {"line": 1, "character": 0},
+            },
+            "newText": "x = 1+2\n",
+        }
+    ]
+
+    g = pyls_format_document(unformatted_document)
+    run(g, mock)
+
+    mock.force_result.assert_called_once_with(
+        [
+            {
+                "range": {
+                    "start": {"line": 0, "character": 0},
+                    "end": {"line": 2, "character": 0},
+                },
+                "newText": "x = 1 + 2\n",
+            }
+        ]
+    )
+
+
+def test_pyls_format_document_unchanged(formatted_document):
+    mock = Mock()
+    mock.get_result.return_value = None
+
+    g = pyls_format_document(formatted_document)
+    run(g, mock)
+
+    mock.force_result.assert_not_called()
+
+
+def test_pyls_format_document_supresses_syntax_errors(invalid_document):
+    mock = Mock()
+    mock.get_result.return_value = None
+
+    g = pyls_format_document(invalid_document)
+    run(g, mock)
+
+    mock.force_result.assert_not_called()
+
+
+@pytest.mark.parametrize(
+    ("start", "end", "expected"),
+    [(0, 0, 'a = "hello"\n'), (1, 1, "b = 42\n"), (0, 1, 'a = "hello"\nb = 42\n')],
+)
+def test_pyls_format_range(unformatted_document, start, end, expected):
+    range = {
+        "start": {"line": start, "character": 0},
+        "end": {"line": end, "character": 0},
+    }
+
+    mock = Mock()
+    mock.get_result.return_value = None
+
+    g = pyls_format_range(unformatted_document, range=range)
+    run(g, mock)
+
+    mock.force_result.assert_called_once_with(
+        [
+            {
+                "range": {
+                    "start": {"line": start, "character": 0},
+                    "end": {"line": end + 1, "character": 0},
+                },
+                "newText": expected,
+            }
+        ]
+    )
+
+
+def test_pyls_format_range_with_result(unformatted_document):
+    range = {"start": {"line": 0, "character": 0}, "end": {"line": 0, "character": 0}}
+
+    mock = Mock()
+    mock.get_result.return_value = [
+        {
+            "range": {
+                "start": {"line": 0, "character": 0},
+                "end": {"line": 2, "character": 0},
+            },
+            "newText": "x = 1+2\ny = 3+4\n",
+        }
+    ]
+
+    g = pyls_format_range(unformatted_document, range=range)
+    run(g, mock)
+
+    mock.force_result.assert_called_once_with(
+        [
+            {
+                "range": {
+                    "start": {"line": 0, "character": 0},
+                    "end": {"line": 1, "character": 0},
+                },
+                "newText": "x = 1 + 2\n",
+            }
+        ]
+    )
+
+
+def test_pyls_format_range_unchanged(formatted_document):
+    range = {"start": {"line": 0, "character": 0}, "end": {"line": 1, "character": 0}}
+
+    mock = Mock()
+    mock.get_result.return_value = None
+
+    g = pyls_format_range(formatted_document, range=range)
+    run(g, mock)
+
+    mock.force_result.assert_not_called()