Merge pull request #37 from statisticsnorway/xml_funk

Xml funk

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-konjunk"
-version = "0.0.6"
+version = "0.0.7"
 description = "SSB Konjunk"
 authors = ["Edvard Garmannslund <[email protected]>"]
 license = "MIT"

src/ssb_konjunk/xml_handling.py

@@ -0,0 +1,58 @@
+"""A collection of functions to make xml files handling easier both in dapla and prodsone."""
+
+import xml.etree.ElementTree as ET
+
+import dapla
+
+
+def read_xml(xml_file: str, fs: dapla.gcs.GCSFileSystem = None) -> ET.Element:
+    """Funtion to get xml root from disk.
+
+    Args:
+        xml_file: Strin value for xml filepath.
+        fs: filesystem
+
+    Returns:
+        ET.Element: Root of xml file.
+    """
+    if fs:
+        with fs.open(xml_file, mode="r") as file:
+            single_xml = file.read()
+            file.close()
+    else:
+        with open(xml_file) as file:
+            single_xml = file.read()
+            file.close()
+
+    return ET.fromstring(single_xml)
+
+
+def return_txt_xml(root: ET.Element, child: str) -> str | None:
+    """Function to return text value from child element in xml file.
+
+    Args:
+        root: Root with all data stored in a branch like structure.
+        child: String value to find child element which contains a value.
+
+    Returns:
+        str: Returns string value from child element.
+    """
+    for element in root.iter(child):
+        string = element.text
+    return string
+
+
+def dump_element(element: ET.Element, indent: int = 0) -> None:
+    """Function to print xml in pretty format.
+
+    Args:
+        element: ET.Element you want to print.
+        indent: Level of ident you want.
+    """
+    print("  " * indent + f"Tag: {element.tag}")
+    if element.text and element.text.strip():
+        print("  " * (indent + 1) + f"Text: {element.text.strip()}")
+    for attribute, value in element.attrib.items():
+        print("  " * (indent + 1) + f"Attribute: {attribute}={value}")
+    for child in element:
+        dump_element(child, indent + 1)