encommon 0.20.5__py3-none-any.whl → 0.21.0__py3-none-any.whl

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/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/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/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.

encommon/types/test/test_notate.py

@@ -8,15 +8,132 @@ is permitted, for more information consult the project license file.
 
 
 from copy import deepcopy
+from pathlib import Path
 
 from _pytest.python_api import RaisesContext
 
+from pytest import fixture
 from pytest import raises
 
+from . import SAMPLES
 from . import _DICT1R
 from ..notate import delate
+from ..notate import expate
 from ..notate import getate
+from ..notate import impate
 from ..notate import setate
+from ..types import DictStrAny
+from ...utils import load_sample
+from ...utils import prep_sample
+from ...utils.sample import ENPYRWS
+
+
+
+_SAMPLE = dict[str, DictStrAny]
+
+
+
+@fixture
+def sample_impate() -> _SAMPLE:
+    """
+    Construct the dictionary for use with downstream tests.
+
+    :returns: Newly constructed dictionary for use in tests.
+    """
+
+    recurse_implode = (
+        impate(
+            deepcopy(_DICT1R),
+            recurse_list=True,
+            implode_list=True))
+
+    assert isinstance(
+        recurse_implode, dict)
+
+    nocurse_noplode = (
+        impate(
+            deepcopy(_DICT1R),
+            recurse_list=False,
+            implode_list=False))
+
+    assert isinstance(
+        nocurse_noplode, dict)
+
+    recurse_noplode = (
+        impate(
+            deepcopy(_DICT1R),
+            recurse_list=True,
+            implode_list=False))
+
+    assert isinstance(
+        recurse_noplode, dict)
+
+    nocurse_implode = (
+        impate(
+            deepcopy(_DICT1R),
+            recurse_list=False,
+            implode_list=True))
+
+    assert isinstance(
+        nocurse_implode, dict)
+
+
+    return {
+        'recurse_implode': recurse_implode,
+        'nocurse_noplode': nocurse_noplode,
+        'recurse_noplode': recurse_noplode,
+        'nocurse_implode': nocurse_implode}
+
+
+
+@fixture
+def sample_expate(
+    sample_impate: _SAMPLE,
+) -> _SAMPLE:
+    """
+    Construct the dictionary for use with downstream tests.
+
+    :param sample_impate: Source dictionary for use in test.
+    :returns: Newly constructed dictionary for use in tests.
+    """
+
+    recurse_implode = (
+        sample_impate[
+            'recurse_implode'])
+
+    assert isinstance(
+        recurse_implode, dict)
+
+    nocurse_noplode = (
+        sample_impate[
+            'nocurse_noplode'])
+
+    assert isinstance(
+        nocurse_noplode, dict)
+
+    recurse_noplode = (
+        sample_impate[
+            'recurse_noplode'])
+
+    assert isinstance(
+        recurse_noplode, dict)
+
+    nocurse_implode = (
+        sample_impate[
+            'nocurse_implode'])
+
+    assert isinstance(
+        nocurse_implode, dict)
+
+    return {
+        'recurse_implode': (
+            expate(recurse_implode)),
+        'nocurse_noplode': (
+            expate(nocurse_noplode)),
+        'recurse_noplode': (
+            expate(recurse_noplode)),
+        'nocurse_implode': (
+            expate(nocurse_implode))}
 
 
 
@@ -215,3 +332,147 @@ def test_delate_raises() -> None:
     _reason = str(reason.value)
 
     assert _reason == 'source'
