refactoring

Author: AakashGfude

sphinx_proof/nodes.py

@@ -13,6 +13,8 @@
 from sphinx.writers.latex import LaTeXTranslator
 
 CR = '\n'
+latex_admonition_start = CR + '\\begin{sphinxadmonition}{note}'
+latex_admonition_end = '\\end{sphinxadmonition}' + CR
 
 class proof_node(nodes.Admonition, nodes.Element):
     pass
@@ -28,7 +30,7 @@ class unenumerable_node(nodes.Admonition, nodes.Element):
 
 def visit_enumerable_node(self, node: Node) -> None:
     if isinstance(self, LaTeXTranslator):
-        self.body.append(CR + '\\begin{sphinxadmonition}{note}')
+        self.body.append(latex_admonition)
     else:
         self.body.append(self.starttag(node, "div", CLASS="admonition"))
 
@@ -37,10 +39,9 @@ def depart_enumerable_node(self, node: Node) -> None:
     typ = node.attributes.get("type", "")
     if isinstance(self, LaTeXTranslator):
         number = get_node_number_latex(self, node)
-        text = node.children[0].astext()
-        idx = list_rindex(self.body,CR + '\\begin{sphinxadmonition}{note}') + 2
+        idx = list_rindex(self.body,latex_admonition) + 2
         self.body.insert(idx, f"{typ.title()} {number}")
-        self.body.append('\\end{sphinxadmonition}' + CR)
+        self.body.append(latex_admonition_end)
     else:
         # Find index in list of 'Proof #'
         number = get_node_number(self, node)
@@ -51,7 +52,7 @@ def depart_enumerable_node(self, node: Node) -> None:
 
 def visit_unenumerable_node(self, node: Node) -> None:
     if isinstance(self, LaTeXTranslator):
-        self.body.append(CR + '\\begin{sphinxadmonition}{note}')
+        self.body.append(latex_admonition)
     else:
         self.body.append(self.starttag(node, "div", CLASS="admonition"))
 
@@ -60,19 +61,14 @@ def depart_unenumerable_node(self, node: Node) -> None:
     typ = node.attributes.get("type", "")
     title = node.attributes.get("title", "")
     if isinstance(self, LaTeXTranslator):
-        if title == "":
-            idx = (len(self.body) - self.body[-1::-1].index(CR + '\\begin{sphinxadmonition}{note}')) + 1
-        else:
-            text = node.children[0].astext()
-            idx = list_rindex(self.body,CR + '\\begin{sphinxadmonition}{note}') + 2
+        idx = list_rindex(self.body,latex_admonition) + 2
         self.body.insert(idx, f"{typ.title()}")
-        self.body.append('\\end{sphinxadmonition}' + CR)
+        self.body.append(latex_admonition_end)
     else:
         if title == "":
-            idx = len(self.body) - self.body[-1::-1].index('<p class="admonition-title">')
+            idx = list_rindex(self.body,'<p class="admonition-title">') + 1
         else:
             idx = list_rindex(self.body,title)
-
         element = f"<span>{typ.title()} </span>"
         self.body.insert(idx, element)
         self.body.append("</div>")
@@ -85,15 +81,8 @@ def visit_proof_node(self, node: Node) -> None:
 def depart_proof_node(self, node: Node) -> None:
     pass
 
-
-def get_node_number(self: HTMLTranslator, node: Node) -> str:
-    key = "proof"
-    ids = node.attributes.get("ids", [])[0]
-    number = self.builder.fignumbers.get(key, {}).get(ids, ())
-    return ".".join(map(str, number))
-
 def find_parent(env, node , parent_tag):
-    """Find the parent node."""
+    """Find the nearest parent node with the given tagname."""
     while True:
         node = node.parent
         if node is None:
@@ -111,15 +100,24 @@ def find_parent(env, node , parent_tag):
 
     return None
 
-def get_node_number_latex(self, node: Node) -> str:
+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, {})
+    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):
+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