Reformat code for improved readability

Consolidated multi-line statements into single lines across multiple files to enhance code readability and maintain consistency. No functional changes were made.

Author: douden

sphinx_external_toc/_compat.py

@@ -19,9 +19,7 @@ def field(**kwargs: Any):
     if sys.version_info < (3, 10):
         kwargs.pop("kw_only", None)
     if "validator" in kwargs:
-        kwargs.setdefault("metadata", {})["validator"] = kwargs.pop(
-            "validator"
-        )
+        kwargs.setdefault("metadata", {})["validator"] = kwargs.pop("validator")
     return dc.field(**kwargs)
 
 
@@ -95,9 +93,7 @@ def matches_re(regex: str | Pattern, flags: int = 0) -> ValidatorType:
     if fullmatch:
         match_func = pattern.fullmatch
     else:  # Python 2 fullmatch emulation (https://bugs.python.org/issue16203)
-        pattern = re.compile(
-            r"(?:{})\Z".format(pattern.pattern), pattern.flags
-        )
+        pattern = re.compile(r"(?:{})\Z".format(pattern.pattern), pattern.flags)
         match_func = pattern.match
 
     def _validator(inst, attr, value):
@@ -170,6 +166,4 @@ def validate_style(instance, attribute, value):
                     f"{attribute.name} must be one of {allowed}, not {v!r}"
                 )
     elif value not in allowed:
-        raise ValueError(
-            f"{attribute.name} must be one of {allowed}, not {value!r}"
-        )
+        raise ValueError(f"{attribute.name} must be one of {allowed}, not {value!r}")

sphinx_external_toc/api.py

@@ -37,9 +37,7 @@ class UrlItem:
 
     # regex should match sphinx.util.url_re
     url: str = field(validator=[instance_of(str), matches_re(URL_PATTERN)])
-    title: Optional[str] = field(
-        default=None, validator=optional(instance_of(str))
-    )
+    title: Optional[str] = field(default=None, validator=optional(instance_of(str)))
 
     def __post_init__(self):
         validate_fields(self)
@@ -58,19 +56,13 @@ class TocTree:
     caption: Optional[str] = field(
         default=None, kw_only=True, validator=optional(instance_of(str))
     )
-    hidden: bool = field(
-        default=True, kw_only=True, validator=instance_of(bool)
-    )
+    hidden: bool = field(default=True, kw_only=True, validator=instance_of(bool))
     maxdepth: int = field(default=-1, kw_only=True, validator=instance_of(int))
     numbered: Union[bool, int] = field(
         default=False, kw_only=True, validator=instance_of((bool, int))
     )
-    reversed: bool = field(
-        default=False, kw_only=True, validator=instance_of(bool)
-    )
-    titlesonly: bool = field(
-        default=False, kw_only=True, validator=instance_of(bool)
-    )
+    reversed: bool = field(default=False, kw_only=True, validator=instance_of(bool))
+    titlesonly: bool = field(default=False, kw_only=True, validator=instance_of(bool))
     # Add extra field for style of toctree rendering
     style: Union[List[str], str] = field(
         default="numerical", kw_only=True, validator=validate_style
@@ -109,9 +101,7 @@ class Document:
         default_factory=list,
         validator=deep_iterable(instance_of(TocTree), instance_of(list)),
     )
-    title: Optional[str] = field(
-        default=None, validator=optional(instance_of(str))
-    )
+    title: Optional[str] = field(default=None, validator=optional(instance_of(str)))
 
     def __post_init__(self):
         validate_fields(self)
@@ -177,9 +167,7 @@ def file_format(self, value: Optional[str]) -> None:
 
     def globs(self) -> Set[str]:
         """Return set of all globs present across all toctrees."""
