Minor edits to satisfy ruff format and check and mypy (latest versions)

Author: RobertoRoos

sphinxarg/ext.py

@@ -6,7 +6,7 @@
 import shutil
 import sys
 from argparse import ArgumentParser
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, ClassVar, cast
 
 from docutils import nodes
 from docutils.frontend import get_default_settings
@@ -179,7 +179,7 @@ def print_action_groups(
                 arg = []
                 if 'choices' in entry:
                     arg.append(
-                        f"Possible choices: {', '.join(str(c) for c in entry['choices'])}\n"
+                        f'Possible choices: {", ".join(str(c) for c in entry["choices"])}\n'
                     )
                 if 'help' in entry:
                     arg.append(entry['help'])
@@ -524,7 +524,7 @@ def _print_subcommands(self, data, nested_content, markdown_help=False, settings
         definitions = map_nested_definitions(nested_content)
         items = []
         full_subcommand_name_true = self.config.sphinxarg_full_subcommand_name
-        domain = cast(ArgParseDomain, self.env.domains[ArgParseDomain.name])
+        domain = cast('ArgParseDomain', self.env.domains[ArgParseDomain.name])
 
         if 'children' in data:
             full_command = command_pos_args(data)
@@ -667,7 +667,7 @@ def _print_action_groups(
                     arg = []
                     if 'choices' in entry:
                         arg.append(
-                            f"Possible choices: {', '.join(map(str, entry['choices']))}\n"
+                            f'Possible choices: {", ".join(map(str, entry["choices"]))}\n'
                         )
                     if 'help' in entry:
                         arg.append(entry['help'])
@@ -814,7 +814,7 @@ def run(self):
         self.set_source_info(target)
         self.state.document.note_explicit_target(target)
 
-        domain = cast(ArgParseDomain, self.env.get_domain(ArgParseDomain.name))
+        domain = cast('ArgParseDomain', self.env.get_domain(ArgParseDomain.name))
         domain.add_argparse_command(result, node_id, self.index_groups)
 
         items.append(nodes.literal_block(text=result['usage']))
@@ -888,8 +888,8 @@ class ArgParseDomain(Domain):
         'command': XRefRole(),
     }
     indices = []
-    initial_data: dict[
-        str, list[_ObjectDescriptionTuple] | dict[str, list[_ObjectDescriptionTuple]]
+    initial_data: ClassVar[
+        dict[str, list[_ObjectDescriptionTuple] | dict[str, list[_ObjectDescriptionTuple]]]
     ] = {
         'commands': [],
         'commands-by-group': {},
@@ -948,7 +948,7 @@ def add_argparse_command(self, result: dict, anchor: str, groups: Sequence[str]
 
 def _delete_temporary_files(app: Sphinx, _err) -> None:
     assert app.env is not None
-    domain = cast(ArgParseDomain, app.env.domains[ArgParseDomain.name])
+    domain = cast('ArgParseDomain', app.env.domains[ArgParseDomain.name])
     for fpath in domain.temporary_index_files:
         fpath.unlink(missing_ok=True)
 
@@ -973,12 +973,12 @@ def _create_temporary_dummy_file(
         f'Creating this temporary file enables you to add {docname} to the toctree.',
     ))
     dummy_file.write_text(content, encoding='utf-8')
-    domain = cast(ArgParseDomain, domain)
+    domain = cast('ArgParseDomain', domain)
     domain.temporary_index_files.append(dummy_file)
 
 
 def configure_ext(app: Sphinx) -> None:
-    domain = cast(ArgParseDomain, app.env.domains[ArgParseDomain.name])
+    domain = cast('ArgParseDomain', app.env.domains[ArgParseDomain.name])
     build_index = False
     build_by_group_index = False
 

sphinxarg/parser.py

@@ -18,7 +18,7 @@ def parser_navigate(parser_result, path, current_path=None):
     if len(path) == 0:
         return parser_result
     if 'children' not in parser_result:
-        msg = f"Current parser has no child elements.  (path: {' '.join(current_path)})"
+        msg = f'Current parser has no child elements.  (path: {" ".join(current_path)})'
         raise NavigationException(msg)
     next_hop = path.pop(0)
     for child in parser_result['children']:
@@ -28,8 +28,8 @@ def parser_navigate(parser_result, path, current_path=None):
             current_path.append(next_hop)
             return parser_navigate(child, path, current_path)
     msg = (
-        f"Current parser has no child element with name: {next_hop} "
-        f"(path: {' '.join(current_path)})"
+        f'Current parser has no child element with name: {next_hop} '
+        f'(path: {" ".join(current_path)})'
     )
     raise NavigationException(msg)
 
@@ -88,7 +88,7 @@ def parse_parser(parser, data=None, **kwargs):
             subalias = subsection_alias[subaction]
             subaction.prog = f'{parser.prog} {name}'
             subdata = {
-                'name': name if not subalias else f"{name} ({', '.join(subalias)})",
+                'name': name if not subalias else f'{name} ({", ".join(subalias)})',
                 'help': helps.get(name, ''),
                 'usage': subaction.format_usage().strip(),
                 'bare_usage': _format_usage_without_prefix(subaction),

sphinxarg/utils.py

@@ -23,9 +23,9 @@ def command_pos_args(result: dict) -> str:
     ret = ''
 
     if 'name' in result and result['name'] != '':
-        ret += f"{result['name']}"
+        ret += f'{result["name"]}'
     elif 'prog' in result and result['prog'] != '':
-        ret += f"{result['prog']}"
+        ret += f'{result["prog"]}'
 
     if 'parent' in result:
         ret = command_pos_args(result['parent']) + ' ' + ret

test/test_default_html.py

@@ -101,21 +101,12 @@ def test_object_inventory(app, cached_etree_parse):
 
     directive_opts = inv.get('commands:command').get('sample-directive-opts', None)
     assert directive_opts is not None
-    assert (
-        'test/path/index.html#sample-directive-opts'
-        == directive_opts.uri
-    )
+    assert 'test/path/index.html#sample-directive-opts' == directive_opts.uri
 
     directive_opts_a = inv.get('commands:command').get('sample-directive-opts A', None)
     assert directive_opts_a is not None
-    assert (
-        'test/path/subcommand-a.html#sample-directive-opts-A'
-        == directive_opts_a.uri
-    )
+    assert 'test/path/subcommand-a.html#sample-directive-opts-A' == directive_opts_a.uri
 
     directive_opts_b = inv.get('commands:command').get('sample-directive-opts B', None)
     assert directive_opts_b is not None
-    assert (
-        'test/path/index.html#sample-directive-opts-B'
-        == directive_opts_b.uri
-    )
+    assert 'test/path/index.html#sample-directive-opts-B' == directive_opts_b.uri