pre-commit runs

Author: AakashGfude

sphinx_proof/__init__.py

@@ -76,21 +76,21 @@ def setup(app: Sphinx) -> Dict[str, Any]:
         proof_node,
         singlehtml=(visit_proof_node, depart_proof_node),
         html=(visit_proof_node, depart_proof_node),
-        latex=(visit_proof_node, depart_proof_node)
+        latex=(visit_proof_node, depart_proof_node),
     )
     app.add_node(
         unenumerable_node,
         singlehtml=(visit_unenumerable_node, depart_unenumerable_node),
         html=(visit_unenumerable_node, depart_unenumerable_node),
-        latex=(visit_unenumerable_node, depart_unenumerable_node)
+        latex=(visit_unenumerable_node, depart_unenumerable_node),
     )
     app.add_enumerable_node(
         enumerable_node,
         "proof",
         None,
         singlehtml=(visit_enumerable_node, depart_enumerable_node),
         html=(visit_enumerable_node, depart_enumerable_node),
-        latex=(visit_enumerable_node, depart_enumerable_node)
+        latex=(visit_enumerable_node, depart_enumerable_node),
     )
 
     return {

sphinx_proof/directive.py

@@ -97,7 +97,7 @@ def run(self) -> List[Node]:
             "prio": 0,
             "nonumber": True if "nonumber" in self.options else False,
         }
-        
+
         return [node]
 
 

sphinx_proof/domain.py

@@ -7,7 +7,7 @@
 :copyright: Copyright 2020 by the QuantEcon team, see AUTHORS
 :licences: see LICENSE for details
 """
-from typing import Any, Dict, Tuple, List
+from typing import Any, Dict, Tuple, List, Callable
 from docutils.nodes import Element, Node, document, system_message
 from sphinx.environment import BuildEnvironment
 from sphinx.addnodes import pending_xref
@@ -41,7 +41,7 @@ def generate(self, docnames=None) -> Tuple[Dict[str, Any], bool]:
         # import pdb;
         # pdb.set_trace()
         proofs = self.domain.env.proof_list
-        # {'theorem-0': {'docname': 'start/overview', 'type': 'theorem', 'ids': ['theorem-0'], 'label': 'theorem-0', 'prio': 0, 'nonumber': False}}
+        # {'theorem-0': {'docname': 'start/overview', 'type': 'theorem', 'ids': ['theorem-0'], 'label': 'theorem-0', 'prio': 0, 'nonumber': False}} # noqa: E501
 
         # name, subtype, docname, typ, anchor, extra, qualifier, description
         for anchor, values in proofs.items():
@@ -75,19 +75,21 @@ class ProofDomain(Domain):
     name = "prf"
     label = "Proof Domain"
 
-    roles = {"ref": ProofXRefRole()} # role name -> role callable
+    roles = {"ref": ProofXRefRole()}  # role name -> role callable
 
-    indices = {ProofIndex} # a list of index subclasses
+    indices = {ProofIndex}  # a list of index subclasses
 
-    directives = {**{"proof": ProofDirective}, **PROOF_TYPES} # list of directives
+    directives = {**{"proof": ProofDirective}, **PROOF_TYPES}  # list of directives
 
-    enumerable_nodes = {}  # type: Dict[Type[Node], Tuple[str, Callable]]
+    enumerable_nodes = {}  # type: Dict[[Node], Tuple[str, Callable]]
 
     def __init__(self, env: "BuildEnvironment") -> None:
         super().__init__(env)
 
         # set up enumerable nodes
-        self.enumerable_nodes = copy(self.enumerable_nodes)  # create a copy for this instance
+        self.enumerable_nodes = copy(
+            self.enumerable_nodes
+        )  # create a copy for this instance
         for node, settings in env.app.registry.enumerable_nodes.items():
             self.enumerable_nodes[node] = settings
 
@@ -102,11 +104,12 @@ def resolve_xref(
         contnode: Element,
     ) -> Element:
         """
