Enable more Ruff linters

Author: AA-Turner

.ruff.toml

@@ -5,12 +5,22 @@ output-format = "full"
 [lint]
 preview = true
 select = [
+    "C4",
     "B",   # flake8-bugbear
     "E",   # pycodestyle
+    "EM",  # flake8-errmsg
     "F",   # pyflakes
+    "FA",  # flake8-future-annotations
     "FLY", # flynt
+    "FURB",# refurb
+    "G",   # flake8-logging-format
     "I",   # isort
+    "LOG", # flake8-logging
     "N",   # pep8-naming
+    "PERF",# perflint
+    "PGH", # pygrep-hooks
+    "PT",  # flake8-pytest-style
+    "TCH", # flake8-type-checking
     "UP",  # pyupgrade
     "W",   # pycodestyle
 ]

sphinxarg/ext.py

@@ -20,7 +20,8 @@
 
 def map_nested_definitions(nested_content):
     if nested_content is None:
-        raise Exception('Nested content should be iterable, not null')
+        msg = 'Nested content should be iterable, not null'
+        raise Exception(msg)
     # build definition dictionary
     definitions = {}
     for item in nested_content:
@@ -37,24 +38,24 @@ def map_nested_definitions(nested_content):
                 ci = subitem[idx]
                 if len(ci.children) > 0:
                     classifier = ci.children[0].astext()
-            if classifier is not None and classifier not in (
+            if classifier is not None and classifier not in {
                 '@replace',
                 '@before',
                 '@after',
                 '@skip',
-            ):
-                raise Exception(f'Unknown classifier: {classifier}')
+            }:
+                msg = f'Unknown classifier: {classifier}'
+                raise Exception(msg)
             idx = subitem.first_child_matching_class(nodes.term)
             if idx is not None:
                 term = subitem[idx]
                 if len(term.children) > 0:
                     term = term.children[0].astext()
                     idx = subitem.first_child_matching_class(nodes.definition)
                     if idx is not None:
-                        subcontent = []
-                        for _ in subitem[idx]:
-                            if isinstance(_, nodes.definition_list):
-                                subcontent.append(_)
+                        subcontent = [
+                            _ for _ in subitem[idx] if isinstance(_, nodes.definition_list)
+                        ]
                         definitions[term] = (classifier, subitem[idx], subcontent)
 
     return definitions