+
+
+
+def test_impate(
+    tmp_path: Path,
+    sample_impate: _SAMPLE,
+    sample_expate: _SAMPLE,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param sample_impate: Source dictionary for use in test.
+    :param sample_expate: Source dictionary for use in test.
+    :param tmp_path: pytest object for temporal filesystem.
+    """
+
+    sample_path = (
+        SAMPLES / 'impate.json')
+
+    sample = load_sample(
+        path=sample_path,
+        update=ENPYRWS,
+        content=sample_impate)
+
+    expect = prep_sample(
+        content=sample_impate)
+
+    assert expect == sample
+
+
+
+def test_impate_cover(
+    tmp_path: Path,
+    sample_impate: _SAMPLE,
+    sample_expate: _SAMPLE,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param sample_impate: Source dictionary for use in test.
+    :param sample_expate: Source dictionary for use in test.
+    :param tmp_path: pytest object for temporal filesystem.
+    """
+
+
+    default = sample_impate[
+        'recurse_implode']
+
+    assert default == impate(default)
+
+
+    sample = 'recurse_noplode'
+
+    implode = impate(
+        [sample_expate[sample],
+         sample_expate[sample]],
+        implode_list=False,
+        recurse_list=True)
+
+    assert isinstance(implode, list)
+
+    assert implode[0] == (
+        sample_impate[sample])
+
+
+    source = {'foo': {'bar': 'baz'}}
+    expect = {'foo/bar': 'baz'}
+
+    assert impate(source) == expect
+
+
+
+def test_impate_raises() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    _raises: RaisesContext[ValueError]
+
+
+    _raises = raises(ValueError)
+
+    with _raises as reason:
+        impate('foo')  # type: ignore
+
+    _reason = str(reason.value)
+
+    assert _reason == 'source'
+
+
+
+def test_expate(
+    tmp_path: Path,
+    sample_impate: _SAMPLE,
+    sample_expate: _SAMPLE,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param sample_impate: Source dictionary for use in test.
+    :param sample_expate: Source dictionary for use in test.
+    :param tmp_path: pytest object for temporal filesystem.
+    """
+
+    sample_path = (
+        SAMPLES / 'expate.json')
+
+    sample = load_sample(
+        path=sample_path,
+        update=ENPYRWS,
+        content=sample_expate)
+
+    expect = prep_sample(
+        content=sample_expate)
+
+    assert expect == sample
+
+
+
+def test_expate_cover(
+    tmp_path: Path,
+    sample_impate: _SAMPLE,
+    sample_expate: _SAMPLE,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param sample_impate: Source dictionary for use in test.
+    :param sample_expate: Source dictionary for use in test.
+    :param tmp_path: pytest object for temporal filesystem.
+    """
+
+
+    assert sample_expate == (
+        expate(sample_impate))
+
+
+    assert sample_expate == (
+        expate(sample_expate))
+
+
+    assert all(
+        x == _DICT1R for x in
+        sample_expate.values())

encommon/version.txt

@@ -1 +1 @@
-0.20.5
+0.21.0

{encommon-0.20.5.dist-info → encommon-0.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: encommon
-Version: 0.20.5
+Version: 0.21.0
 Summary: Enasis Network Common Library
 License: MIT
 Project-URL: Source, https://github.com/enasisnetwork/encommon

{encommon-0.20.5.dist-info → encommon-0.21.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 encommon/__init__.py,sha256=YDGzuhpk5Gd1hq54LI0hw1NrrDvrJDrvH20TEy_0l5E,443
 encommon/conftest.py,sha256=I7Zl2cMytnA-mwSPh0rRjsU0YSlES94jQq6mocRhVUE,1884
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=zAFOylcqU7YquFNYPks2kOCmdCQzNW6Hu0iuhZa8Iec,7
+encommon/version.txt,sha256=NjxqrLtomi72kbaWdGKfZH8a-v68ncNTqG5rCTALJPY,7
 encommon/colors/__init__.py,sha256=XRiGimMj8oo040NO5a5ZsbsIUxaGVW4tf4xWTPWgnZY,269
 encommon/colors/color.py,sha256=rDWWL5oMx2SVSBEuRYX43u71nzMhMTZipXAHmEXwAjQ,10919
 encommon/colors/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
@@ -55,20 +55,20 @@ encommon/times/test/test_unitime.py,sha256=5i4UjBCw8R9h-Lw963GfB_dHBMEQhjvv1k-t2
 encommon/times/test/test_utils.py,sha256=WkzHJY6zOt02Ujg5FItOo1nPtktz5ss8ODmG1tRQaaw,2056
 encommon/times/test/test_window.py,sha256=6ySO5DaYzg1bsVNCqB6u71rKWc0vpolxQ09ruoswN2c,6138
 encommon/times/test/test_windows.py,sha256=Sq31BCvJtEN9OGGYXFKiagVZP0kc1n6HuaEBNwbkuks,4496
-encommon/types/__init__.py,sha256=wMgdz0PuJyL_LIfafDlWIDaDLJi-bhnQJ4YTuUgN2gY,1143
+encommon/types/__init__.py,sha256=ABenLJ4SOSAN1kRMKQrAZ4A-eYtr7g42hhb1BtuhzPo,1225
 encommon/types/classes.py,sha256=FYFTu8Uj-74JWudHOlhaOrsXXPxitorBfM9_QM3EGSU,1689
 encommon/types/dicts.py,sha256=IuLoVdtilhM83ujT74mcz0Zi1HI87P4k7wjnnyMxPag,2821
 encommon/types/empty.py,sha256=n5y5maXkcM3xNYNYGK6iqvk98ivQSeguaedwc0HoMv4,2739
 encommon/types/lists.py,sha256=AX-siqXfLwm_5mGDsomg_7XWalZOYLE60D3wHwbNEzo,2358
-encommon/types/notate.py,sha256=0JIzF5VDnQ6C4umZIpgxIvd91gFo3MXTZ7Kp54S538A,6454
+encommon/types/notate.py,sha256=xcvifAe5tXVK0NoxE5P-OEbJXp4UYa5RGsXU-A1TKA4,10698
 encommon/types/strings.py,sha256=LW2WZND64cKE1LhNip3vqsoP3elLsUP6cpS0dYnUKGE,2800
 encommon/types/types.py,sha256=DbzdDLLclD1Gk8bmyhDUUWVDnJ5LdaolLV3JYKHFVgA,322
-encommon/types/test/__init__.py,sha256=uauiJIPPJjk1bzp5WEH_YEFLR5m0zxVN_c1liYAYIro,827
+encommon/types/test/__init__.py,sha256=WZm1yZbFd2VQg-E1b6a02E6V2QXmIWiW5TIiKFFPV-s,910
 encommon/types/test/test_classes.py,sha256=CjthMInwz5WB7aTc7-GpzgcYAvkF9dRmC6nXJVoE91k,1475
-encommon/types/test/test_dicts.py,sha256=kVYIGlIyXOx9yiCPKbhhFMf0TpiTU0ESNOaJYIq0_Ms,3650
+encommon/types/test/test_dicts.py,sha256=W--IcPwvdKaFGs_00tvWBGziFSA0wtDQMuPk4rl0gKU,3651
 encommon/types/test/test_empty.py,sha256=eLsHuqq2YNABFkMLPbGbJMXeW2nyGNIxzUZv7YhPT5U,1017
 encommon/types/test/test_lists.py,sha256=uRdON1vnDT21TBl2prlO15SHIkN7YOApZzHS78R-Bvs,1139
-encommon/types/test/test_notate.py,sha256=NfrDmMD6hOoVi9wlQ8yLZNnuHwS6Z7bLze70FkxOjSA,4008
+encommon/types/test/test_notate.py,sha256=KTOqlHUuS7ed80_h0n7TJNkAqoeULrkbiMH6sPw0lak,9520
 encommon/types/test/test_strings.py,sha256=oXusioFMdknHeBdwlP_GakDVS9Tf2YBndjonj22UfmM,1277
 encommon/utils/__init__.py,sha256=bBgh81wX_TwLgWkx0aBAyVLHNphrfcyQc1AF7-ziyNI,1027
 encommon/utils/common.py,sha256=-bjGJ2UJa-WTOsVYiuZcVj1gkyH5OlRdRkJtxPw8J6k,555
@@ -83,8 +83,8 @@ encommon/utils/test/test_match.py,sha256=QagKpTFdRo23-Y55fSaJrSMpt5jIebScKbz0h8t
 encommon/utils/test/test_paths.py,sha256=4AzIhQyYFEWhRWHgOZCCzomQ3Zs3EVwRnDQDa6Nq1Mc,1942
 encommon/utils/test/test_sample.py,sha256=Qf-W0XbjTe5PfG87sdVizL2ymUPRTdX0qQtLGHaTgx8,3539
 encommon/utils/test/test_stdout.py,sha256=fYiqEaUraD-3hFQYLxMPR4Ti_8CbTjEc8WvReXUA884,6139
-encommon-0.20.5.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.20.5.dist-info/METADATA,sha256=2OO8NLbJBybg5k6gAmoclYc4XbzzDSFhdxmPzYnLAAE,4282
-encommon-0.20.5.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-encommon-0.20.5.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.20.5.dist-info/RECORD,,
+encommon-0.21.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.21.0.dist-info/METADATA,sha256=wY93Eig3-FwAU0dWgJrp9osqjreo0Zcxmojm-1SN-wo,4282
+encommon-0.21.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+encommon-0.21.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.21.0.dist-info/RECORD,,

{encommon-0.20.5.dist-info → encommon-0.21.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any