refactor to use pathlib.Path(), add to UnicodeDecodeError

Author: lukaspie

dev_tools/tests/test_nxdl_utils.py

@@ -2,8 +2,7 @@
 
 """
 
-import os
-
+from pathlib import Path
 import lxml.etree as ET
 import pytest
 
@@ -33,8 +32,8 @@ def test_get_nexus_classes_units_attributes():
 
 def test_get_node_at_nxdl_path():
     """Test to verify if we receive the right XML element for a given NXDL path"""
-    local_dir = os.path.abspath(os.path.dirname(__file__))
-    nxdl_file_path = os.path.join(local_dir, "./NXtest.nxdl.xml")
+    local_dir = Path(__file__).resolve().parent
+    nxdl_file_path = local_dir / "NXtest.nxdl.xml"
     elem = ET.parse(nxdl_file_path).getroot()
     node = nexus.get_node_at_nxdl_path("/ENTRY/NXODD_name", elem=elem)
     assert node.attrib["type"] == "NXdata"
@@ -49,9 +48,7 @@ def test_get_node_at_nxdl_path():
     )
     assert node.attrib["name"] == "long_name"
 
-    nxdl_file_path = os.path.join(
-        local_dir, "../../contributed_definitions/NXiv_temp.nxdl.xml"
-    )
+    nxdl_file_path = local_dir.parent.parent / "contributed_definitions" / "NXiv_temp.nxdl.xml"
     elem = ET.parse(nxdl_file_path).getroot()
     node = nexus.get_node_at_nxdl_path(
         "/ENTRY/INSTRUMENT/ENVIRONMENT/voltage_controller", elem=elem
@@ -66,16 +63,14 @@ def test_get_node_at_nxdl_path():
 
 def test_get_inherited_nodes():
     """Test to verify if we receive the right XML element list for a given NXDL path."""
-    local_dir = os.path.abspath(os.path.dirname(__file__))
+    local_dir = Path(__file__).resolve().parent
+    nxdl_file_path = local_dir / "NXtest.nxdl.xml"
 
-    nxdl_file_path = os.path.join(local_dir, "./NXtest.nxdl.xml")
     elem = ET.parse(nxdl_file_path).getroot()
     (_, _, elist) = nexus.get_inherited_nodes(nxdl_path="/ENTRY/NXODD_name", elem=elem)
     assert len(elist) == 3
 
-    nxdl_file_path = os.path.join(
-        local_dir, "../../contributed_definitions/NXiv_temp.nxdl.xml"
-    )
+    nxdl_file_path = local_dir.parent.parent / "contributed_definitions" / "NXiv_temp.nxdl.xml"
 
     elem = ET.parse(nxdl_file_path).getroot()
     (_, _, elist) = nexus.get_inherited_nodes(

dev_tools/utils/nxdl_utils.py

@@ -29,7 +29,7 @@ def decode_or_not(elem, encoding: str = "utf-8", decode: bool = True):
         If `decode` is False, always returns the initial value.
 
     Raises:
-        ValueError: If a byte string cannot be decoded using the provided encoding.
+        UnicodeDecodeError: If a byte string cannot be decoded using the provided encoding.
     """
     if not decode:
         return elem
@@ -46,7 +46,8 @@ def decode_or_not(elem, encoding: str = "utf-8", decode: bool = True):
         try:
             return elem.decode(encoding)
         except UnicodeDecodeError as e:
-            raise UnicodeDecodeError(f"Error decoding bytes: {e}")
+            e.add_note(f'Error decoding bytes object: {elem}')
+            raise
 
     return elem