@@ -123,7 +124,7 @@ def print_action_groups(data, nested_content, markdown_help=False, settings=None
 
             local_definitions = definitions
             if len(subcontent) > 0:
-                local_definitions = {k: v for k, v in definitions.items()}
+                local_definitions = dict(definitions.items())
                 for k, v in map_nested_definitions(subcontent).items():
                     local_definitions[k] = v
 
@@ -267,23 +268,23 @@ def ensure_unique_ids(items):
 
 class ArgParseDirective(Directive):
     has_content = True
-    option_spec = dict(
-        module=unchanged,
-        func=unchanged,
-        ref=unchanged,
-        prog=unchanged,
-        path=unchanged,
-        nodefault=flag,
-        nodefaultconst=flag,
-        filename=unchanged,
-        manpage=unchanged,
-        nosubcommands=unchanged,
-        passparser=flag,
-        noepilog=unchanged,
-        nodescription=unchanged,
-        markdown=flag,
-        markdownhelp=flag,
-    )
+    option_spec = {
+        'module': unchanged,
+        'func': unchanged,
+        'ref': unchanged,
+        'prog': unchanged,
+        'path': unchanged,
+        'nodefault': flag,
+        'nodefaultconst': flag,
+        'filename': unchanged,
+        'manpage': unchanged,
+        'nosubcommands': unchanged,
+        'passparser': flag,
+        'noepilog': unchanged,
+        'nodescription': unchanged,
+        'markdown': flag,
+        'markdownhelp': flag,
+    }
 
     def _construct_manpage_specific_structure(self, parser_info):
         """
@@ -489,25 +490,26 @@ def run(self):
             attr_name = self.options['func']
             func = mod[attr_name]
         else:
-            raise self.error(
-                ':module: and :func: should be specified, or :ref:, or :filename: and :func:'
-            )
+            msg = ':module: and :func: should be specified, or :ref:, or :filename: and :func:'
+            raise self.error(msg)
 
         # Skip this if we're dealing with a local file, since it obviously can't be imported
         if 'filename' not in self.options:
             try:
                 mod = importlib.import_module(module_name)
             except ImportError as exc:
-                raise self.error(
+                msg = (
                     f'Failed to import "{attr_name}" from "{module_name}".\n'
                     f'{sys.exc_info()[1]}'
-                ) from exc
+                )
+                raise self.error(msg) from exc
 
             if not hasattr(mod, attr_name):
-                raise self.error(
+                msg = (
                     f'Module "{module_name}" has no attribute "{attr_name}"\n'
                     f'Incorrect argparse :module: or :func: values?'
                 )
+                raise self.error(msg)
             func = getattr(mod, attr_name)
 
         if isinstance(func, ArgumentParser):
@@ -542,9 +544,9 @@ def run(self):
             self.state.nested_parse(self.content, self.content_offset, nested_content)
             nested_content = nested_content.children
         # add common content between
-        for item in nested_content:
-            if not isinstance(item, nodes.definition_list):
-                items.append(item)
+        items += [
+            item for item in nested_content if not isinstance(item, nodes.definition_list)
+        ]
 
         markdown_help = False
         if 'markdownhelp' in self.options:

sphinxarg/markdown.py

@@ -1,5 +1,10 @@
 from __future__ import annotations
 
+import contextlib
+
+from docutils import nodes
+from docutils.utils.code_analyzer import Lexer
+
 try:
     from commonmark import Parser
 except ImportError:
@@ -8,8 +13,6 @@
     from commonmark.node import Node
 except ImportError:
     from CommonMark.node import Node
-from docutils import nodes
-from docutils.utils.code_analyzer import Lexer
 
 
 def custom_walker(node, space=''):
@@ -30,10 +33,8 @@ def custom_walker(node, space=''):
     Spaces are used to convey nesting
     """
     txt = ''
-    try:
+    with contextlib.suppress(Exception):
         txt = node.literal
-    except Exception:
-        pass
 
     if txt is None or txt == '':
         print(f'{space}{node.t}')
@@ -124,9 +125,10 @@ def literal(node):
     rendered = []
     try:
         if node.info is not None:
-            l = Lexer(node.literal, node.info, tokennames='long')
-            for _ in l:
-                rendered.append(node.inline(classes=_[0], text=_[1]))
+            rendered = [
+                node.inline(classes=_[0], text=_[1])
+                for _ in Lexer(node.literal, node.info, tokennames='long')
+            ]
     except Exception:
         pass
 
@@ -149,12 +151,14 @@ def literal_block(node):
     """
     A block of code
     """
+
     rendered = []
     try:
         if node.info is not None:
-            l = Lexer(node.literal, node.info, tokennames='long')
-            for _ in l:
-                rendered.append(node.inline(classes=_[0], text=_[1]))
+            rendered = [
+                node.inline(classes=_[0], text=_[1])
+                for _ in Lexer(node.literal, node.info, tokennames='long')
+            ]
     except Exception:
         pass
 
@@ -206,9 +210,8 @@ def section(node):
     This is a custom type
     """
     title = ''  # All sections need an id
-    if node.first_child is not None:
-        if node.first_child.t == 'heading':
-            title = node.first_child.first_child.literal
+    if node.first_child is not None and node.first_child.t == 'heading':
+        title = node.first_child.first_child.literal
     o = nodes.section(ids=[title], names=[title])
     for n in markdown(node):
         o += n

sphinxarg/parser.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import contextlib
 import re
 from argparse import _HelpAction, _StoreConstAction, _SubParsersAction
 
@@ -17,20 +18,20 @@ def parser_navigate(parser_result, path, current_path=None):
     if len(path) == 0:
         return parser_result
     if 'children' not in parser_result:
-        raise NavigationException(
-            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']:
         # identifer is only used for aliased subcommands
         identifier = child['identifier'] if 'identifier' in child else child['name']
         if identifier == next_hop:
             current_path.append(next_hop)
             return parser_navigate(child, path, current_path)
-    raise NavigationException(
+    msg = (
         f"Current parser has no child element with name: {next_hop} "
         f"(path: {' '.join(current_path)})"
     )
+    raise NavigationException(msg)
 
 
 def _try_add_parser_attribute(data, parser, attribname):
@@ -128,18 +129,13 @@ def parse_parser(parser, data=None, **kwargs):
             format_dict = dict(vars(action), prog=data.get('prog', ''), default=default)
             format_dict['default'] = default
             help_str = action.help or ''  # Ensure we don't print None
-            try:
+            with contextlib.suppress(Exception):
                 help_str = help_str % format_dict
-            except Exception:
-                pass
 
             # Options have the option_strings set, positional arguments don't
             name = action.option_strings
             if name == []:
-                if action.metavar is None:
-                    name = [action.dest]
-                else:
-                    name = [action.metavar]
+                name = [action.dest] if action.metavar is None else [action.metavar]
             # Skip lines for subcommands
             if name == ['==SUPPRESS==']:
                 continue

test/test_default_html.py

@@ -35,14 +35,15 @@ def get_text(node):
             if all(not rex.search(get_text(node)) for node in nodes):
                 return
 
-        raise AssertionError(
+        msg = (
             f'{check!r} not found in any node matching path {path} in {fname}: '
             f'{[node.text for node in nodes]!r}'
         )
+        raise AssertionError(msg)
 
 
 @pytest.mark.parametrize(
-    'fname,expect_list',
+    ('fname', 'expect_list'),
     [
         (
             'index.html',