fix: single quoting

Author: kdmccormick

xmodule/modulestore/xml_exporter.py

@@ -1,10 +1,11 @@
 """
 Methods for exporting course data to XML
 """
-
+from __future__ import annotations
 
 import logging
 import os
+import typing as t
 from abc import abstractmethod
 from json import dumps
 
@@ -191,57 +192,59 @@ def _convert_attrs_to_single_quotes(xml_str: str) -> t.Iterable[str]:
     @@TODO document
     """
     xml_chars = iter(xml_str)
-    while c := next(xml_chars):
-        # We're outside of any tag
-        if c == "<":
-            yield "<"
-            # We're inside a tag: < ... >
-            while c := next(xml_chars):
-                if c == ">":
-                    yield ">"
-                    break  # Done with the tag, back to the outside
-                elif c == "\"":
-                    yield "'"  # Yield single quote in place of double
-                    # We're inside an attribute value: <tagname yada=" ... ">
-                    while c := next(xml_chars):
-                        if c == "\"":
-                            yield "'"  # Yield single quote in place of double
-                            break  # Done with the attribute value, back to the tag
-                        elif c == "'":
-                            yield "&apos;"  # Single quote in attr --> convert to escape sequence
-                        elif c == "&":
-                            # We're inside an escape sequence: <tagname yada="blah &...; blah">
-                            escape_code = ""
-                            while c := next(xml_chars):
-                                if c == ";":
-                                    break  # Done with escape sequence
+    try:
+        while c := next(xml_chars):
+            # We're outside of any tag
+            if c == "<":
+                yield "<"
+                # We're inside a tag: < ... >
+                while c := next(xml_chars):
+                    if c == ">":
+                        yield ">"
+                        break  # Done with the tag, back to the outside
+                    elif c == "\"":
+                        yield "'"  # Yield single quote in place of double
+                        # We're inside an attribute value: <tagname yada=" ... ">
+                        while c := next(xml_chars):
+                            if c == "\"":
+                                yield "'"  # Yield single quote in place of double
+                                break  # Done with the attribute value, back to the tag
+                            elif c == "'":
+                                yield "&apos;"  # Single quote in attr --> convert to escape sequence
+                            elif c == "&":
+                                # We're inside an escape sequence: <tagname yada="blah &...; blah">
+                                escape_code = ""
+                                while c := next(xml_chars):
+                                    if c == ";":
+                                        break  # Done with escape sequence
+                                    else:
+                                        escape_code += c
+                                if escape_code == "quot":
+                                    yield "\""  # Escape sequence is &quot; --> convert to literal double-qoute
                                 else:
-                                    escape_code += c
-                            if escape_code == "quot":
-                                yield "\""  # Escape sequence is &quot; --> convert to literal double-qoute
+                                    yield "&{escape_code};"  # Any other escape sequence --> leave it as-is
                             else:
-                                yield "&{escape_code};"  # Any other escape sequence --> leave it as-is
-                        else:
-                            yield c
-                else:
-                    yield c
-        else:
-            yield c
+                                yield c
+                    else:
+                        yield c
+            else:
+                yield c
+    except StopIteration:
+        pass
 
 
 def _write_xml(root_node: etree._Element, target_file: IO[str]) -> None:
     """
     @@TODO does this work for libs and courses?
     @@TODO make it work for blocks
     """
-    target_file.write(
-        "".join(
-            _convert_attrs_to_single_quotes(
-                lxml.etree.tostring(root_node, pretty_print=True, encoding='utf-8')
-            )
-        )
-    )
-    #lxml.etree.ElementTree(root_node).(target_file, encoding='utf-8')
+    xml_str = lxml.etree.tostring(root_node, pretty_print=True, encoding='utf-8').decode('utf-8')
+    convert_quotes = lambda: True
+    if convert_quotes():
+        target_file.write("".join(_convert_attrs_to_single_quotes(xml_str)))
+    else:
+        target_file.write(xml_str)
+
 
 class CourseExportManager(ExportManager):
     """
@@ -261,7 +264,7 @@ def get_courselike(self):
         return self.modulestore.get_course(self.courselike_key, depth=None, lazy=False)
 
     def process_root(self, root, export_fs):
-        with export_fs.open('course.xml', 'wb') as course_xml:
+        with export_fs.open('course.xml', 'w') as course_xml:
             _write_xml(root, course_xml)
 
     def process_extra(self, root, courselike, root_courselike_dir, xml_centric_courselike_key, export_fs):
@@ -275,7 +278,7 @@ def process_extra(self, root, courselike, root_courselike_dir, xml_centric_cours
             # All asset types are exported using the "asset" tag - but their asset type is specified in each asset key.
             asset = lxml.etree.SubElement(asset_root, AssetMetadata.ASSET_XML_TAG)
             asset_md.to_xml(asset)
-        with OSFS(asset_dir).open(AssetMetadata.EXPORTED_ASSET_FILENAME, 'wb') as asset_xml_file:
+        with OSFS(asset_dir).open(AssetMetadata.EXPORTED_ASSET_FILENAME, 'w') as asset_xml_file:
             _write_xml(asset_root, asset_xml_file)
 
         # export the static assets
@@ -403,7 +406,7 @@ def post_process(self, root, export_fs):
         called library.xml.
         """
         # Create the Library.xml file, which acts as the index of all library contents.
-        with export_fs.open(LIBRARY_ROOT, 'wb') as xml_file:
+        with export_fs.open(LIBRARY_ROOT, 'w') as xml_file:
             _write_xml(root, xml_file)
 
 

xmodule/xml_block.py

@@ -472,8 +472,9 @@ def add_xml_to_node(self, node):
                 self.location.run if self.category == 'course' else url_path,
             )
             self.runtime.export_fs.makedirs(os.path.dirname(filepath), recreate=True)
-            with self.runtime.export_fs.open(filepath, 'wb') as fileobj:
-                ElementTree(xml_object).write(fileobj, pretty_print=True, encoding='utf-8')
+            with self.runtime.export_fs.open(filepath, 'w') as fileobj:
+                from xmodule.modulestore.xml_exporter import _write_xml
+                _write_xml(xml_object, fileobj)
         else:
             # Write all attributes from xml_object onto node
             node.clear()