Sourcery refactored develop branch

src/sphinxcontrib/bibtex/domain.py

@@ -59,7 +59,7 @@ def _raise_invalid_node(node):
     """Helper method to raise an exception when an invalid node is
     visited.
     """
-    raise ValueError("invalid node %s in filter expression" % node)
+    raise ValueError(f"invalid node {node} in filter expression")
 
 
 class _FilterVisitor(ast.NodeVisitor):
@@ -95,7 +95,7 @@ def visit_BoolOp(self, node):
         else:  # pragma: no cover
             # there are no other boolean operators
             # so this code should never execute
-            assert False, "unexpected boolean operator %s" % node.op
+            assert False, f"unexpected boolean operator {node.op}"
 
     def visit_UnaryOp(self, node):
         if isinstance(node.op, ast.Not):
@@ -110,11 +110,9 @@ def visit_BinOp(self, node):
         if isinstance(op, ast.Mod):
             # modulo operator is used for regular expression matching
             if not isinstance(left, str):
-                raise ValueError(
-                    "expected a string on left side of %s" % node.op)
+                raise ValueError(f"expected a string on left side of {node.op}")
             if not isinstance(right, str):
-                raise ValueError(
-                    "expected a string on right side of %s" % node.op)
+                raise ValueError(f"expected a string on right side of {node.op}")
             return re.search(right, left, re.IGNORECASE)
         elif isinstance(op, ast.BitOr):
             return left | right
@@ -163,7 +161,7 @@ def visit_Name(self, node):
             return self.docname
         elif id_ == 'docnames':
             return self.cited_docnames
-        elif id_ == 'author' or id_ == 'editor':
+        elif id_ in ['author', 'editor']:
             if id_ in self.entry.persons:
                 return u' and '.join(
                     str(person)  # XXX needs fix in pybtex?
@@ -203,8 +201,7 @@ def get_docnames(env):
         yield docname
         parent, prevdoc, nextdoc = rel[docname]
         docname = nextdoc
-    for docname in sorted(env.found_docs - docnames):
-        yield docname
+    yield from sorted(env.found_docs - docnames)
 
 
 class Citation(NamedTuple):
@@ -287,7 +284,7 @@ def __init__(self, env: "BuildEnvironment"):
         self.object_types = dict(
             citation=ObjType(_('citation'), *role_names, searchprio=-1),
         )
-        self.roles = dict((name, CiteRole()) for name in role_names)
+        self.roles = {name: CiteRole() for name in role_names}
         # initialize the domain
         super().__init__(env)
         # connect env-updated
@@ -298,13 +295,13 @@ def __init__(self, env: "BuildEnvironment"):
                 "You must configure the bibtex_bibfiles setting")
         # update bib file information in the cache
         bibfiles = [
-            normpath_filename(env, "/" + bibfile)
-            for bibfile in env.app.config.bibtex_bibfiles]
+            normpath_filename(env, f"/{bibfile}")
+            for bibfile in env.app.config.bibtex_bibfiles
+        ]
+
         self.data['bibdata'] = process_bibdata(
             self.bibdata, bibfiles, env.app.config.bibtex_encoding)
-        # parse bibliography header
-        header = getattr(env.app.config, "bibtex_bibliography_header")
-        if header:
+        if header := getattr(env.app.config, "bibtex_bibliography_header"):
             self.data["bibliography_header"] += \
                 parse_header(header, "bibliography_header")
 
