refactor: delegate load_definition_xml to Runtime

Author: ttqureshi

xblock/core.py

@@ -24,7 +24,7 @@
 from xblock.internal import class_lazy
 from xblock.plugin import Plugin
 from xblock.validation import Validation
-from xblock.xml import is_pointer_tag, load_definition_xml
+from xblock.xml import is_pointer_tag
 
 # OrderedDict is used so that namespace attributes are put in predictable order
 # This allows for simple string equality assertions in tests and have no other effects
@@ -749,7 +749,7 @@ def parse_xml(cls, node, runtime, keys):
                 will store its data.
         """
         if is_pointer_tag(node):
-            node, _ = load_definition_xml(node, runtime, keys.def_id)
+            node, _ = runtime.load_definition_xml(node, keys.def_id)
 
         block = runtime.construct_xblock_from_class(cls, keys)
 

xblock/runtime.py

@@ -31,6 +31,7 @@
     FieldDataDeprecationWarning,
     UserIdDeprecationWarning,
 )
+from xblock.xml import format_filepath, load_file, name_to_pathname
 
 log = logging.getLogger(__name__)
 
@@ -792,6 +793,24 @@ def add_block_as_child_node(self, block, node):
         child = etree.SubElement(node, "unknown")
         block.add_xml_to_node(child)
 
+    def load_definition_xml(self, node, def_id):
+        """
+        Load an XML definition for a block. 
+        This method can be overridden in different runtime environments.
+
+        Args:
+            node: XML element containing attributes for definition loading
+            def_id: Unique identifier for the definition being loaded
+
+        Returns:
+            tuple: A tuple containing the loaded XML definition and the
+            corresponding file path or identifier
+        """
+        url_name = node.get('url_name')
+        filepath = format_filepath(node.tag, name_to_pathname(url_name))
+        definition_xml = load_file(filepath, self.resources_fs, def_id) # pylint: disable=no-member
+        return definition_xml, filepath
+
     # Rendering
 
     def render(self, block, view_name, context=None):

xblock/xml.py

@@ -39,26 +39,6 @@ def is_pointer_tag(xml_obj):
     return len(xml_obj) == 0 and actual_attr == expected_attr and not has_text
 
 
-def load_definition_xml(node, runtime, def_id):
-    """
-    Parses and loads an XML definition file based on a given node, runtime
-    environment, and definition ID.
-
-    Arguments:
-    node: XML element containing attributes for definition loading.
-    runtime: The runtime environment that provides resource access.
-    def_id: Unique identifier for the definition being loaded.
-
-    Returns:
-    tuple: A tuple containing the loaded XML definition and the
-    corresponding file path.
-    """
-    url_name = node.get('url_name')
-    filepath = format_filepath(node.tag, name_to_pathname(url_name))
-    definition_xml = load_file(filepath, runtime.resources_fs, def_id)
-    return definition_xml, filepath
-
-
 def format_filepath(category, name):
     """
     Construct a formatted filepath string based on the given category and name.