Merge pull request #15 from bryanforbes/handle-pyi-files

Correctly handle .pyi files

Author: rupert

pyls_black/plugin.py

@@ -70,7 +70,7 @@ def load_config(filename: str) -> Dict:
         "line_length": 88,
         "fast": False,
         "py36": False,
-        "pyi": False,
+        "pyi": filename.endswith(".pyi"),
         "skip_string_normalization": False,
         "skip_numeric_underscore_normalization": False,
     }

pyproject.toml

@@ -1,2 +1,12 @@
 [tool.black]
 py36 = true
+exclude = '''
+/(
+	  \.venv
+	| \.git
+	| \.mypy_cache
+	| build
+	| dist
+	| fixtures
+)/
+'''

tests/fixtures/formatted.pyi

@@ -0,0 +1,2 @@
+def foo() -> None: ...
+def bar() -> int: ...

tests/fixtures/unformatted.pyi

@@ -0,0 +1,5 @@
+def foo() -> None:
+    ...
+
+def bar() -> int:
+    ...

tests/test_plugin.py

@@ -16,13 +16,27 @@ def unformatted_document():
     return Document(uri)
 
 
+@pytest.fixture
+def unformatted_pyi_document():
+    path = fixtures_dir / "unformatted.pyi"
+    uri = f"file:/{path}"
+    return Document(uri)
+
+
 @pytest.fixture
 def formatted_document():
     path = fixtures_dir / "formatted.txt"
     uri = f"file:/{path}"
     return Document(uri)
 
 
+@pytest.fixture
+def formatted_pyi_document():
+    path = fixtures_dir / "formatted.pyi"
+    uri = f"file:/{path}"
+    return Document(uri)
+
+
 @pytest.fixture
 def invalid_document():
     path = fixtures_dir / "invalid.txt"
@@ -51,12 +65,32 @@ def test_pyls_format_document(unformatted_document, formatted_document):
     ]
 
 
+def test_pyls_format_pyi_document(unformatted_pyi_document, formatted_pyi_document):
+    result = pyls_format_document(unformatted_pyi_document)
+
+    assert result == [
+        {
+            "range": {
+                "start": {"line": 0, "character": 0},
+                "end": {"line": 5, "character": 0},
+            },
+            "newText": formatted_pyi_document.source,
+        }
+    ]
+
+
 def test_pyls_format_document_unchanged(formatted_document):
     result = pyls_format_document(formatted_document)
 
     assert result == []
 
 
+def test_pyls_format_pyi_document_unchanged(formatted_pyi_document):
+    result = pyls_format_document(formatted_pyi_document)
+
+    assert result == []
+
+
 def test_pyls_format_document_syntax_error(invalid_document):
     result = pyls_format_document(invalid_document)
 
@@ -125,7 +159,7 @@ def test_pyls_format_range_syntax_error(invalid_document):
 
 
 def test_load_config():
-    config = load_config(fixtures_dir / "config" / "example.py")
+    config = load_config(str(fixtures_dir / "config" / "example.py"))
 
     assert config == {
         "line_length": 20,
@@ -138,7 +172,7 @@ def test_load_config():
 
 
 def test_load_config_defaults():
-    config = load_config(fixtures_dir / "example.py")
+    config = load_config(str(fixtures_dir / "example.py"))
 
     assert config == {
         "line_length": 88,