fix: Format signatures with full-path names

pawamoy · pawamoy · commit 685512decf1a · 2023-05-07T18:36:07.000+02:00
diff --git a/src/mkdocstrings_handlers/python/rendering.py b/src/mkdocstrings_handlers/python/rendering.py
@@ -73,10 +73,18 @@ def do_format_signature(signature: str, line_length: int) -> str:
     code = signature.strip()
     if len(code) < line_length:
         return code
+
+    # Black cannot format names with dots, so we replace
+    # the whole name with a string of equal length
+    name_length = code.index("(")
+    name = code[:name_length]
     formatter = _get_black_formatter()
-    formatted = formatter(f"def {code}: pass", line_length)
-    # remove starting `def ` and trailing `: pass`
-    return formatted[4:-5].strip()[:-1]
+    formatable = f"def {'x' * name_length}{code[name_length:]}: pass"
+    formatted = formatter(formatable, line_length)
+
+    # We put back the original name
+    # and remove starting `def ` and trailing `: pass`
+    return name + formatted[4:-5].strip()[name_length:-1]
 
 
 def do_order_members(
diff --git a/tests/test_rendering.py b/tests/test_rendering.py
@@ -11,12 +11,35 @@
 from mkdocstrings_handlers.python import rendering
 
 
-def test_format_code_and_signature() -> None:
-    """Assert code and signatures can be Black-formatted."""
-    assert rendering.do_format_code("print('Hello')", 100)
-    assert rendering.do_format_code('print("Hello")', 100)
-    assert rendering.do_format_signature("(param: str = 'hello') -> 'Class'", 100)
-    assert rendering.do_format_signature('(param: str = "hello") -> "Class"', 100)
+@pytest.mark.parametrize(
+    "code",
+    [
+        "print('Hello')",
+        "aaaaa(bbbbb, ccccc=1) + ddddd.eeeee[ffff] or {ggggg: hhhhh, iiiii: jjjjj}",
+    ],
+)
+def test_format_code(code: str) -> None:
+    """Assert code can be Black-formatted.
+
+    Parameters:
+        code: Code to format.
+    """
+    for length in (5, 100):
+        assert rendering.do_format_code(code, length)
+
+
+@pytest.mark.parametrize(
+    "signature",
+    ["Class.method(param: str = 'hello') -> 'OtherClass'"],
+)
+def test_format_signature(signature: str) -> None:
+    """Assert signatures can be Black-formatted.
+
+    Parameters:
+        signature: Signature to format.
+    """
+    for length in (5, 100):
+        assert rendering.do_format_signature(signature, length)
 
 
 @dataclass