-        Resolve the pending_xref node with the given typ and target. This method should return a new node, 
-        to replace the xref node, containing the contnode which is the markup content of the cross-reference.
-        If no resolution can be found, None can be returned; the xref node will then given to the missing-reference event, 
-        and if that yields no resolution, replaced by contnode.The method can also raise sphinx.environment.NoUri 
-        to suppress the missing-reference event being emitted.
+        Resolve the pending_xref node with the given typ and target. This method should
+        return a new node, to replace the xref node, containing the contnode which is
+        the markup content of the cross-reference. If no resolution can be found, None
+        can be returned; the xref node will then given to the missing-reference event,
+        and if that yields no resolution, replaced by contnode.The method can also raise
+        sphinx.environment.NoUri to suppress the missing-reference event being emitted.
         """
         try:
             match = env.proof_list[target]

sphinx_proof/nodes.py

@@ -12,9 +12,10 @@
 from docutils.nodes import Node
 from sphinx.writers.latex import LaTeXTranslator
 
-CR = '\n'
-latex_admonition_start = CR + '\\begin{sphinxadmonition}{note}'
-latex_admonition_end = '\\end{sphinxadmonition}' + CR
+CR = "\n"
+latex_admonition_start = CR + "\\begin{sphinxadmonition}{note}"
+latex_admonition_end = "\\end{sphinxadmonition}" + CR
+
 
 class proof_node(nodes.Admonition, nodes.Element):
     pass
@@ -30,7 +31,7 @@ class unenumerable_node(nodes.Admonition, nodes.Element):
 
 def visit_enumerable_node(self, node: Node) -> None:
     if isinstance(self, LaTeXTranslator):
-        self.body.append(latex_admonition)
+        self.body.append(latex_admonition_start)
     else:
         self.body.append(self.starttag(node, "div", CLASS="admonition"))
 
@@ -39,7 +40,7 @@ def depart_enumerable_node(self, node: Node) -> None:
     typ = node.attributes.get("type", "")
     if isinstance(self, LaTeXTranslator):
         number = get_node_number_latex(self, node)
-        idx = list_rindex(self.body,latex_admonition) + 2
+        idx = list_rindex(self.body, latex_admonition_start) + 2
         self.body.insert(idx, f"{typ.title()} {number}")
         self.body.append(latex_admonition_end)
     else:
@@ -52,7 +53,7 @@ def depart_enumerable_node(self, node: Node) -> None:
 
 def visit_unenumerable_node(self, node: Node) -> None:
     if isinstance(self, LaTeXTranslator):
-        self.body.append(latex_admonition)
+        self.body.append(latex_admonition_start)
     else:
         self.body.append(self.starttag(node, "div", CLASS="admonition"))
 
@@ -61,14 +62,14 @@ def depart_unenumerable_node(self, node: Node) -> None:
     typ = node.attributes.get("type", "")
     title = node.attributes.get("title", "")
     if isinstance(self, LaTeXTranslator):
-        idx = list_rindex(self.body,latex_admonition) + 2
+        idx = list_rindex(self.body, latex_admonition_start) + 2
         self.body.insert(idx, f"{typ.title()}")
         self.body.append(latex_admonition_end)
     else:
         if title == "":
-            idx = list_rindex(self.body,'<p class="admonition-title">') + 1
+            idx = list_rindex(self.body, '<p class="admonition-title">') + 1
         else:
-            idx = list_rindex(self.body,title)
+            idx = list_rindex(self.body, title)
         element = f"<span>{typ.title()} </span>"
         self.body.insert(idx, element)
         self.body.append("</div>")
@@ -81,7 +82,8 @@ def visit_proof_node(self, node: Node) -> None:
 def depart_proof_node(self, node: Node) -> None:
     pass
 
-def find_parent(env, node , parent_tag):
+
+def find_parent(env, node, parent_tag):
     """Find the nearest parent node with the given tagname."""
     while True:
         node = node.parent
@@ -93,32 +95,37 @@ def find_parent(env, node , parent_tag):
             and env.titles[node.attributes["docname"]].astext().lower()
             in node.attributes["names"]
         ):
-            return node.attributes['docname']
+            return node.attributes["docname"]
 
     if node.tagname == parent_tag:
-        return node.attributes['docname']
+        return node.attributes["docname"]
 
     return None
 
+
 def get_node_number(self: HTMLTranslator, node: Node) -> str:
     """Get the number for the directive node for HTML."""
     key = "proof"
     ids = node.attributes.get("ids", [])[0]
     number = self.builder.fignumbers.get(key, {}).get(ids, ())
     return ".".join(map(str, number))
 
+
 def get_node_number_latex(self: LaTeXTranslator, node: Node) -> str:
     """Get the number for the directive node for LaTeX."""
     key = "proof"
     docname = find_parent(self.builder.env, node, "section")
     ids = node.attributes.get("ids", [])[0]
-    fignumbers = self.builder.env.toc_fignumbers.get(docname, {}) # Latex does not have builder.fignumbers
+    fignumbers = self.builder.env.toc_fignumbers.get(
+        docname, {}
+    )  # Latex does not have builder.fignumbers
     number = fignumbers.get(key, {}).get(ids, ())
     return ".".join(map(str, number))
 
+
 def list_rindex(li, x) -> int:
     """Getting the last occurence of an item in a list."""
     for i in reversed(range(len(li))):
         if li[i] == x:
             return i
-    raise ValueError("{} is not in list".format(x))
+    raise ValueError("{} is not in list".format(x))