Convert all directives to dict style nodes

Author: bnmnetp

runestone/activecode/activecode.py

@@ -53,7 +53,7 @@ def setup(app):
     app.add_config_value("activecode_hide_load_history", False, "html")
     app.add_config_value("wasm_uri", "/_static", "html")
 
-    app.add_node(ActivecodeNode, html=(visit_ac_node, depart_ac_node),
+    app.add_node(ActivecodeNode, html=(visit_ac_html, depart_ac_html),
                  xml=(visit_ac_xml, depart_ac_xml))
 
     app.connect("doctree-resolved", process_activcode_nodes)
@@ -97,13 +97,9 @@ def depart_ac_xml(self, node):
 # self for these functions is an instance of the writer class.  For example
 # in html, self is sphinx.writers.html.SmartyPantsHTMLTranslator
 # The node that is passed as a parameter is an instance of our node class.
-def visit_ac_node(self, node):
+def visit_ac_html(self, node):
     # print self.settings.env.activecodecounter
 
-    # todo:  handle above in node["runestone_options"]
-    # todo handle  'hidecode' not in node["runestone_options"]:
-    # todo:  handle if 'gradebutton' in node["runestone_options"]: res += GRADES
-
     node["delimiter"] = "_start__{}_".format(node["runestone_options"]["divid"])
 
     self.body.append(node["delimiter"])
@@ -112,9 +108,9 @@ def visit_ac_node(self, node):
     self.body.append(res)
 
 
-def depart_ac_node(self, node):
+def depart_ac_html(self, node):
     """This is called at the start of processing an activecode node.  If activecode had recursive nodes
-    etc and did not want to do all of the processing in visit_ac_node any finishing touches could be
+    etc and did not want to do all of the processing in visit_ac_html any finishing touches could be
     added here.
     """
     res = TEMPLATE_END % node["runestone_options"]
@@ -451,7 +447,7 @@ def run(self):
                     "This should only affect the grading interface. Everything else should be fine."
                 )
 
-        acnode = ActivecodeNode(self.options, rawsource=self.block_text)
+        acnode = ActivecodeNode()
         acnode["runestone_options"] = self.options
         acnode["source"], acnode["line"] = self.state_machine.get_source_and_line(
             self.lineno)

runestone/assignment/__init__.py

@@ -36,7 +36,7 @@
 
 def setup(app):
     app.add_directive("assignment", Assignment)
-    app.add_node(AssignmentNode, html=(visit_a_node, depart_a_node))
+    app.add_node(AssignmentNode, html=(visit_a_html, depart_a_html))
 
     app.connect("doctree-resolved", process_nodes)
     app.connect("env-purge-doc", purge)
@@ -54,13 +54,13 @@ def __init__(self, content, **kwargs):
         self.a_components = content
 
 
-def visit_a_node(self, node):
+def visit_a_html(self, node):
     pass
 
 
-def depart_a_node(self, node):
-    question_ids = node.a_components["question_ids"]
-    basecourse = node.a_components["basecourse"]
+def depart_a_html(self, node):
+    question_ids = node["a_components"]["question_ids"]
+    basecourse = node["a_components"]["basecourse"]
     for q_id in question_ids:
         src = get_HTML_from_DB(q_id, basecourse)
         if src:

runestone/blockly/blockly.py

@@ -33,7 +33,7 @@
 def setup(app):
     app.add_directive("blockly", Blockly)
 
-    app.add_node(BlocklyNode, html=(visit_block_node, depart_block_node))
+    app.add_node(BlocklyNode, html=(visit_block_html, depart_block_html))
 
     app.connect("doctree-resolved", process_activcode_nodes)
     app.connect("env-purge-doc", purge_activecodes)
@@ -154,10 +154,12 @@ def __init__(self, content, **kwargs):
 # self for these functions is an instance of the writer class.  For example
 # in html, self is sphinx.writers.html.SmartyPantsHTMLTranslator
 # The node that is passed as a parameter is an instance of our node class.
-def visit_block_node(self, node):
-    res = START % (node.runestone_options)
+
+
+def visit_block_html(self, node):
+    res = START % (node["runestone_options"])
     res += CTRL_START
-    for ctrl in node.runestone_options["controls"]:
+    for ctrl in node["runestone_options"]["controls"]:
         if ctrl == "variables":
             res += '<category name="Variables" custom="VARIABLE"></category>'
         elif ctrl == "":
@@ -169,11 +171,11 @@ def visit_block_node(self, node):
         else:
             res += '<block type="%s"></block>\n' % (ctrl)
     res += CTRL_END
