Merge pull request #52 from remisalmon/add-format-lines

Use new `lines` option in Black 23.11 to format range

Author: ccordoba12

pylsp_black/plugin.py

@@ -64,29 +64,34 @@ def pylsp_settings():
 
 
 def format_document(client_config, document, range=None):
+    text = document.source
+    config = load_config(document.path, client_config)
+    # Black lines indices are "1-based and inclusive on both ends"
+    lines = [(range["start"]["line"] + 1, range["end"]["line"])] if range else ()
+
+    try:
+        formatted_text = format_text(text=text, config=config, lines=lines)
+    except black.NothingChanged:
+        # raised when the file is already formatted correctly
+        return []
+
     if range:
+        formatted_lines = formatted_text.splitlines(True)
+
         start = range["start"]["line"]
-        end = range["end"]["line"]
-        text = "".join(document.lines[start:end])
+        end = range["end"]["line"] + (len(formatted_lines) - len(document.lines))
+
+        formatted_text = "".join(formatted_lines[start:end])
     else:
-        text = document.source
         range = {
             "start": {"line": 0, "character": 0},
             "end": {"line": len(document.lines), "character": 0},
         }
 
-    config = load_config(document.path, client_config)
-
-    try:
-        formatted_text = format_text(text=text, config=config)
-    except black.NothingChanged:
-        # raised when the file is already formatted correctly
-        return []
-
     return [{"range": range, "newText": formatted_text}]
 
 
-def format_text(*, text, config):
+def format_text(*, text, config, lines):
     mode = black.FileMode(
         target_versions=config["target_version"],
         line_length=config["line_length"],
@@ -107,7 +112,7 @@ def format_text(*, text, config):
 
         # Will raise black.NothingChanged, we want to bubble that exception up
         formatted_text = black.format_file_contents(
-            text, fast=config["fast"], mode=mode
+            text, fast=config["fast"], mode=mode, lines=lines
         )
 
         # Restore eols if necessary.

setup.cfg

@@ -20,7 +20,7 @@ classifiers =
 packages = find:
 install_requires =
     python-lsp-server>=1.4.0
-    black>=22.3.0
+    black>=23.11.0
     tomli; python_version<'3.11'
 python_requires = >= 3.8
 

tests/fixtures/formatted.txt

@@ -1,2 +1,15 @@
 a = "hello"
-b = 42
+b = [
+    "a",
+    "very",
+    "very",
+    "very",
+    "very",
+    "very",
+    "very",
+    "very",
+    "very",
+    "long",
+    "line",
+]
+c = 42

tests/fixtures/unformatted.txt

@@ -1,2 +1,3 @@
 a = 'hello'
-b =  42
+b = ["a", "very", "very", "very", "very", "very", "very", "very", "very", "long", "line"]
+c =  42

tests/test_plugin.py

@@ -140,7 +140,7 @@ def test_pylsp_format_document(config, unformatted_document, formatted_document)
         {
             "range": {
                 "start": {"line": 0, "character": 0},
-                "end": {"line": 2, "character": 0},
+                "end": {"line": 3, "character": 0},
             },
             "newText": formatted_document.source,
         }
@@ -205,7 +205,20 @@ def test_pylsp_format_document_with_config(config, config_document):
 
 @pytest.mark.parametrize(
     ("start", "end", "expected"),
-    [(0, 0, 'a = "hello"\n'), (1, 1, "b = 42\n"), (0, 1, 'a = "hello"\nb = 42\n')],
+    [
+        (0, 0, 'a = "hello"\n'),
+        (
+            1,
+            1,
+            'b = [\n    "a",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "long",\n    "line",\n]\n',  # noqa: E501
+        ),
+        (2, 2, "c = 42\n"),
+        (
+            0,
+            2,
+            'a = "hello"\nb = [\n    "a",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "very",\n    "long",\n    "line",\n]\nc = 42\n',  # noqa: E501
+        ),
+    ],
 )
 def test_pylsp_format_range(config, unformatted_document, start, end, expected):
     range = {