v1.0.2 - change keyval/csv_env and _parse to parse_csv/keyval and env_csv/keyval

Author: Someguy123

privex/helpers/common.py

@@ -164,7 +164,7 @@ def is_false(v, chk_none: bool = True) -> bool:
     chk += [None, 'none', 'null', ''] if chk_none else []
     return v in chk
 
-def keyval_parse(line: str) -> List[Tuple[str, str]]:
+def parse_keyval(line: str) -> List[Tuple[str, str]]:
     """
     Parses a csv with key:value pairs such as:
 
@@ -183,47 +183,47 @@ def keyval_parse(line: str) -> List[Tuple[str, str]]:
     line = [tuple(a.split(':')) for a in line.split(',')] if line != '' else []
     return [(a.strip(), b.strip()) for a, b in line]
 
-def keyval_env(env_key: str, env_default = None) -> List[Tuple[str, str]]:
+def env_keyval(env_key: str, env_default = None) -> List[Tuple[str, str]]:
     """
     Parses "key:val,key:val" into a list of tuples [(key,val), (key,val)]
     
-    See :py:meth:`keyval_parse`
+    See :py:meth:`parse_keyval`
     """
     d = env(env_key)
-    return env_default if empty(d) else keyval_parse(d)
+    return env_default if empty(d) else parse_keyval(d)
 
-def csv_parse(line: str) -> List[str]:
+def parse_csv(line: str) -> List[str]:
     """
     Quick n' dirty parsing of a simple comma separated line, with automatic whitespace stripping
     of both the ``line`` itself, and the values within the commas.
 
     Example:
     
-        >>> csv_parse('  hello ,  world, test')
+        >>> parse_csv('  hello ,  world, test')
         ['hello', 'world', 'test']
     
     """
     return [x.strip() for x in line.strip().split(',')]
 
-def csv_env(env_key: str, env_default = None) -> List[str]:
+def env_csv(env_key: str, env_default = None) -> List[str]:
     """
     Quick n' dirty parsing of simple CSV formatted environment variables, with fallback
     to user specified ``env_default`` (defaults to None)
 
     Example:
 
         >>> os.setenv('EXAMPLE', '  hello ,  world, test')
-        >>> csv_env('EXAMPLE', [])
+        >>> env_csv('EXAMPLE', [])
         ['hello', 'world', 'test']
-        >>> csv_env('NONEXISTANT', [])
+        >>> env_csv('NONEXISTANT', [])
         []
     
     :param str env_key:     Environment var to attempt to load
     :param any env_default: Fallback value if the env var is empty / not set
     :return List[str] parsed_data: A list of str values parsed from the env var
     """
     d = env(env_key)
-    return env_default if empty(d) else csv_parse(d)
+    return env_default if empty(d) else parse_csv(d)
 
 
 class ErrHelpParser(argparse.ArgumentParser):

setup.py

@@ -42,7 +42,7 @@
 setup(
     name='privex_helpers',
 
-    version='1.0.1',
+    version='1.0.2',
 
     description='A variety of helper functions and classes, useful for many different projects',
     long_description=long_description,

tests.py

@@ -7,35 +7,35 @@
 
 
 class TestParseHelpers(unittest.TestCase):
-    """Test the parsing functions csv_parse and keyval_parse"""
+    """Test the parsing functions parse_csv and parse_keyval"""
 
     def test_csv_spaced(self):
         """Test csv parsing with excess outer whitespace, and value whitespace"""
-        c = helpers.csv_parse('  valid  , spaced out,   csv  ')
+        c = helpers.parse_csv('  valid  , spaced out,   csv  ')
         self.assertListEqual(c, ['valid', 'spaced out', 'csv'])
 
     def test_csv_single(self):
         """Test that a single value still returns a list"""
-        self.assertListEqual(helpers.csv_parse('single'), ['single'])
+        self.assertListEqual(helpers.parse_csv('single'), ['single'])
 
     def test_kval_clean(self):
         """Test that a clean key:val csv is parsed correctly"""
         self.assertListEqual(
-            helpers.keyval_parse('John:Doe,Jane:Smith'), 
+            helpers.parse_keyval('John:Doe,Jane:Smith'), 
             [('John', 'Doe'), ('Jane', 'Smith')]
         )
 
     def test_kval_spaced(self):
         """Test key:val csv parsing with excess outer whitespace, and value whitespace"""
         self.assertListEqual(
-            helpers.keyval_parse(' John  : Doe  , Jane :  Smith '), 
+            helpers.parse_keyval(' John  : Doe  , Jane :  Smith '), 
             [('John', 'Doe'), ('Jane', 'Smith')]
         )
 
     def test_kval_single(self):
         """Test that a single value still returns a list"""
         self.assertListEqual(
-            helpers.keyval_parse('John:Doe'), 
+            helpers.parse_keyval('John:Doe'), 
             [('John', 'Doe')]
         )