-    res += END % (node.runestone_options)
+    res += END % (node["runestone_options"])
     path = os.path.join(
-        node.runestone_options["blocklyHomePrefix"],
+        node["runestone_options"]["blocklyHomePrefix"],
         "_static",
-        node.runestone_options["divid"] + ".html",
+        node["runestone_options"]["divid"] + ".html",
     )
     final = (
         '<iframe class="blk-iframe" seamless src="%s" width="600" '
@@ -185,9 +187,9 @@ def visit_block_node(self, node):
     self.body.append(final)
 
 
-def depart_block_node(self, node):
+def depart_block_html(self, node):
     """ This is called at the start of processing an activecode node.  If activecode had recursive nodes
-        etc and did not want to do all of the processing in visit_ac_node any finishing touches could be
+        etc and did not want to do all of the processing in visit_ac_html any finishing touches could be
         added here.
     """
     pass

runestone/cellbotics/__init__.py

@@ -31,7 +31,7 @@ class BlePairNode(nodes.General, nodes.Element):
     pass
 
 
-def visit_ble_pair_node(self, node):
+def visit_ble_pair_html(self, node):
     self.body.append(
         '<div data-component="ble">\n'
         '   <script>runestone_import("ble");</script>\n'
@@ -41,7 +41,7 @@ def visit_ble_pair_node(self, node):
     )
 
 
-def depart_ble_pair_node(self, node):
+def depart_ble_pair_html(self, node):
     pass
 
 
@@ -57,5 +57,5 @@ def run(self):
 
 def setup(app):
     # Add the Pair button directive.
-    app.add_node(BlePairNode, html=(visit_ble_pair_node, depart_ble_pair_node))
+    app.add_node(BlePairNode, html=(visit_ble_pair_html, depart_ble_pair_html))
     app.add_directive('ble-pair-button', BlePairDirective)

runestone/clickableArea/clickable.py

@@ -29,7 +29,7 @@
 def setup(app):
     app.add_directive("clickablearea", ClickableArea)
 
-    app.add_node(ClickableAreaNode, html=(visit_ca_node, depart_ca_node))
+    app.add_node(ClickableAreaNode, html=(visit_ca_html, depart_ca_html))
 
     app.add_config_value("clickable_div_class", "runestone alert alert-warning", "html")
 
@@ -46,60 +46,53 @@ def setup(app):
 
 
 class ClickableAreaNode(nodes.General, nodes.Element, RunestoneIdNode):
-    def __init__(self, content, **kwargs):
-        """
-        Arguments:
-        - `self`:
-        - `content`:
-        """
-        super(ClickableAreaNode, self).__init__(**kwargs)
-        self.runestone_options = content
+    pass
 
 
 # self for these functions is an instance of the writer class.  For example
 # in html, self is sphinx.writers.html.SmartyPantsHTMLTranslator
 # The node that is passed as a parameter is an instance of our node class.
-def visit_ca_node(self, node):
+def visit_ca_html(self, node):
     res = TEMPLATE
 
-    node.delimiter = "_start__{}_".format(node.runestone_options["divid"])
-    self.body.append(node.delimiter)
+    node["delimiter"] = "_start__{}_".format(node["runestone_options"]["divid"])
+    self.body.append(node["delimiter"])
 
-    if "feedback" in node.runestone_options:
-        node.runestone_options["feedback"] = (
-            "<span data-feedback>" + node.runestone_options["feedback"] + "</span>"
+    if "feedback" in node["runestone_options"]:
+        node["runestone_options"]["feedback"] = (
+            "<span data-feedback>" + node["runestone_options"]["feedback"] + "</span>"
         )
     else:
-        node.runestone_options["feedback"] = ""
+        node["runestone_options"]["feedback"] = ""
 
-    if "iscode" not in node.runestone_options:
-        node.runestone_options["correct"] = (
-            "data-cc=" + '"' + node.runestone_options["correct"] + '"'
+    if "iscode" not in node["runestone_options"]:
+        node["runestone_options"]["correct"] = (
+            "data-cc=" + '"' + node["runestone_options"]["correct"] + '"'
         )
-        node.runestone_options["incorrect"] = (
-            "data-ci=" + '"' + node.runestone_options["incorrect"] + '"'
+        node["runestone_options"]["incorrect"] = (
+            "data-ci=" + '"' + node["runestone_options"]["incorrect"] + '"'
         )
     else:
-        node.runestone_options["correct"] = ""
-        node.runestone_options["incorrect"] = ""
+        node["runestone_options"]["correct"] = ""
+        node["runestone_options"]["incorrect"] = ""
 
-    res = res % node.runestone_options
+    res = res % node["runestone_options"]
 
     self.body.append(res)
 
 
-def depart_ca_node(self, node):
+def depart_ca_html(self, node):
     res = ""
-    res = TEMPLATE_END % node.runestone_options
+    res = TEMPLATE_END % node["runestone_options"]
     self.body.append(res)
 
     addHTMLToDB(
-        node.runestone_options["divid"],
-        node.runestone_options["basecourse"],
-        "".join(self.body[self.body.index(node.delimiter) + 1 :]),
+        node["runestone_options"]["divid"],
+        node["runestone_options"]["basecourse"],
+        "".join(self.body[self.body.index(node["delimiter"]) + 1 :]),
     )
 
-    self.body.remove(node.delimiter)
+    self.body.remove(node["delimiter"])
 
 
 class ClickableArea(RunestoneIdDirective):
@@ -166,11 +159,12 @@ def run(self):
             self.options["clickcode"] = source
         else:
             self.options["clickcode"] = ""
-        clickNode = ClickableAreaNode(self.options, rawsource=self.block_text)
-        clickNode.source, clickNode.line = self.state_machine.get_source_and_line(
+        clickNode = ClickableAreaNode()
+        clickNode["runestone_options"] = self.options
+        clickNode["source"], clickNode["line"] = self.state_machine.get_source_and_line(
             self.lineno
         )
-        clickNode.template_start = TEMPLATE
+        clickNode["template_start"] = TEMPLATE
 
         if "table" in self.options:
             self.options["table"] = "data-table"

runestone/codelens/visualizer.py

@@ -31,7 +31,7 @@ def setup(app):
 
     app.add_config_value("codelens_div_class", "alert alert-warning cd_section", "html")
     app.add_config_value("trace_url", "http://tracer.runestone.academy:5000", "html")
-    app.add_node(CodeLensNode, html=(visit_codelens_node, depart_codelens_node))
+    app.add_node(CodeLensNode, html=(visit_codelens_html, depart_codelens_html))
 
 
 #  data-tracefile="pytutor-embed-demo/java.json"
@@ -62,28 +62,26 @@ def setup(app):
 
 
 class CodeLensNode(nodes.General, nodes.Element, RunestoneIdNode):
-    def __init__(self, content, **kwargs):
-        super().__init__(**kwargs)
-        self.runestone_options = content
+    pass
 
 
-def visit_codelens_node(self, node):
+def visit_codelens_html(self, node):
     html = VIS
-    if "caption" not in node.runestone_options:
-        node.runestone_options["caption"] = node.runestone_options["question_label"]
-    if "tracedata" in node.runestone_options:
+    if "caption" not in node["runestone_options"]:
+        node["runestone_options"]["caption"] = node["runestone_options"]["question_label"]
+    if "tracedata" in node["runestone_options"]:
         html += DATA
     else:
         html += "</div>"
-    html = html % node.runestone_options
+    html = html % node["runestone_options"]
 
     self.body.append(html)
     addHTMLToDB(
-        node.runestone_options["divid"], node.runestone_options["basecourse"], html
+        node["runestone_options"]["divid"], node["runestone_options"]["basecourse"], html
     )
 
 
-def depart_codelens_node(self, node):
+def depart_codelens_html(self, node):
     pass
 
 
@@ -227,8 +225,9 @@ def js_var_finalizer(input_code, output_trace):
                 else:
                     raise ValueError("language not supported")
 
-        cl_node = CodeLensNode(self.options, rawsource=self.block_text)
-        cl_node.source, cl_node.line = self.state_machine.get_source_and_line(
+        cl_node = CodeLensNode()
+        cl_node["runestone_options"] = self.options
+        cl_node["source"], cl_node["line"] = self.state_machine.get_source_and_line(
             self.lineno
         )
         return [cl_node]

runestone/common/question_number.py

@@ -18,7 +18,6 @@
 # After the section numbers are available from the TOC tree, determine the section number for each Runestone component with an ID.
 def _insert_qnum(app, doctree, docname):
     toc = app.env.toc_secnumbers.get(docname, {})
-    pdb.set_trace()
     # Return the section number tuple for the given ``section_ref`` if it exists, or None if not.
 
     def get_secnum_tuple(section_ref):
@@ -49,9 +48,12 @@ def get_secnum_tuple(section_ref):
             question_number_str = ".".join(map(str, question_number_tuple))
             # Update the database.
             addQNumberToDB(app, node, question_number_str)
-            pdb.set_trace()
-            div_id = node["runestone_options"]["divid"]
-            node["runestone_options"]["question_label"] = question_number_str
+            try:
+                div_id = node["runestone_options"]["divid"]
+                node["runestone_options"]["question_label"] = question_number_str
+            except:
+                div_id = node.runestone_options["divid"]
+                node.runestone_options["question_label"] = question_number_str
             # Prepare to number the next question.
             current_question_number += 1
         else: