Changed names to dump and load

Author: gitandy

src/adif_file/__init__.py

@@ -82,14 +82,17 @@ def unpack(data: str) -> dict:
     return unpacked
 
 
-def adi2dict(adi: str) -> dict:
+def loads_adi(adi: str) -> dict:
     """Turn ADI formated string to dictionary
     The parameters are converted to uppercase
 
         {
         'HEADER': None,
         'RECORDS': [list of records]
         }
+
+    :param adi: the ADI data
+    :return: the ADI as a dict
     """
 
     doc = {'HEADER': None,
@@ -140,7 +143,7 @@ def pack(param: str, value: str, dtype: str = None) -> str:
         return ''
 
 
-def dict2adi(data_dict: dict, comment: str = 'ADIF export by ' + __proj_name__) -> str:
+def dumps_adi(data_dict: dict, comment: str = 'ADIF export by ' + __proj_name__) -> str:
     """Takes a dictionary and converts it to ADI format
     Parameters can be in upper or lower case. The output is upper case. The user must take care
     that parameters are not doubled!

test/test_dumpadi.py

@@ -47,7 +47,7 @@ def test_20_dump_header(self):
 <CREATED_TIMESTAMP:4>1234
 <EOH>'''
 
-        self.assertEqual(exp_hdr, dict2adi(adi_dict))
+        self.assertEqual(exp_hdr, dumps_adi(adi_dict))
 
         # Test same with udef
         adi_udef = [{'dtype': 'E',
@@ -65,7 +65,7 @@ def test_20_dump_header(self):
 <EOH>'''
 
         adi_dict['HEADER']['USERDEFS'] = adi_udef
-        self.assertEqual(exp_hdr_udef, dict2adi(adi_dict))
+        self.assertEqual(exp_hdr_udef, dumps_adi(adi_dict))
 
     def test_25_dump_records(self):
         adi_dict = {
@@ -80,7 +80,7 @@ def test_25_dump_records(self):
 <TEST1:5>test3 <TEST2:5>test4 
 <EOR>'''
 
-        self.assertEqual(adi_exp, dict2adi(adi_dict))
+        self.assertEqual(adi_exp, dumps_adi(adi_dict))
 
 
 if __name__ == '__main__':

test/test_loadadi.py

@@ -50,7 +50,7 @@ def test_50_goodfile(self):
         with open(get_file_path('testdata/goodfile.txt'), encoding='ascii') as tf:
             adi_txt = tf.read()
 
-        adi_dict = adi2dict(adi_txt)
+        adi_dict = loads_adi(adi_txt)
 
         self.assertIn('HEADER', adi_dict)
         self.assertIn('RECORDS', adi_dict)
@@ -61,7 +61,7 @@ def test_55_toomuchheaders(self):
         with open(get_file_path('testdata/toomuchheadersfile.txt'), encoding='ascii') as tf:
             adi_txt = tf.read()
 
-        self.assertRaises(TooMuchHeadersException, adi2dict, adi_txt)
+        self.assertRaises(TooMuchHeadersException, loads_adi, adi_txt)
 
 
 if __name__ == '__main__':