Auto format

Author: thomasmarwitz

src/mkdocstrings_handlers/python/rendering.py

@@ -51,6 +51,7 @@ class Order(enum.Enum):
     source = "source"
     """Source code order."""
 
+
 class DocstringInheritStrategy(str, enum.Enum):
     """Enumeration for the possible docstring inheritance strategies."""
 
@@ -379,9 +380,11 @@ def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:
         return rules != {False}
     return keep
 
-def _construct_docstring_according_to_strategy(name: str, obj: Object | Alias, strategy: DocstringInheritStrategy, merge_delimiter: str = "\n") -> Docstring | None:
-    """
-    Construct a docstring object according to the strategy.
+
+def _construct_docstring_according_to_strategy(
+    name: str, obj: Object | Alias, strategy: DocstringInheritStrategy, merge_delimiter: str = "\n"
+) -> Docstring | None:
+    """Construct a docstring object according to the strategy.
 
     Parameters:
         name: The name of the member. Needed to lookup the member in the parent classes.
@@ -392,7 +395,6 @@ def _construct_docstring_according_to_strategy(name: str, obj: Object | Alias, s
     Returns:
         A new docstring object that just contains the docstring content.
     """
-
     if strategy == DocstringInheritStrategy.default:
         # Base case: we don't want to inherit docstrings
         return None
@@ -435,7 +437,9 @@ def do_optionally_inherit_docstrings(
     try:
         strategy = DocstringInheritStrategy(docstring_inherit_strategy)
     except ValueError as e:
-        raise ValueError(f"Unknown docstring inherit strategy: '{docstring_inherit_strategy}', allowed options are: {', '.join(strategy.value for strategy in DocstringInheritStrategy)}") from e
+        raise ValueError(
+            f"Unknown docstring inherit strategy: '{docstring_inherit_strategy}', allowed options are: {', '.join(strategy.value for strategy in DocstringInheritStrategy)}"
+        ) from e
 
     if strategy == DocstringInheritStrategy.default:
         return objects
@@ -446,7 +450,9 @@ def do_optionally_inherit_docstrings(
 
     for obj, new_obj in zip(objects.values(), new_objects.values()):
         for member_name, new_member in new_obj.members.items():
-            docstring = _construct_docstring_according_to_strategy(member_name, obj, strategy=strategy, merge_delimiter=docstring_merge_delimiter)
+            docstring = _construct_docstring_according_to_strategy(
+                member_name, obj, strategy=strategy, merge_delimiter=docstring_merge_delimiter
+            )
 
             if not docstring:
                 continue
@@ -463,6 +469,7 @@ def do_optionally_inherit_docstrings(
 
     return new_objects
 
+
 def do_filter_objects(
     objects_dictionary: dict[str, Object | Alias],
     *,

tests/test_rendering.py

@@ -166,27 +166,37 @@ def __init__(self, name: str, lineno: int | None = None, *, is_alias: bool = Fal
     assert [obj.name for obj in ordered] == expected_names
 
 
-
-
 @pytest.mark.parametrize(
     ("strategy", "docstrings_list", "expected_docstrings_list"),
     [
-        (rendering.DocstringInheritStrategy.default, ['"""base"""', '', ''], ['base', None, None]),
-        (rendering.DocstringInheritStrategy.if_not_present, ['"""base"""', '"""main"""', ''], ['base', 'main', 'main']), # main: stays the same (no merge); sub: main is taken (not base)
-        (rendering.DocstringInheritStrategy.merge, ['"""base"""', '"""main"""', ''], ['base', 'base+main', 'base+main']), # main: is merged with base; sub: empty is merged with base+main (not base+main+)
-        (rendering.DocstringInheritStrategy.merge, ['', '"""main"""', ''], [None, 'main', 'main']), # Base class has no docstring after merging (as opposed to an empty one)
+        (rendering.DocstringInheritStrategy.default, ['"""base"""', "", ""], ["base", None, None]),
+        (
+            rendering.DocstringInheritStrategy.if_not_present,
+            ['"""base"""', '"""main"""', ""],
+            ["base", "main", "main"],
+        ),  # main: stays the same (no merge); sub: main is taken (not base)
+        (
+            rendering.DocstringInheritStrategy.merge,
+            ['"""base"""', '"""main"""', ""],
+            ["base", "base+main", "base+main"],
+        ),  # main: is merged with base; sub: empty is merged with base+main (not base+main+)
+        (
+            rendering.DocstringInheritStrategy.merge,
+            ["", '"""main"""', ""],
+            [None, "main", "main"],
+        ),  # Base class has no docstring after merging (as opposed to an empty one)
     ],
 )
-def test_do_optionally_inherit_docstrings(strategy: rendering.DocstringInheritStrategy, docstrings_list: list[str], expected_docstrings_list: list[str]) -> None:
-    """
-    Test the inheritance strategies of docstrings for members.
+def test_do_optionally_inherit_docstrings(
+    strategy: rendering.DocstringInheritStrategy, docstrings_list: list[str], expected_docstrings_list: list[str]
+) -> None:
+    """Test the inheritance strategies of docstrings for members.
 
     Parameters:
         strategy: The docstring inheritance strategy to use.
         docstrings_list: The list of docstrings for the base, main, and sub classes. Needs triple quotes.
         expected_docstrings_list: The expected list of docstrings for the base, main, and sub classes. Just the content, i.e. without triple quotes. None for no docstring at all.
     """
-
     docstring_base, docstring_main, docstring_sub = docstrings_list
 
     collection = ModulesCollection()
@@ -221,10 +231,7 @@ def base(self):
         docstring_inherit_strategy=strategy,
         docstring_merge_delimiter="+",
     )
-    docstrings = [
-        result[class_].members["base"].docstring
-        for class_ in classes
-    ]
+    docstrings = [result[class_].members["base"].docstring for class_ in classes]
     docstring_values = [docstring.value if docstring else None for docstring in docstrings]
 
-    assert docstring_values == expected_docstrings_list
+    assert docstring_values == expected_docstrings_list