-        return {
-            glob for item in self._docs.values() for glob in item.child_globs()
-        }
+        return {glob for item in self._docs.values() for glob in item.child_globs()}
 
     def __getitem__(self, docname: str) -> Document:
         """Enable retrieving a document by name using the indexing operator.

sphinx_external_toc/cli.py

@@ -27,11 +27,7 @@ def main():
 def parse_toc(toc_file):
     """Parse a ToC file to a site-map YAML."""
     site_map = parse_toc_yaml(toc_file)
-    click.echo(
-        yaml.dump(
-            site_map.as_json(), sort_keys=False, default_flow_style=False
-        )
-    )
+    click.echo(yaml.dump(site_map.as_json(), sort_keys=False, default_flow_style=False))
 
 
 @main.command("to-project")
@@ -51,9 +47,7 @@ def parse_toc(toc_file):
     show_default=True,
     help="The default file extension to use.",
 )
-@click.option(
-    "-o", "--overwrite", is_flag=True, help="Overwrite existing files."
-)
+@click.option("-o", "--overwrite", is_flag=True, help="Overwrite existing files.")
 def create_site(toc_file, path, extension, overwrite):
     """Create a project directory from a ToC file."""
     create_site_from_toc(
@@ -107,9 +101,7 @@ def create_site(toc_file, path, extension, overwrite):
     show_default=True,
     help="The key-mappings to use.",
 )
-def create_toc(
-    site_dir, extension, index, skip_match, guess_titles, file_format
-):
+def create_toc(site_dir, extension, index, skip_match, guess_titles, file_format):
     """Create a ToC file from a project directory."""
     site_map = create_site_map_from_path(
         site_dir,
@@ -125,19 +117,11 @@ def create_toc(
                 continue
             filepath = PurePosixPath(docname)
             # use the folder name for index files
-            name = (
-                filepath.parent.name
-                if filepath.name == index
-                else filepath.name
-            )
+            name = filepath.parent.name if filepath.name == index else filepath.name
             # split into words
             words = name.split("_")
             # remove first word if is an integer
-            words = (
-                words[1:]
-                if words and all(c.isdigit() for c in words[0])
-                else words
-            )
+            words = words[1:] if words and all(c.isdigit() for c in words[0]) else words
             site_map[docname].title = " ".join(words).capitalize()
     data = create_toc_dict(site_map)
     click.echo(yaml.dump(data, sort_keys=False, default_flow_style=False))
@@ -154,9 +138,7 @@ def create_toc(
 @click.option(
     "-o",
     "--output",
-    type=click.Path(
-        allow_dash=True, exists=False, file_okay=True, dir_okay=False
-    ),
+    type=click.Path(allow_dash=True, exists=False, file_okay=True, dir_okay=False),
     help="Write to a file path.",
 )
 def migrate_toc(toc_file, format, output):

sphinx_external_toc/collectors.py

@@ -32,9 +32,7 @@ def __init__(self, *args, **kwargs):
 
     def assign_section_numbers(self, env):
         # First, call the original assign_section_numbers to get the default behavior
-        result = super().assign_section_numbers(
-            env
-        )  # needed to maintain functionality
+        result = super().assign_section_numbers(env)  # needed to maintain functionality
 
         # store current titles for mapping
         env.titles_old = copy.deepcopy(env.titles)
@@ -82,9 +80,7 @@ def assign_section_numbers(self, env):
                         new_secnumber = self.__renumber(
                             env.titles[ref]["secnumber"], style
                         )
-                        env.titles[ref]["secnumber"] = copy.deepcopy(
-                            new_secnumber
-                        )
+                        env.titles[ref]["secnumber"] = copy.deepcopy(new_secnumber)
                         if ref in env.tocs:
                             self.__replace_toc(env, ref, env.tocs[ref], style)
 
@@ -116,17 +112,13 @@ def assign_section_numbers(self, env):
                             secnumber[i] == old_secnumber[i]
                         ):  # only if the old matches the current
                             update_secnumber[i] = new_secnumber[i]
-                    env.toc_secnumbers[doc][anchor] = copy.deepcopy(
-                        update_secnumber
-                    )
+                    env.toc_secnumbers[doc][anchor] = copy.deepcopy(update_secnumber)
 
         # now iterate over env.toc_secnumbers to ensure all secnumbers are updated
         # at the same time
         for docname in env.toc_secnumbers:
             # get the new and old secnumbers for this docname
-            old_secnumber = env.titles_old.get(docname, {}).get(
-                "secnumber", None
-            )
+            old_secnumber = env.titles_old.get(docname, {}).get("secnumber", None)
             new_secnumber = env.titles[docname].get("secnumber", None)
             renumber_depth = len(new_secnumber) if new_secnumber else 0
             # iterate over all anchors in this docname
@@ -147,9 +139,7 @@ def assign_section_numbers(self, env):
                         secnumber[i] == old_secnumber[i]
                     ):  # only if the old matches the current
                         update_secnumber[i] = new_secnumber[i]
-                env.toc_secnumbers[doc][anchor] = copy.deepcopy(
-                    update_secnumber
-                )
+                env.toc_secnumbers[doc][anchor] = copy.deepcopy(update_secnumber)
 
         # Now, convert all secnumbers in toc_secnumbers to tuples
         # to avoid issues with other steps in the algorithm
@@ -158,19 +148,15 @@ def assign_section_numbers(self, env):
                 if not secnumber:
                     continue
                 secnumber = (*secnumber,)  # convert to tuple
-                env.toc_secnumbers[docname][anchorname] = copy.deepcopy(
-                    secnumber
-                )
+                env.toc_secnumbers[docname][anchorname] = copy.deepcopy(secnumber)
         return result
 
     def __renumber(self, number_set, style_set):
         if not number_set or not style_set:
             return number_set
 
         if not isinstance(style_set, list):
-            style_set = [
-                style_set
-            ]  # if not multiple styles are given, convert to list
+            style_set = [style_set]  # if not multiple styles are given, convert to list
         # for each style, convert the corresponding number, where only the first number
         # is rebased, the rest are kept as is, but converted.
         # convert the first number to the new style
@@ -262,9 +248,7 @@ def __fix_nested_toc(self, env, toctree, style):
 
             if "secnumber" not in env.titles[ref]:
                 continue
-            new_secnumber = self.__renumber(
-                env.titles[ref]["secnumber"], style
-            )
+            new_secnumber = self.__renumber(env.titles[ref]["secnumber"], style)
             env.titles[ref]["secnumber"] = copy.deepcopy(new_secnumber)
             if ref in env.tocs:
                 self.__replace_toc(env, ref, env.tocs[ref], style)

sphinx_external_toc/events.py

@@ -40,9 +40,7 @@ def create_warning(
     message = f"{message} [{wtype}.{category}]"
     kwargs = {"line": line} if line is not None else {}
 
-    if not logging.is_suppressed_warning(
-        wtype, category, app.config.suppress_warnings
-    ):
+    if not logging.is_suppressed_warning(wtype, category, app.config.suppress_warnings):
         msg_node = doctree.reporter.warning(message, **kwargs)
         if append_to is not None:
             append_to.append(msg_node)
@@ -70,13 +68,9 @@ def parse_toc_to_env(app: Sphinx, config: Config) -> None:
     else:
         path = Path(str(external_toc_path))
     if not path.exists():
-        raise ExtensionError(
-            f"[etoc] `external_toc_path` does not exist: {path}"
-        )
+        raise ExtensionError(f"[etoc] `external_toc_path` does not exist: {path}")
     if not path.is_file():
-        raise ExtensionError(
-            f"[etoc] `external_toc_path` is not a file: {path}"
-        )
+        raise ExtensionError(f"[etoc] `external_toc_path` is not a file: {path}")
     try:
         site_map = parse_toc_yaml(path)
     except Exception as exc:
@@ -117,24 +111,17 @@ def parse_toc_to_env(app: Sphinx, config: Config) -> None:
                         for i in range(len(components))
                     )
                     # don't exclude docnames matching globs
-                    or any(
-                        patmatch(posix_no_suffix, pat)
-                        for pat in site_map.globs()
-                    )
+                    or any(patmatch(posix_no_suffix, pat) for pat in site_map.globs())
                 ):
                     new_excluded.append(posix)
         if new_excluded:
             logger.info(
                 "[etoc] Excluded %s extra file(s) not in toc",
                 len(new_excluded),
             )
-            logger.debug(
-                "[etoc] Excluded extra file(s) not in toc: %r", new_excluded
-            )
+            logger.debug("[etoc] Excluded extra file(s) not in toc: %r", new_excluded)
             # Note, don't `extend` list, as it alters the default `Config.config_values`
-            config["exclude_patterns"] = (
-                config["exclude_patterns"] + new_excluded
-            )
+            config["exclude_patterns"] = config["exclude_patterns"] + new_excluded
 
 
 def add_changed_toctrees(
@@ -153,9 +140,7 @@ def add_changed_toctrees(
     if not previous_map:
         return set()
     filenames = site_map.get_changed(previous_map)
-    return {
-        remove_suffix(name, app.config.source_suffix) for name in filenames
-    }
+    return {remove_suffix(name, app.config.source_suffix) for name in filenames}
 
 
 class TableOfContentsNode(nodes.Element):
@@ -248,9 +233,7 @@ def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
         # TODO this wasn't in the original code,
         # but alabaster theme intermittently raised `KeyError('rawcaption')`
         subnode["rawcaption"] = toctree.caption or ""
-        subnode["glob"] = any(
-            isinstance(entry, GlobItem) for entry in toctree.items
-        )
+        subnode["glob"] = any(isinstance(entry, GlobItem) for entry in toctree.items)
         subnode["hidden"] = False if toc_placeholders else toctree.hidden
         subnode["includehidden"] = False
         subnode["numbered"] = (
@@ -281,9 +264,7 @@ def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
                     else:
                         message = f"toctree contains reference to nonexisting document {docname!r}"
 
-                    create_warning(
-                        app, doctree, "ref", message, append_to=node_list
-                    )
+                    create_warning(app, doctree, "ref", message, append_to=node_list)
                     app.env.note_reread()
                 else:
                     subnode["entries"].append((title, docname))
@@ -297,10 +278,10 @@ def insert_toctrees(app: Sphinx, doctree: nodes.document) -> None:
                     subnode["entries"].append((None, docname))
                     subnode["includefiles"].append(docname)
                 if not docnames:
-                    message = f"toctree glob pattern '{entry}' didn't match any documents"
-                    create_warning(
-                        app, doctree, "glob", message, append_to=node_list
+                    message = (
+                        f"toctree glob pattern '{entry}' didn't match any documents"
                     )
+                    create_warning(app, doctree, "glob", message, append_to=node_list)
 
         # reversing entries can be useful when globbing
         if toctree.reversed:
@@ -358,10 +339,6 @@ def ensure_index_file(app: Sphinx, exception: Optional[Exception]) -> None:
         # Assume a single index for all non dir-HTML builders
         redirect_url = f"{root_name}.html"
 
-    redirect_text = (
-        f'<meta http-equiv="Refresh" content="0; url={redirect_url}" />\n'
-    )
+    redirect_text = f'<meta http-equiv="Refresh" content="0; url={redirect_url}" />\n'
     index_path.write_text(redirect_text, encoding="utf8")
-    logger.info(
-        "[etoc] missing index.html written as redirect to '%s.html'", root_name
-    )
+    logger.info("[etoc] missing index.html written as redirect to '%s.html'", root_name)