From 6255985262bd34e6fdf3195547ae05773d727362 Mon Sep 17 00:00:00 2001
From: Goffi <goffi@goffi.org>
Date: Fri, 28 Oct 2022 18:47:17 +0200
Subject: [PATCH] tools (xml_tools): `domish_elt_2_et_elt` and
 `et_elt_2_domish_elt` now handle lxml.etree

---
 sat/tools/xml_tools.py | 54 +++++++++++++++++++++++++++++-------------
 1 file changed, 37 insertions(+), 17 deletions(-)

diff --git a/sat/tools/xml_tools.py b/sat/tools/xml_tools.py
index 27b79747..06111c8b 100644
--- a/sat/tools/xml_tools.py
+++ b/sat/tools/xml_tools.py
@@ -17,20 +17,23 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-import re
-from typing import Optional, Tuple
-import html.entities
 from collections import OrderedDict
-from xml.dom import minidom, NotFoundErr
-from twisted.words.xish import domish
-from twisted.words.protocols.jabber import jid
-from twisted.internet import defer
-from wokkel import data_form
-from sat.core import exceptions
-from sat.core.i18n import _
-from sat.core.constants import Const as C
-from sat.core.log import getLogger
+import html.entities
+import re
+from typing import Optional, Tuple, Union, Literal, overload
+from xml.dom import NotFoundErr, minidom
 import xml.etree.ElementTree as ET
+from lxml import etree
+
+from twisted.internet import defer
+from twisted.words.protocols.jabber import jid
+from twisted.words.xish import domish
+from wokkel import data_form
+
+from sat.core import exceptions
+from sat.core.constants import Const as C
+from sat.core.i18n import _
+from sat.core.log import getLogger
 
 
 log = getLogger(__name__)
@@ -1980,7 +1983,7 @@ def et_get_namespace_and_name(et_elt: ET.Element) -> Tuple[Optional[str], str]:
     return name[1:end_idx], name[end_idx+1:]
 
 
-def et_elt_2_domish_elt(et_elt: ET.Element) -> domish.Element:
+def et_elt_2_domish_elt(et_elt: Union[ET.Element, etree.Element]) -> domish.Element:
     """Convert ElementTree element to Twisted's domish.Element
 
     Note: this is a naive implementation, adapted to XMPP, and some content are ignored
@@ -1995,18 +1998,35 @@ def et_elt_2_domish_elt(et_elt: ET.Element) -> domish.Element:
     return elt
 
 
-def domish_elt_2_et_elt(elt: domish.Element) -> ET.Element:
+@overload
+def domish_elt_2_et_elt(elt: domish.Element, lxml: Literal[False]) -> ET.Element:
+    ...
+
+@overload
+def domish_elt_2_et_elt(elt: domish.Element, lxml: Literal[True]) -> etree.Element:
+    ...
+
+@overload
+def domish_elt_2_et_elt(
+    elt: domish.Element, lxml: bool
+) -> Union[ET.Element, etree.Element]:
+    ...
+
+def domish_elt_2_et_elt(elt, lxml = False):
     """Convert Twisted's domish.Element to ElementTree equivalent
 
-    Note: this is a naive implementation, adapter to XMPP, and some text content may be
+    Note: this is a naive implementation, adapted to XMPP, and some text content may be
         missing (content put after a tag, i.e. what would go to the "tail" attribute of ET
         Element)
     """
     tag = f"{{{elt.uri}}}{elt.name}" if elt.uri else elt.name
-    et_elt = ET.Element(tag, attrib=elt.attributes)
+    if lxml:
+        et_elt = etree.Element(tag, attr=elt.attributes)
+    else:
+        et_elt = ET.Element(tag, attrib=elt.attributes)
     content = str(elt)
     if content:
         et_elt.text = str(elt)
     for child in elt.elements():
-        et_elt.append(domish_elt_2_et_elt(child))
+        et_elt.append(domish_elt_2_et_elt(child, lxml=lxml))
     return et_elt