2.8.1 - added camel_to_snake function

Author: Someguy123

docs/source/helpers/common/privex.helpers.common.camel_to_snake.rst

@@ -0,0 +1,6 @@
+camel\_to\_snake
+================
+
+.. currentmodule:: privex.helpers.common
+
+.. autofunction:: camel_to_snake

docs/source/helpers/privex.helpers.common.rst

@@ -10,6 +10,7 @@ privex.helpers.common
 
       byteify
       call_sys
+      camel_to_snake
       chunked
       construct_dict
       dec_round

privex/helpers/__init__.py

@@ -136,7 +136,7 @@ def _setup_logging(level=logging.WARNING):
 log = _setup_logging()
 name = 'helpers'
 
-VERSION = '2.8.0'
+VERSION = '2.8.1'
 
 
 

privex/helpers/common.py

@@ -653,6 +653,30 @@ def error(self, message):
         sys.exit(2)
 
 
+first_cap_re = re.compile('(.)([A-Z][a-z]+)')
+all_cap_re = re.compile('([a-z0-9])([A-Z])')
+
+
+def camel_to_snake(name: STRBYTES) -> str:
+    """
+    Convert ``name`` from camel case (``HelloWorld``) to snake case (``hello_world``).
+    
+    ``name`` can be either a ``str`` or ``bytes``.
+    
+    Example::
+    
+        >>> camel_to_snake("HelloWorldLoremIpsum")
+        'hello_world_lorem_ipsum'
+    
+    
+    :param str|bytes name: A camel case (class style) name, e.g. ``HelloWorld``
+    :return str snake_case: ``name`` converted to snake case ``hello_world``
+    """
+
+    s1 = first_cap_re.sub(r'\1_\2', stringify(name))
+    return all_cap_re.sub(r'\1_\2', s1).lower()
+
+
 def human_name(class_name: Union[str, bytes, callable, Type[object]]) -> str:
     """
     This function converts a class/function name into a Title Case name. It also directly accepts classes/functions.