doc: Fix python code using ruff

This auto-fixes the code using ruff

Signed-off-by: Jamie McCrae <[email protected]>

Author: nordicjm

doc/_extensions/inventory_builder.py

@@ -12,8 +12,8 @@
 # It can be run as a 1st step when projects contain multi-
 # directional links between them.
 
+from collections.abc import Iterator
 from pathlib import Path
-from typing import Iterator, Set
 
 from docutils import nodes
 from sphinx.builders import Builder
@@ -42,10 +42,10 @@ def get_outdated_docs(self) -> Iterator[str]:
                 yield doc_name
                 continue
 
-    def get_target_uri(self, docname: str, typ: str = None) -> str: #pylint: disable=no-self-use
+    def get_target_uri(self, docname: str, typ: str = None) -> str:
         return docname + '.html'
 
-    def prepare_writing(self, docnames: Set[str]) -> None:
+    def prepare_writing(self, docnames: set[str]) -> None:
         pass
 
     def write_doc(self, docname: str, doctree: nodes.document) -> None:

doc/_extensions/manifest_revisions_table.py

@@ -27,7 +27,7 @@
 """
 
 import re
-from typing import Any, Dict, List
+from typing import Any
 
 from docutils import nodes
 from docutils.parsers.rst import directives
@@ -36,7 +36,6 @@
 from sphinx.util.docutils import SphinxDirective
 from west.manifest import Manifest
 
-
 __version__ = "0.1.0"
 
 
@@ -85,7 +84,7 @@ def rev_url(base_url: str, rev: str) -> str:
 
         return tag_fmt.format(rev=rev)
 
-    def run(self) -> List[nodes.Element]:
+    def run(self) -> list[nodes.Element]:
         # parse show-first option
         show_first_raw = self.options.get("show-first", None)
         show_first = (
@@ -156,7 +155,7 @@ def run(self) -> List[nodes.Element]:
         return [table]
 
 
-def setup(app: Sphinx) -> Dict[str, Any]:
+def setup(app: Sphinx) -> dict[str, Any]:
     app.add_config_value("manifest_revisions_table_manifest", None, "env")
 
     directives.register_directive("manifest-revisions-table", ManifestRevisionsTable)

doc/_extensions/ncs_include/__init__.py

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 from sphinx.application import Sphinx
+
 from . import ncs_include
 
 __version__ = '0.0.1'

doc/_extensions/ncs_include/ncs_include.py

@@ -11,8 +11,8 @@
 import os.path
 
 from docutils import io, statemachine
-from docutils.utils.error_reporting import SafeString, ErrorString
 from docutils.parsers.rst import directives
+from docutils.utils.error_reporting import ErrorString, SafeString
 from sphinx.util.docutils import SphinxDirective
 
 
@@ -41,8 +41,7 @@ def run(self):
         docset = self.options.get('docset', None)
         if docset is not None and \
                 docset not in self.config.ncs_include_mapping:
-            raise self.severe('The supplied "docset" was not found: "%s"' %
-                              docset)
+            raise self.severe(f'The supplied "docset" was not found: "{docset}"')
 
         indent = self.options.get('indent', 0)
         dedent = self.options.get('dedent', 0)
@@ -56,7 +55,7 @@ def run(self):
             raise self.severe('Choose one of "dedent" and "auto-dedent" only')
 
         if not self.state.document.settings.file_insertion_enabled:
-            raise self.warning('"%s" directive disabled.' % self.name)
+            raise self.warning(f'"{self.name}" directive disabled.')
 
         if docset is None:
             # without a docset fallback to Sphinx style include
@@ -76,13 +75,11 @@ def run(self):
                                         encoding=encoding,
                                         error_handler=e_handler)
         except UnicodeEncodeError:
-            raise self.severe('Problems with "%s" directive path:\n'
-                              'Cannot encode input file path "%s" '
-                              '(wrong locale?).' %
-                              (self.name, SafeString(path)))
-        except IOError as error:
-            raise self.severe('Problems with "%s" directive path:\n%s.' %
-                              (self.name, ErrorString(error)))
+            raise self.severe(f'Problems with "{self.name}" directive path:\n'
+                              f'Cannot encode input file path "{SafeString(path)}" '
+                              '(wrong locale?).')
+        except OSError as error:
+            raise self.severe(f'Problems with "{self.name}" directive path:\n{ErrorString(error)}.')
 
         # Get to-be-included content
         startline = self.options.get('start-line', None)
@@ -94,8 +91,7 @@ def run(self):
             else:
                 rawtext = include_file.read()
         except UnicodeError as error:
-            raise self.severe(u'Problem with "%s" directive:\n%s' %
-                              (self.name, ErrorString(error)))
+            raise self.severe(f'Problem with "{self.name}" directive:\n{ErrorString(error)}')
         # start-after/end-before: no restrictions on newlines in match-text,
         # and no restrictions on matching inside lines vs. line boundaries
         start_at_text = self.options.get('start-at', None)
@@ -104,8 +100,8 @@ def run(self):
             # skip content in rawtext before *and incl.* a matching text
             after_index = rawtext.find(after_text)
             if after_index < 0:
-                raise self.severe('Problem with "start-after" option of "%s" '
-                                  'directive:\nText not found.' % self.name)
+                raise self.severe(f'Problem with "start-after" option of "{self.name}" '
+                                  'directive:\nText not found.')
             if start_at_text:
                 rawtext = rawtext[after_index:]
             else:
@@ -116,8 +112,8 @@ def run(self):
             # skip content in rawtext after *and incl.* a matching text
             before_index = rawtext.find(before_text)
             if before_index < 0:
-                raise self.severe('Problem with "end-before" option of "%s" '
-                                  'directive:\nText not found.' % self.name)
+                raise self.severe(f'Problem with "end-before" option of "{self.name}" '
+                                  'directive:\nText not found.')
             if end_at_text:
                 rawtext = rawtext[:before_index + len(end_at_text)]
             else:

doc/_extensions/ncs_tool_versions.py

@@ -28,12 +28,13 @@
 
 """
 