@@ -434,8 +431,7 @@ def get_all_cited_keys(self, docnames):
         """
         for citation_ref in sorted(
                 self.citation_refs, key=lambda c: docnames.index(c.docname)):
-            for key in citation_ref.keys:
-                yield key
+            yield from citation_ref.keys
 
     def get_entries(
             self, bibfiles: List[str]) -> Iterable["Entry"]:
@@ -468,9 +464,12 @@ def get_filtered_entries(
                 success = visitor.visit(bibliography.filter_)
             except ValueError as err:
                 logger.warning(
-                    "syntax error in :filter: expression; %s" % err,
+                    f"syntax error in :filter: expression; {err}",
                     location=(bibliography_key.docname, bibliography.line),
-                    type="bibtex", subtype="filter_syntax_error")
+                    type="bibtex",
+                    subtype="filter_syntax_error",
+                )
+
                 # recover by falling back to the default
                 success = bool(cited_docnames)
             if success or entry.key in bibliography.keys:
@@ -490,8 +489,7 @@ def get_sorted_entries(
             else:
                 yield key, entry
         # then all remaining keys, in order of bibliography file
-        for key, entry in entries.items():
-            yield key, entry
+        yield from entries.items()
 
     def get_formatted_entries(
             self, bibliography_key: "BibliographyKey", docnames: List[str],

src/sphinxcontrib/bibtex/foot_directives.py

@@ -35,22 +35,21 @@ def run(self):
             env.temp_data.get("bibtex_footbibliography_count", 0) + 1
         if not foot_new_refs:
             return []
-        else:
-            foot_old_refs |= foot_new_refs
-            foot_new_refs.clear()
-            # bibliography stored in env.temp_data["bibtex_foot_bibliography"]
-            foot_domain = cast("BibtexFootDomain", env.get_domain('footcite'))
-            foot_bibliography, env.temp_data["bibtex_foot_bibliography"] = (
-                env.temp_data["bibtex_foot_bibliography"],
-                foot_domain.bibliography_header.deepcopy())
-            domain = cast("BibtexDomain", env.get_domain('cite'))
-            for bibfile in domain.bibdata.bibfiles:
-                env.note_dependency(bibfile)
-            foot_bibliography['ids'] += _make_ids(
-                docname=env.docname, lineno=self.lineno,
-                ids=set(self.state.document.ids.keys()),
-                raw_id=env.app.config.bibtex_footbibliography_id.format(
-                    footbibliography_count=footbibliography_count))
-            self.state.document.note_explicit_target(
-                foot_bibliography, foot_bibliography)
-            return [foot_bibliography]
+        foot_old_refs |= foot_new_refs
+        foot_new_refs.clear()
+        # bibliography stored in env.temp_data["bibtex_foot_bibliography"]
+        foot_domain = cast("BibtexFootDomain", env.get_domain('footcite'))
+        foot_bibliography, env.temp_data["bibtex_foot_bibliography"] = (
+            env.temp_data["bibtex_foot_bibliography"],
+            foot_domain.bibliography_header.deepcopy())
+        domain = cast("BibtexDomain", env.get_domain('cite'))
+        for bibfile in domain.bibdata.bibfiles:
+            env.note_dependency(bibfile)
+        foot_bibliography['ids'] += _make_ids(
+            docname=env.docname, lineno=self.lineno,
+            ids=set(self.state.document.ids.keys()),
+            raw_id=env.app.config.bibtex_footbibliography_id.format(
+                footbibliography_count=footbibliography_count))
+        self.state.document.note_explicit_target(
+            foot_bibliography, foot_bibliography)
+        return [foot_bibliography]

src/sphinxcontrib/bibtex/foot_domain.py

@@ -54,12 +54,10 @@ def __init__(self, env: "BuildEnvironment"):
         self.object_types = dict(
             citation=ObjType(_('citation'), *role_names, searchprio=-1),
         )
-        self.roles = dict((name, FootCiteRole()) for name in role_names)
+        self.roles = {name: FootCiteRole() for name in role_names}
         # initialize the domain
         super().__init__(env)
-        # parse bibliography header
-        header = getattr(env.app.config, "bibtex_footbibliography_header")
-        if header:
+        if header := getattr(env.app.config, "bibtex_footbibliography_header"):
             self.data["bibliography_header"] += \
                 parse_header(header, "foot_bibliography_header")
 

src/sphinxcontrib/bibtex/foot_roles.py

@@ -78,10 +78,7 @@ def result_nodes(self, document: "docutils.nodes.document",
                 if key not in (foot_old_refs | foot_new_refs):
                     footnote = docutils.nodes.footnote(auto=1)
                     # no automatic ids for footnotes: force non-empty template
-                    template: str = \
-                        env.app.config.bibtex_footcite_id \
-                        if env.app.config.bibtex_footcite_id \
-                        else "footcite-{key}"
+                    template: str = env.app.config.bibtex_footcite_id or "footcite-{key}"
                     raw_id = template.format(
                             footbibliography_count=footbibliography_count + 1,
                             key=entry.key)

src/sphinxcontrib/bibtex/style/template.py

@@ -183,7 +183,9 @@ def render(self, backend: "BaseBackend"):
         info = self.info[0]
         # see docutils.parsers.rst.states.Body.footnote_reference()
         refnode = docutils.nodes.footnote_reference(
-            '[#%s]_' % info.key, refname=info.refname, auto=1)
+            f'[#{info.key}]_', refname=info.refname, auto=1
+        )
+
         info.document.note_autofootnote_ref(refnode)
         info.document.note_footnote_ref(refnode)
         return [refnode]

src/sphinxcontrib/bibtex/transforms.py

@@ -80,23 +80,19 @@ def run(self, **kwargs):
                 nodes = []
             for citation in citations:
                 citation_node = bibliography.citation_nodes[citation.key]
-                if bibliography.list_ in {"enumerated", "bullet"}:
-                    citation_node += self.backend.paragraph(
-                        citation.formatted_entry)
-                else:  # "citation"
-                    # backrefs only supported in same document
-                    backrefs = [
+                if bibliography.list_ not in {"enumerated", "bullet"}:
+                    if backrefs := [
                         citation_ref.citation_ref_id
                         for citation_ref in domain.citation_refs
                         if bib_key.docname == citation_ref.docname
-                        and citation.key in citation_ref.keys]
-                    if backrefs:
+                        and citation.key in citation_ref.keys
+                    ]:
                         citation_node['backrefs'] = backrefs
                     citation_node += docutils.nodes.label(
                         '', citation.formatted_entry.label,
                         support_smartquotes=False)
-                    citation_node += self.backend.paragraph(
-                        citation.formatted_entry)
+                citation_node += self.backend.paragraph(
+                    citation.formatted_entry)
                 citation_node['docname'] = bib_key.docname
                 node_text_transform(citation_node)
                 nodes.append(citation_node)