encommon 0.20.4__tar.gz → 0.21.0__tar.gz

{encommon-0.20.4/encommon.egg-info → encommon-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: encommon
-Version: 0.20.4
+Version: 0.21.0
 Summary: Enasis Network Common Library
 License: MIT
 Project-URL: Source, https://github.com/enasisnetwork/encommon
@@ -30,6 +30,7 @@ Common classes and functions used in various public and private projects.
 <a href="https://pypi.org/project/encommon"><img src="https://enasisnetwork.github.io/encommon/badges/pypi.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/flake8.txt"><img src="https://enasisnetwork.github.io/encommon/badges/flake8.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/pylint.txt"><img src="https://enasisnetwork.github.io/encommon/badges/pylint.png"></a><br>
+<a href="https://enasisnetwork.github.io/encommon/validate/ruff.txt"><img src="https://enasisnetwork.github.io/encommon/badges/ruff.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/mypy.txt"><img src="https://enasisnetwork.github.io/encommon/badges/mypy.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/yamllint.txt"><img src="https://enasisnetwork.github.io/encommon/badges/yamllint.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/pytest.txt"><img src="https://enasisnetwork.github.io/encommon/badges/pytest.png"></a><br>

{encommon-0.20.4 → encommon-0.21.0}/README.md

@@ -7,6 +7,7 @@ Common classes and functions used in various public and private projects.
 <a href="https://pypi.org/project/encommon"><img src="https://enasisnetwork.github.io/encommon/badges/pypi.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/flake8.txt"><img src="https://enasisnetwork.github.io/encommon/badges/flake8.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/pylint.txt"><img src="https://enasisnetwork.github.io/encommon/badges/pylint.png"></a><br>
+<a href="https://enasisnetwork.github.io/encommon/validate/ruff.txt"><img src="https://enasisnetwork.github.io/encommon/badges/ruff.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/mypy.txt"><img src="https://enasisnetwork.github.io/encommon/badges/mypy.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/yamllint.txt"><img src="https://enasisnetwork.github.io/encommon/badges/yamllint.png"></a><br>
 <a href="https://enasisnetwork.github.io/encommon/validate/pytest.txt"><img src="https://enasisnetwork.github.io/encommon/badges/pytest.png"></a><br>

{encommon-0.20.4 → encommon-0.21.0}/encommon/colors/color.py

@@ -192,7 +192,8 @@ class Color:
             if isinstance(other, str):
                 other = Color(other)
 
-            assert hasattr(other, 'source')
+            assert hasattr(
+                other, 'source')
 
             source = self.__source
             _source = other.source
@@ -237,7 +238,8 @@ class Color:
             if isinstance(other, str):
                 other = Color(other)
 
-            assert hasattr(other, 'source')
+            assert hasattr(
+                other, 'source')
 
             source = self.__source
             _source = other.source
@@ -268,7 +270,8 @@ class Color:
             if isinstance(other, str):
                 other = Color(other)
 
-            assert hasattr(other, 'source')
+            assert hasattr(
+                other, 'source')
 
             source = self.__source
             _source = other.source
@@ -299,7 +302,8 @@ class Color:
             if isinstance(other, str):
                 other = Color(other)
 
-            assert hasattr(other, 'source')
+            assert hasattr(
+                other, 'source')
 
             source = self.__source
             _source = other.source
@@ -330,7 +334,8 @@ class Color:
             if isinstance(other, str):
                 other = Color(other)
 
-            assert hasattr(other, 'source')
+            assert hasattr(
+                other, 'source')
 
             source = self.__source
             _source = other.source

{encommon-0.20.4 → encommon-0.21.0}/encommon/colors/test/test_color.py

@@ -45,7 +45,7 @@ def test_Color() -> None:
 
     assert color == '000001'
     assert color != '000000'
-    assert color != int
+    assert color != int  # noqa
 
     assert color > 0
     assert color >= 1

{encommon-0.20.4 → encommon-0.21.0}/encommon/types/__init__.py

@@ -17,7 +17,9 @@ from .lists import dedup_list
 from .lists import fuzzy_list
 from .lists import inlist
 from .notate import delate
+from .notate import expate
 from .notate import getate
+from .notate import impate
 from .notate import setate
 from .strings import hasstr
 from .strings import inrepr
@@ -39,8 +41,10 @@ __all__ = [
     'delate',
     'DictStrAny',
     'Empty',
+    'expate',
     'getate',
     'hasstr',
+    'impate',
     'inlist',
     'inrepr',
     'instr',

{encommon-0.20.4 → encommon-0.21.0}/encommon/types/notate.py

@@ -193,6 +193,185 @@ def delate(
 
 
 
+def impate(  # noqa: CFQ001,CFQ004
+    source: DictStrAny | list[DictStrAny],
+    delim: str = '/',
+    parent: Optional[str] = None,
+    *,
+    implode_list: bool = True,
+    recurse_list: bool = True,
+) -> DictStrAny | list[DictStrAny]:
+    """
+    Implode the dictionary into a single depth of notation.
+
+    Example
+    -------
+    >>> impate({'foo': {'bar': 'baz'}})
+    {'foo/bar': 'baz'}
+
+    :param source: Dictionary object processed in notation.
+    :param delim: Override default delimiter between parts.
+    :param parent: Parent key prefix for downstream update.
+    :param implode_list: Determine whether list is imploded.
+    :param recurse_list: Determine whether flatten in list.
+    :returns: New dictionary that was recursively imploded.
+        It is also possible that a list of dictionary will
+        be returned when provided and implode_list is False.
+    """
+
+    _implode = implode_list
+    _recurse = recurse_list
+
+
+    def _proclist(
+        source: list[Any],
+        delim: str,
+        parent: Optional[str],
+    ) -> DictStrAny | list[Any]:
+
+
+        if _implode is False:
+
+            process = [
+                (impate(
+                    item, delim,
+                    implode_list=_implode,
+                    recurse_list=_recurse)
+                 if isinstance(item, dict | list)
+                 and _recurse is True
+                 else item)
+                for item in source]
+
+            return (
+                {parent: process}
+                if parent is not None
+                else process)
+
+
+        returned: DictStrAny = {}
+
+        for i, item in enumerate(source):
+
+            key = (
+                f'{parent}{delim}{i}'
+                if parent is not None
+                else str(i))
+
+            if (isinstance(item, dict | list)
+                    and _recurse is True):
+
+                implode = impate(
+                    item, delim, key,
+                    implode_list=_implode,
+                    recurse_list=_recurse)
+
+                assert isinstance(implode, dict)
+
+                returned.update(implode)
+
+            else:
+                returned[key] = item
+
+        return returned
+
+
+    def _procdict(
+        source: DictStrAny,
+        delim: str,
+        parent: Optional[str],
+    ) -> DictStrAny:
+
+        returned: DictStrAny = {}
+
+        for key, value in source.items():
+
+            key = (
+                f'{parent}{delim}{key}'
+                if parent is not None
+                else key)
+
+            if isinstance(value, dict):
+
+                implode = impate(
+                    value, delim, key,
+                    implode_list=_implode,
+                    recurse_list=_recurse)
+
+                assert isinstance(implode, dict)
+
+                returned |= implode
+
+            elif isinstance(value, list):
+
+                process = _proclist(
+                    value, delim, key)
+
+                returned |= (
+                    {key: process}
+                    if not isinstance(process, dict)
+                    else process)
+
+            else:
+                returned[key] = value
+
+        return returned
+
+
+    if isinstance(source, dict):
+        return _procdict(
+            source, delim, parent)
+
+    if isinstance(source, list):
+        return _proclist(
+            source, delim, parent)
+
+    raise ValueError('source')
+
+
+
+def expate(
+    source: DictStrAny,
+    delim: str = '/',
+) -> DictStrAny:
+    """
+    Explode the dictionary from a single depth of notation.
+
+    Example
+    -------
+    >>> expate({'foo/bar': 'baz'})
+    {'foo': {'bar': 'baz'}}
+
+    :param source: Dictionary object processed in notation.
+    :param delim: Override default delimiter between parts.
+    :returns: New dictionary that was recursively exploded.
+    """
+
+    returned: DictStrAny = {}
+
+
+    items = source.items()
+
+    for key, value in items:
+
+        if isinstance(value, list):
+            value = [
+                (expate(x, delim)
+                 if isinstance(x, dict)
+                 else x)
+                for x in value]
+
+        if isinstance(value, dict):
+            value = expate(value, delim)
+
+        setate(
+            returned, key,
+            value, delim)
+
+
+    return returned
+
+
+
 def _setpath(
     source: _SETABLE,
     path: str,

{encommon-0.20.4 → encommon-0.21.0}/encommon/types/test/__init__.py

@@ -8,6 +8,13 @@ is permitted, for more information consult the project license file.
 
 
 from copy import deepcopy
+from pathlib import Path
+
+
+
+SAMPLES = (
+    Path(__file__).parent
+    / 'samples')
 
 
 

{encommon-0.20.4 → encommon-0.21.0}/encommon/types/test/test_dicts.py

@@ -140,6 +140,7 @@ def test_merge_dicts() -> None:  # noqa: CFQ001
     assert source is not _source
 
 
+
 def test_sort_dict() -> None:
     """
     Perform various tests associated with relevant routines.