+import re
+from collections.abc import Callable
+
+import yaml
 from docutils import nodes
 from sphinx.application import Sphinx
-from typing import List, Dict, Callable
 from sphinx.util import logging
-import yaml
-import re
 
 __version__ = "0.1.0"
 
@@ -45,7 +46,7 @@ def remove_prefix(s: str, prefix: str) -> str:
     return s[len(prefix) :] if s.startswith(prefix) else s
 
 
-def parse_pip_requirements(lines: List[str]) -> Dict[str, str]:
+def parse_pip_requirements(lines: list[str]) -> dict[str, str]:
     """Create a mapping from a pip requirements file.
     The listed dependencies are mapped to their required versions.
     Exact versions will only have their version displayed, and dependencies
@@ -114,7 +115,11 @@ def tool_version_replace(app: Sphinx) -> Callable:
         pip_versions = parse_pip_requirements(requirement_lines)
         versions.update(pip_versions)
 
-    def tool_version_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
+    def tool_version_role(name, rawtext, text, lineno, inliner, options=None, content=None):
+        if content is None:
+            content = []
+        if options is None:
+            options = {}
         if text in versions:
             node = nodes.Text(versions[text])
         else:

doc/_extensions/options_from_kconfig.py

@@ -12,7 +12,6 @@
 from sphinx.application import Sphinx
 from sphinx.util.docutils import SphinxDirective
 
-
 __version__ = '0.0.1'
 
 
@@ -84,7 +83,7 @@ def run(self):
         self._monkey_patch_kconfiglib(kconfiglib)
 
         # kconfiglib wants this env var defined
-        os.environ['srctree'] = os.path.dirname(os.path.abspath(__file__))
+        os.environ['SRCTREE'] = os.path.dirname(os.path.abspath(__file__))
         kconfig = kconfiglib.Kconfig(filename=path, warn=False)
 
         prefix = self.options.get('prefix', None)

doc/_extensions/page_filter.py

@@ -59,15 +59,15 @@
   :container: dl/dt
 """
 
+import json
+import re
+from pathlib import Path
+
 from docutils import nodes
 from docutils.parsers.rst import directives
-from sphinx.util.docutils import SphinxDirective
 from sphinx.application import Sphinx
 from sphinx.util import logging
-from typing import Dict, List, Optional, Tuple
-from pathlib import Path
-import json
-import re
+from sphinx.util.docutils import SphinxDirective
 
 __version__ = "0.1.0"
 
@@ -92,7 +92,8 @@ class PageFilter(SphinxDirective):
 
     def run(self):
         name = self.options.get("name", "")
-        split_first = lambda s: s.split(maxsplit=1)
+        def split_first(s):
+            return s.split(maxsplit=1)
         content = list(map(split_first, self.content))
         default = self.options.get("default", "all")
         container = self.options.get("container", None)
@@ -112,7 +113,8 @@ def run(self):
         tags = self.options.get("tags", [])
         tags = {classname: displayname for classname, displayname in tags}
         tags["versions"] = ""
-        create_tuple = lambda v: (v, v.replace("-", "."))
+        def create_tuple(v):
+            return v, v.replace("-", ".")
         versions = list(map(create_tuple, reversed(self.env.nrf_versions)))
         return [FilterDropdown(name, versions, default, container_element, tags)]
 
@@ -134,10 +136,10 @@ class to create a tag from, and displayname is the content
     def __init__(
         self,
         name: str,
-        options: List[Tuple[str, str]],
+        options: list[tuple[str, str]],
         default_value: str = "all",
         container_element: str = None,
-        filter_tags: Tuple[str, str] = None,
+        filter_tags: tuple[str, str] = None,
     ) -> None:
         super().__init__()
         self.name = name
@@ -176,16 +178,16 @@ def unknown_visit(self, node: nodes.Node) -> None:
             self._found_dropdowns.append(node)
 
     @property
-    def found_filter_dropdown(self) -> List[nodes.Node]:
+    def found_filter_dropdown(self) -> list[nodes.Node]:
         return self._found_dropdowns
 
 
 def page_filter_install(
     app: Sphinx,
     pagename: str,
     templatename: str,
-    context: Dict,
-    doctree: Optional[nodes.Node],
+    context: dict,
+    doctree: nodes.Node | None,
 ) -> None:
     """Install the javascript filter function."""
 

doc/_extensions/software_maturity_table.py

@@ -94,14 +94,14 @@
     ]
 """
 
+import requests
+import yaml
+from azure.storage.blob import ContainerClient
 from docutils import nodes
 from docutils.parsers.rst import directives
-from sphinx.util.docutils import SphinxDirective
 from sphinx.application import Sphinx
-from azure.storage.blob import ContainerClient
 from sphinx.util import logging
-import requests
-import yaml
+from sphinx.util.docutils import SphinxDirective
 
 __version__ = "0.1.1"