[PATCH] plugin.api.validate: fix xml_element (streamlink#4514)

Billy2011 · Billy2011 · commit 336bd775f2a0 · 2022-05-08T13:30:17.000+02:00
Add missing tail attribute and clone child nodes
diff --git a/src/streamlink/plugin/api/validate.py b/src/streamlink/plugin/api/validate.py
@@ -15,7 +15,7 @@
 
 """
 
-from copy import copy as copy_obj
+from copy import copy, deepcopy
 try:
     from typing import Any, Tuple, Union
 except ImportError:
@@ -116,13 +116,16 @@ def __init__(self, *keys, **kw):
         self.seq = kw.get("seq", tuple)
 
 
-class xml_element(object):
-    """A XML element."""
+class xml_element:
+    """
+    Validate an XML element.
+    """
 
-    def __init__(self, tag=None, text=None, attrib=None):
+    def __init__(self, tag=None, text=None, attrib=None, tail=None):
         self.tag = tag
         self.text = text
         self.attrib = attrib
+        self.tail = tail
 
 
 # ----
@@ -466,6 +469,7 @@ def validate_xml_element(schema, value):
     _tag = value.tag
     _attrib = value.attrib
     _text = value.text
+    _tail = value.tail
 
     if schema.attrib is not None:
         try:
@@ -485,17 +489,24 @@ def validate_xml_element(schema, value):
         except ValueError as err:
             raise ValueError("Unable to validate XML text: {0}".format(err))
 
+    if schema.tail is not None:
+        try:
+            _tail = validate(schema.tail, value.tail)
+        except ValueError as err:
+            raise ValueError("Unable to validate XML text: {0}".format(err))
+
     new = Element(_tag, _attrib)
     new.text = _text
+    new.tail = _tail
     for child in value:
-        new.append(child)
+        new.append(deepcopy(child))
 
     return new
 
 
 @validate.register(attr)
 def validate_attr(schema, value):
-    new = copy_obj(value)
+    new = copy(value)
 
     for attr, schema in schema.schema.items():
         if not _hasattr(value, attr):
diff --git a/tests/test_api_validate.py b/tests/test_api_validate.py
@@ -191,10 +191,14 @@ def test_xml_element(self):
         upper = transform(str.upper)
         newelem = validate(xml_element(tag=upper, text=upper, attrib={upper: upper}), el)
 
+        assert newelem is not el
         assert newelem.tag == "TAG"
         assert newelem.text == "TEST"
         assert newelem.attrib == {"KEY": "VALUE"}
-        assert list(newelem.iterchildren()) == [childA, childB]
+        assert newelem[0].tag == "childA"
+        assert newelem[1].tag == "childB"
+        assert newelem[0] is not childA
+        assert newelem[1] is not childB
 
         with self.assertRaises(ValueError) as cm:
             validate(xml_element(tag="invalid"), el)
