Better exception text on ADX validation and option to return list instead of raise exception

Author: gitandy

src/adif_file/adx.py

@@ -81,13 +81,15 @@ def load(file_name: str, validate: bool = False) -> dict:
     return loads(adx_data, validate)
 
 
-def dump(file_name: str, data_dict: dict):
+def dump(file_name: str, data_dict: dict, raise_exc=True) -> list[Exception]:
     """Takes a dictionary and stores it to ADX xml file
        If 'HEADER' is missing the header fields are filled with defaults.
        The XML is validated against the strict XSD
 
        :param file_name: the filename to store the ADX data to
        :param data_dict: the dictionary with header and records
+       :param raise_exc: if the validation exceptions are to be raised immediately
+       :return: list of validation exception (if not raised immediately)
        """
 
     data_dict = data_dict.copy()
@@ -112,13 +114,23 @@ def dump(file_name: str, data_dict: dict):
     rec = data_dict.pop('RECORDS')
     data_dict['RECORDS'] = {'RECORD': rec}
 
-    try:
-        et = ADX_EXPORT_SCHEMA.encode(data_dict)
-        ElementTree(et).write(file_name, xml_declaration=True, encoding='utf-8')
-    except xmlschema.validators.exceptions.XMLSchemaChildrenValidationError as exc:
-        raise UndefinedElementException(f'in {exc.elem.tag}') from None
-    except xmlschema.validators.exceptions.XMLSchemaValidationError as exc:
-        raise MalformedValueException(f'Field "{exc.elem.tag}": {exc.reason}') from None
+    exc = []
+
+    et, errors = ADX_EXPORT_SCHEMA.encode(data_dict, validation='lax')
+    for err in errors:
+        if type(err) is xmlschema.validators.exceptions.XMLSchemaValidationError:
+            if err.elem.tag == 'RECORD':
+                exc.append(UndefinedElementException(f'{err.path}: {err.reason}'))
+            elif err.elem.tag == 'HEADER':
+                exc.append(UndefinedElementException(f'{err.path}: {err.reason}'))
+            else:
+                exc.append(MalformedValueException(f'{err.path}: value "{err.obj}" {err.reason}'))
+
+    if raise_exc and exc:
+        raise exc[0]
+
+    ElementTree(et).write(file_name, xml_declaration=True, encoding='utf-8')
+    return exc
 
 
 __all__ = ['load', 'loads', 'dump', 'MissingRecordsException', 'UndefinedElementException',

test/test_dumpadx.py

@@ -1,4 +1,5 @@
 import os
+import copy
 import unittest
 
 import adif_file.adx
@@ -19,21 +20,49 @@ def test_10_dump_exceptions(self):
 
         self.assertRaises(adif_file.adx.MissingRecordsException, adif_file.adx.dump, '', {})
 
-        adx_dict2 = adx_dict.copy()
+        adx_dict2 = copy.deepcopy(adx_dict)
         adx_dict2['RECORDS'][0]['MY_QTH'] = 'Test'  # MY_QTH is not allowed (MY_CITY)
         self.assertRaises(adif_file.adx.UndefinedElementException, adif_file.adx.dump, '', adx_dict2)
 
-        adx_dict2 = adx_dict.copy()
-        adx_dict2['RECORDS'][0]['MY_CITY'] = 123
+        adx_dict2 = copy.deepcopy(adx_dict)
+        adx_dict2['RECORDS'][0]['QTH'] = 'Töst'  # QTH only allows ASCII chars < 127
         self.assertRaises(adif_file.adx.MalformedValueException, adif_file.adx.dump, '', adx_dict2)
 
-        adx_dict2 = adx_dict.copy()
-        adx_dict2['RECORDS'][0]['QTH'] = 'Töst'  # QTH ony alows ASCII chars < 127
+        adx_dict2 = copy.deepcopy(adx_dict)
+        adx_dict2['RECORDS'][0]['FREQ'] = 'Test'
         self.assertRaises(adif_file.adx.MalformedValueException, adif_file.adx.dump, '', adx_dict2)
 
-        adx_dict2 = adx_dict.copy()
+    def test_15_dump_retexc(self):
+        adx_dict = {
+            'RECORDS': [{'CALL': 'XX1XXX',
+                         'QSO_DATE': '20231204',
+                         'TIME_ON': '1100',
+                         'QTH': 'Test'}]
+        }
+
+        # Still raises non validation exceptions?
+        self.assertRaises(adif_file.adx.MissingRecordsException, adif_file.adx.dump, '', {}, raise_exc=False)
+
+        temp_file = get_file_path('testdata/~test.adx')
+
+        self.assertListEqual([], adif_file.adx.dump(temp_file, adx_dict, raise_exc=False))
+
+        adx_dict2 = copy.deepcopy(adx_dict)
+        adx_dict2['RECORDS'][0]['MY_QTH'] = 'Test'  # MY_QTH is not allowed (MY_CITY)
+        self.assertEqual(adif_file.adx.UndefinedElementException,
+                         type(adif_file.adx.dump(temp_file, adx_dict2, raise_exc=False)[0]))
+
+        adx_dict2 = copy.deepcopy(adx_dict)
+        adx_dict2['RECORDS'][0]['QTH'] = 'Töst'  # QTH only allows ASCII chars < 127
+        self.assertEqual(adif_file.adx.MalformedValueException,
+                         type(adif_file.adx.dump(temp_file, adx_dict2, raise_exc=False)[0]))
+
+        adx_dict2 = copy.deepcopy(adx_dict)
         adx_dict2['RECORDS'][0]['FREQ'] = 'Test'
-        self.assertRaises(adif_file.adx.MalformedValueException, adif_file.adx.dump, '', adx_dict2)
+        self.assertEqual(adif_file.adx.MalformedValueException,
+                         type(adif_file.adx.dump(temp_file, adx_dict2, raise_exc=False)[0]))
+
+        os.remove(temp_file)
 
     def test_20_dump(self):
         adx_dict = {