Merge remote-tracking branch 'origin/devel_xmlschemaLibary' into devel_xmlschemaLibary

src/dccXMLJSONConv/dccConv.py

 import os
-from xml.etree.ElementTree import ElementTree
 import xmlschema
 from jinja2 import Environment, PackageLoader, select_autoescape
 import lxml.etree as ElementTree
@@ -109,7 +108,7 @@ class XMLSchemaConverter:
             converted_data = get_from_dict(conversion_result[0], template_info['json_path'])
             return converted_data, conversion_result[1]
 
-    def convert_json_to_xml(self, input_data) -> tuple[str, ElementTree, list[Exception]]:
+    def convert_json_to_xml(self, input_data) -> tuple[str, ElementTree.ElementTree, list[Exception]]:
         """Serialize data back into XML format
 
         Args:
@@ -182,25 +181,65 @@ class XMLSchemaConverter:
     
 converter=XMLSchemaConverter()
 
-def XMLToJson(xml):
+def XMLToJson(xml) -> str:
+    """Deserialize XML to JSON
+
+    Args:
+        xml: xml data to parse. Can be an XMLResource instance, a file-like object a path to a file or a URI of a resource or an Element instance or an ElementTree instance or a string containing the XML data.
+
+    Returns:
+        str: JSON-String
+    """
     dict, errors=converter.convert_xml_to_json(xml)
     return json.dumps(dict)
 
-def XMLToDict(xml):
+def XMLToDict(xml) -> tuple[dict, list[Exception]]:
+    """Deserialize XML to dict
+
+    Args:
+        xml: xml data to parse. Can be an XMLResource instance, a file-like object a path to a file or a URI of a resource or an Element instance or an ElementTree instance or a string containing the XML data.
+
+    Returns:
+        tuple[dict, list[Exception]]: data as dict; list of exceptions that occurred during parsing
+    """
     dict, errors=converter.convert_xml_to_json(xml)
     return dict, errors
 
 
-def JSONToXML(jsonData):
+def JSONToXML(jsonData: str) -> str:
+    """Serialize data from JSON format to XML
+
+    Args:
+        jsonData (str): the data that has to be encoded to XML
+
+    Returns:
+        str: XML string
+    """
     xml_str, converted_element, errors=converter.convert_json_to_xml(json.loads(jsonData))
     return xml_str
 
-def DictToXML(dataDict):
+def DictToXML(dataDict: dict) -> tuple[str, ElementTree.ElementTree, list[Exception]]:
+    """Serialize data from dict to XML
+
+    Args:
+        dataDict (dict): data to be serialized
+
+    Returns:
+        tuple[str, ElementTree.ElementTree, list[Exception]]: string containing the XML; ElementTree representation of the XML; and list of exceptions that occurred during serialization 
+    """
     xml_str, converted_element, errors=converter.convert_json_to_xml(dataDict)
     return xml_str,converted_element, errors
 
 
-def beautify_xml(text):
+def beautify_xml(text: str) -> str:
+    """Beautify XML string
+
+    Args:
+        text (str): ugly XML string
+
+    Returns:
+        str: pretty XML string
+    """
     parser = ElementTree.XMLParser(remove_blank_text=True, ns_clean=True)
     test = text.replace("\\\"", "\"")
     # print(test)
@@ -208,5 +247,5 @@ def beautify_xml(text):
         tree = ElementTree.fromstring(test, parser=parser)
         ret = ElementTree.tostring(tree, pretty_print=True, encoding="unicode")
     except:
-        ret = "<ERROR>dcc_stuff:beautyfy_xml failed </ERROR>"
+        ret = "<ERROR>dcc_stuff:beautify_xml failed </ERROR>"
     return ret
\ No newline at end of file