Accept missing comment line in ADI files (issue #3)

Detailed some type hints, fixed doc

Author: gitandy

src/adif_file/adi.py

@@ -1,3 +1,6 @@
+# PyADIF-File (c) 2023-2025 by Andreas Schawo is licensed under CC BY-SA 4.0.
+# To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/
+
 """Convert ADIF ADI content to dictionary and vice versa"""
 
 import re
@@ -32,7 +35,7 @@ class IllegalDataTypeException(Exception):
 REGEX_PARAM = re.compile(r'[a-zA-Z][a-zA-Z_0-9]*')
 
 
-def unpack(data: str) -> dict:
+def unpack(data: str) -> dict[str, str]:
     """Unpack header or record part to dictionary
     The parameters are converted to uppercase"""
 
@@ -77,7 +80,7 @@ def unpack(data: str) -> dict:
     return unpacked
 
 
-def loadi(adi: str, skip: int = 0) -> Iterator[dict]:
+def loadi(adi: str, skip: int = 0) -> Iterator[dict[str, str]]:
     """Turn ADI formated string to header/records as an iterator over dict
     The skip option is useful if you want to watch a file for new records only. This saves processing time.
 
@@ -86,30 +89,27 @@ def loadi(adi: str, skip: int = 0) -> Iterator[dict]:
     :return: an iterator of records (first record is the header even if not available)
     """
 
-    record_data = adi
-    if not adi.startswith('<'):  # If a header is available
-        hr_list = re.split(r'<[eE][oO][hH]>', adi)
-        if len(hr_list) > 2:
-            raise TooMuchHeadersException()
-
+    hr_list = re.split(r'<[eE][oO][hH]>', adi)
+    if len(hr_list) == 1:  # Header is missing
+        yield {}
+        record_data = hr_list[0]
+    elif len(hr_list) > 2:  # More than one header
+        raise TooMuchHeadersException()
+    else:  # One header and the records
         yield unpack(hr_list[0])
         record_data = hr_list[1]
-    else:  # Empty record for missing header
-        yield {}
 
-    i = 0
-    for rec in re.finditer(r'(.*?)<[eE][oO][rR]>', record_data, re.S):
+    for i, rec in enumerate(re.finditer(r'(.*?)<[eE][oO][rR]>', record_data, re.S)):
         if i >= skip:
             yield unpack(rec.groups()[0])
-        i += 1
 
 
 def loads(adi: str, skip: int = 0) -> dict:
     """Turn ADI formated string to dictionary
     The parameters are converted to uppercase
 
         {
-        'HEADER': None,
+        'HEADER': {},
         'RECORDS': [list of records]
         }
 
@@ -121,7 +121,7 @@ def loads(adi: str, skip: int = 0) -> dict:
     :return: the ADI as a dict
     """
 
-    doc = {'HEADER': None,
+    doc = {'HEADER': {},
            'RECORDS': []
            }
 
@@ -141,7 +141,7 @@ def load(file_name: str, skip: int = 0, encoding=None) -> dict:
        The parameters are converted to uppercase
 
            {
-           'HEADER': None,
+           'HEADER': {},
            'RECORDS': [list of records]
            }
 
@@ -164,7 +164,7 @@ def pack(param: str, value: str, dtype: str = None) -> str:
     """Generates ADI tag if value is not empty
     Does not generate tags for *_INTL types as required by specification.
 
-    :param param: the tag parameter (converte to uppercase)
+    :param param: the tag parameter (converted to uppercase)
     :param value: the tag value (or tag definition if param is a USERDEF field)
     :param dtype: the optional datatype (mainly used for USERDEFx in header)
     :return: <param:length>value
@@ -297,7 +297,6 @@ def dump(file_name: str, data_dict: dict, comment: str = 'ADIF export by ' + __p
                 first = False
             else:
                 af.write('\n\n' if linebreaks else '\n')
-
             af.write(chunk)
 
 

test/test_loadadi.py

@@ -54,6 +54,14 @@ def test_50_goodfile(self):
         self.assertEqual(3, len(adi_dict['HEADER']))
         self.assertEqual(5, len(adi_dict['RECORDS']))
 
+    def test_51_goodfile_missing_comment(self):
+        adi_dict = adif_file.adi.load(get_file_path('testdata/goodfile_missing hcomment.txt'))
+
+        self.assertIn('HEADER', adi_dict)
+        self.assertIn('RECORDS', adi_dict)
+        self.assertEqual(3, len(adi_dict['HEADER']))
+        self.assertEqual(3, len(adi_dict['RECORDS']))
+
     def test_52_no_header(self):
         adi_dict = adif_file.adi.load(get_file_path('testdata/goodfile_no_h.txt'))
 

test/testdata/goodfile_missing hcomment.txt

@@ -0,0 +1,18 @@
+<ADIF_VER:5>3.1.4 <PROGRAMID:8>Testprog <PROGRAMVERSION:4>v0.2
+<eoh>
+
+<QSO_DATE:8>20231008 <TIME_ON:4>1145 <CALL:6>dl4bdf <NAME:6>Walter <QTH:8>Dortmund <GRIDSQUARE:8>Jo30Uj45
+<BAND:3>80M <MODE:2>AM <FREQ:5>4.000
+<STATION_CALLSIGN:6>XX1XXX <MY_GRIDSQUARE:8>JO35uj27 <DISTANCE:1>2
+<NOTES:5>Test1
+<eor>
+
+<QSO_DATE:8>20231008 <TIME_ON:4>1146 <CALL:6>DL5HJK <NAME:5>Peter <QTH:13>Welschneudorf <GRIDSQUARE:8>Jo30uj12
+<RST_SENT:2>59 <RST_RCVD:2>47 <BAND:4>630M <MODE:2>AM <TX_PWR:3>4.0
+<STATION_CALLSIGN:6>XX1XXX <MY_GRIDSQUARE:8>JO35uj27 <DISTANCE:1>2
+<eor>
+
+<QSO_DATE:8>20231008 <TIME_ON:4>1340
+<RST_SENT:2>59 <RST_RCVD:2>59 <BAND:4>630M <MODE:2>AM <FREQ:5>0.472 <TX_PWR:3>4.0
+<MY_GRIDSQUARE:8>JO35uj27
+<eor>