Code formatting via ruff

Author: tomschr

src/docbuild/cli/cmd_cli.py

@@ -93,7 +93,7 @@ def cli(
 
     if ctx.invoked_subcommand is None:
         # If no subcommand is invoked, show the help message
-        click.echo(10* '-')
+        click.echo(10 * '-')
         click.echo(ctx.get_help())
         ctx.exit(0)
 

src/docbuild/models/deliverable.py

@@ -111,7 +111,7 @@ def branch(self) -> str:
         # If we cannot find the branch in the current language node,
         # we look in the English language and use this branch
         node = self._node.getparent().xpath(
-            "ancestor::builddocs/language"
+            'ancestor::builddocs/language'
             "[@lang!='en-us' or @default!='1' or @default!='true']/branch",
         )
         if node:

src/docbuild/utils/contextmgr.py

@@ -1,6 +1,5 @@
 """Provides context managers."""
 
-
 from collections.abc import Callable, Generator
 from contextlib import contextmanager
 from dataclasses import dataclass
@@ -14,7 +13,7 @@ class TimerData:
     name: str
     start: float = float('nan')
     end: float = float('nan')
-    elapsed: float = float("nan")
+    elapsed: float = float('nan')
 
 
 def make_timer(

src/docbuild/utils/decorators.py

@@ -10,10 +10,7 @@
 if TYPE_CHECKING:
     from ..config.xml.checks import CheckResult
 
-F = TypeVar(
-    'F',
-    bound=Callable[[etree._Element | etree._ElementTree], 'CheckResult']
-)
+F = TypeVar('F', bound=Callable[[etree._Element | etree._ElementTree], 'CheckResult'])
 """Type variable for functions that take an XML element or tree and return CheckResult."""
 
 

src/docbuild/utils/doc.py

@@ -1,4 +1,5 @@
 """ """
+
 from collections.abc import Callable
 import functools
 from typing import Any, ParamSpec, TypeVar
@@ -18,7 +19,8 @@ def __missing__(self, key: str) -> str:
 
 
 def docstring(
-    template: str | None = None, **kwargs: Any   # noqa: ANN401
+    template: str | None = None,
+    **kwargs: Any,  # noqa: ANN401
 ) -> Callable[[Callable[P, R]], Callable[P, R]]:
     """Replace placeholders in docstring.
 
@@ -49,8 +51,9 @@ def greet():
         print(greet.__doc__)
         # Output: "Hello Alice, welcome to {place}"
     """
+
     def decorator(func: Callable[P, R]) -> Callable[P, R]:
-        base_template = template if template is not None else func.__doc__ or ""
+        base_template = template if template is not None else func.__doc__ or ''
         formatted_doc = base_template.format_map(SafeDict(kwargs))
 
         @functools.wraps(func)

tests/cli/config/test_config.py

@@ -3,7 +3,7 @@
 
 def test_showconfig_help_option(runner):
     result = runner.invoke(cli, ['config', '--help'])
-    print(result.output)
+    # print(result.output)
     assert result.exit_code == 0
     assert 'Commands:' in result.output
     assert 'env' in result.output

tests/cli/test_cmd_build.py

@@ -164,7 +164,9 @@ def mock_from_str(s: str):
 
     # Patch necessary methods
     monkeypatch.setattr(callback_module, 'ValidationError', MockValidationError)
-    monkeypatch.setattr(callback_module.Doctype, 'from_str', staticmethod(mock_from_str))
+    monkeypatch.setattr(
+        callback_module.Doctype, 'from_str', staticmethod(mock_from_str)
+    )
     monkeypatch.setattr(
         callback_module.Doctype,
         'model_fields',

tests/config/xml/test_check.py

@@ -102,12 +102,12 @@ def assert_results(string, messages: list[str]) -> None:
 # -----------------------
 def test_check_in_registry():
     """Test that the check functions are registered correctly."""
-    print(">>>", register_check.registry)
     assert len(register_check.registry) > 0, 'No checks registered'
     for func in register_check.registry:
         assert callable(func), f'{func.__name__} is not callable'
-        assert func.__name__.startswith('check_'), \
+        assert func.__name__.startswith('check_'), (
             f'{func.__name__} does not start with "check_"'
+        )
 
 
 # ----

tests/config/xml/test_stitch.py

@@ -23,9 +23,8 @@ def test_load_check_functions_returns_list(self):
             assert func.__name__.startswith('check_')
 
 
-
 class TestCreateStitchfile:
-    @pytest.mark.skip("TODO")
+    @pytest.mark.skip('TODO')
     def test_create_stitchfile_with_xml_files(self, tmp_path):
         """Test create_stitchfile with XML files in directory."""
         # This will cover lines 52-58

tests/conftest.py

@@ -132,16 +132,17 @@ def make_path_mock(**members: Any | Callable[[], Any]) -> MagicMock:
 
     return mock
 
+
 def make_path_mock(
-    path: str = "",
+    path: str = '',
     return_values: dict = None,
     side_effects: dict = None,
     attributes: dict = None,
 ) -> MagicMock:
     from pathlib import Path
     from unittest.mock import MagicMock
 
-    path_obj = Path(path) if path else Path("mocked")
+    path_obj = Path(path) if path else Path('mocked')
     mock = MagicMock(spec=Path)
 
     # Path-like behavior
@@ -150,9 +151,9 @@ def make_path_mock(
     mock.name = path_obj.name
     mock.suffix = path_obj.suffix
     mock.parts = path_obj.parts
-    mock.parent = make_path_mock(
-        str(path_obj.parent)
-    ) if path_obj != path_obj.parent else mock
+    mock.parent = (
+        make_path_mock(str(path_obj.parent)) if path_obj != path_obj.parent else mock
+    )
 
     # / operator
     def truediv(other: str) -> MagicMock:
@@ -180,7 +181,6 @@ def truediv(other: str) -> MagicMock:
     return mock
 
 
-
 @pytest.fixture
 def fake_envfile(
     monkeypatch: pytest.MonkeyPatch,