encommon 0.19.0__py3-none-any.whl → 0.19.2__py3-none-any.whl

encommon/parse/jinja2.py

@@ -9,6 +9,8 @@ is permitted, for more information consult the project license file.
 
 from ast import literal_eval as leval
 from contextlib import suppress
+from copy import copy
+from copy import deepcopy
 from re import DOTALL
 from re import findall as re_findall
 from re import match as re_match
@@ -19,12 +21,24 @@ from typing import Optional
 from jinja2 import Environment
 from jinja2 import StrictUndefined
 
+from .network import Network
+from .network import insubnet_ip
+from .network import isvalid_ip
 from ..colors import Color
 from ..crypts import Hashes
 from ..times import Duration
 from ..times import Time
+from ..times import unitime
 from ..types import DictStrAny
+from ..types import dedup_list
 from ..types import fuzzy_list
+from ..types import hasstr
+from ..types import inlist
+from ..types import instr
+from ..types import merge_dicts
+from ..types import rplstr
+from ..types import sort_dict
+from ..types import strplwr
 from ..utils import fuzz_match
 from ..utils import rgxp_match
 
@@ -41,13 +55,47 @@ LITERAL = (
     '|True|False|None|'
     r'(\-?([1-9]\d*|0)(\.\d+)?))$')
 
+
+
 DEFAULT: dict[str, FILTER] = {
+
+    # Python builtins
+    'all': all,
+    'any': any,
+    'copy': copy,
+    'deepcopy': deepcopy,
+
+    # encommon.times
     'Duration': Duration,
+    'Time': Time,
+
+    # encommon.colors
     'Color': Color,
+
+    # encommon.crypts
     'Hashes': Hashes,
-    'Time': Time,
-    'fuzz_match': fuzz_match,
+
+    # encommon.parse
+    'Network': Network,
+    'insubnet_ip': insubnet_ip,
+    'isvalid_ip': isvalid_ip,
+
+    # encommon.times
+    'unitime': unitime,
+
+    # encommon.types
+    'strplwr': strplwr,
+    'hasstr': hasstr,
+    'instr': instr,
+    'inlist': inlist,
+    'rplstr': rplstr,
+    'dedup_list': dedup_list,
     'fuzzy_list': fuzzy_list,
+    'merge_dicts': merge_dicts,
+    'sort_dict': sort_dict,
+
+    # encommon.utils
+    'fuzz_match': fuzz_match,
     'rgxp_match': rgxp_match}
 
 
@@ -59,7 +107,7 @@ class Jinja2:
     Example
     -------
     >>> jinja2 = Jinja2()
-    >>> jinja2.parse('{{ 0 | Time}}')
+    >>> jinja2.parse('{{ 0 | Time }}')
     '1970-01-01T00:00:00.000000+0000'
 
     :param statics: Additional values available for parsing.
@@ -164,7 +212,9 @@ class Jinja2:
         :returns: Provided input using the Jinja2 environment.
         """
 
-        statics = statics or {}
+        statics = (
+            dict(statics or {})
+            | self.__statics)
 
         parser = (
             self.__jinjenv

encommon/types/dicts.py

@@ -7,6 +7,7 @@ is permitted, for more information consult the project license file.
 
 
 
+from copy import deepcopy
 from typing import Any
 
 
@@ -14,11 +15,12 @@ from typing import Any
 def merge_dicts(
     dict1: dict[Any, Any],
     dict2: dict[Any, Any],
-    force: bool = False,
+    force: bool | None = False,
     *,
     merge_list: bool = True,
     merge_dict: bool = True,
-) -> None:
+    paranoid: bool = False,
+) -> dict[Any, Any]:
     """
     Recursively merge the contents of provided dictionaries.
 
@@ -30,22 +32,36 @@ def merge_dicts(
     >>> dict1 = {'a': 'b', 'c': [1]}
     >>> dict2 = {'a': 'B', 'c': [2]}
     >>> merge_dicts(dict1, dict2)
+    {'a': 'b', 'c': [1, 2]}
     >>> dict1
     {'a': 'b', 'c': [1, 2]}
 
     :param dict1: Primary dictionary which is merged into.
     :param dict2: Secondary dictionary for primary updates.
     :param force: Force overwriting concrete values in the
-        primary dictionary with those from secondary.
+        primary dictionary with those from secondary. When
+        ``None`` only overwrites if destination is ``None``.
     :param merge_list: Determines if merged or overwritten.
     :param merge_dict: Determines if merged or overwritten.
+    :param paranoid: Perform an initial deepcopy on both of
+        the provided dictionaries before performing merges.
+    :returns: Provided dictionary with the other merged in.
     """
 
+    if paranoid is True:
+        dict1 = deepcopy(dict1)
+        dict2 = deepcopy(dict2)
+
+
     for key, value in dict2.items():
 
         if key not in dict1:
             dict1[key] = value
 
+        elif (dict1[key] is None
+                and force is None):
+            dict1[key] = value
+
         elif (isinstance(dict1[key], list)
                 and isinstance(value, list)
                 and merge_list is True):
@@ -64,6 +80,9 @@ def merge_dicts(
             dict1[key] = value
 
 
+    return dict1
+
+
 
 def sort_dict(
     value: dict[Any, Any],

encommon/types/lists.py

@@ -22,15 +22,21 @@ def dedup_list(
     .. warning::
        This function will update the ``value`` reference.
 
+    Example
+    -------
+    >>> value = [1, 2, 2, 3]
+    >>> dedup_list(value)
+    [1, 2, 3]
+    >>> value
+    [1, 2, 3]
+
     :param value: List of values processed for duplication.
+    :param update: Indicate if to update provided reference.
     :returns: Provided list values with duplicates removed.
     """
 
     if update is False:
-
-        dedup = dict.fromkeys(value)
-
-        return list(dedup)
+        value = list(value)
 
 
     unique: list[Any] = []
@@ -57,6 +63,13 @@ def fuzzy_list(
     """
     Return the provided values that match provided patterns.
 
+    Example
+    -------
+    >>> values = ['foo', 'bar', 'baz', 'bop']
+    >>> patterns = ['*o', 'ba*']
+    >>> fuzzy_list(values, patterns)
+    ['foo', 'bar', 'baz']
+
     :param values: Value or values to enumerate for matching.
     :param patterns: Patterns which values can match any one.
     :returns: Provided values that match provided patterns.

encommon/types/test/__init__.py

@@ -17,7 +17,8 @@ _DICT1 = {
     'list': ['d1list'],
     'tuple': (1, 2),
     'dict': {'key': 'd1dict'},
-    'bool': False}
+    'bool': False,
+    'null': None}
 
 _DICT2 = {
     'dict2': 'dict2',
@@ -25,7 +26,8 @@ _DICT2 = {
     'list': ['d2list'],
     'tuple': (3, 4),
     'dict': {'key': 'd2dict'},
-    'bool': True}
+    'bool': True,
+    'null': 'null'}
 
 _DICT1R = deepcopy(_DICT1)
 _DICT2R = deepcopy(_DICT2)

encommon/types/test/test_dicts.py

@@ -18,7 +18,7 @@ from ..dicts import sort_dict
 
 
 
-def test_merge_dicts() -> None:
+def test_merge_dicts() -> None:  # noqa: CFQ001
     """
     Perform various tests associated with relevant routines.
     """
@@ -40,6 +40,7 @@ def test_merge_dicts() -> None:
         'dict': {'key': 'd1dict'},
         'tuple': (1, 2),
         'bool': False,
+        'null': None,
         'nested': [_DICT1, _DICT2],
         'recurse': {
             'dict1': 'dict1',
@@ -48,7 +49,8 @@ def test_merge_dicts() -> None:
             'list': ['d1list', 'd2list'],
             'dict': {'key': 'd1dict'},
             'tuple': (1, 2),
-            'bool': False}}
+            'bool': False,
+            'null': None}}
 
 
     source = deepcopy(dict1)
@@ -64,6 +66,7 @@ def test_merge_dicts() -> None:
         'dict': {'key': 'd2dict'},
         'tuple': (3, 4),
         'bool': True,
+        'null': 'null',
         'nested': [_DICT1, _DICT2],
         'recurse': {
             'dict1': 'dict1',
@@ -72,15 +75,41 @@ def test_merge_dicts() -> None:
             'list': ['d1list', 'd2list'],
             'dict': {'key': 'd2dict'},
             'tuple': (3, 4),
-            'bool': True}}
+            'bool': True,
+            'null': 'null'}}
+
+
+    source = deepcopy(dict1)
+    update = deepcopy(dict2)
+
+    merge_dicts(source, update, None)
+
+    assert source == {
+        'dict1': 'dict1',
+        'dict2': 'dict2',
+        'str': 'd1string',
+        'list': ['d1list', 'd2list'],
+        'dict': {'key': 'd1dict'},
+        'tuple': (1, 2),
+        'bool': False,
+        'null': 'null',
+        'nested': [_DICT1, _DICT2],
+        'recurse': {
+            'dict1': 'dict1',
+            'dict2': 'dict2',
+            'str': 'd1string',
+            'list': ['d1list', 'd2list'],
+            'dict': {'key': 'd1dict'},
+            'tuple': (1, 2),
+            'bool': False,
+            'null': 'null'}}
 
 
     source = deepcopy(dict1)
     update = deepcopy(dict2)
 
     merge_dicts(
-        source,
-        update,
+        source, update,
         merge_list=False,
         merge_dict=False)
 
@@ -92,6 +121,7 @@ def test_merge_dicts() -> None:
         'dict': {'key': 'd1dict'},
         'tuple': (1, 2),
         'bool': False,
+        'null': None,
         'nested': [_DICT1],
         'recurse': {
             'dict1': 'dict1',
@@ -99,9 +129,16 @@ def test_merge_dicts() -> None:
             'list': ['d1list'],
             'dict': {'key': 'd1dict'},
             'tuple': (1, 2),
-            'bool': False}}
+            'bool': False,
+            'null': None}}
 
 
+    _source = merge_dicts(
+        source, update,
+        paranoid=True)
+
+    assert source is not _source
+
 
 def test_sort_dict() -> None:
     """
@@ -114,4 +151,5 @@ def test_sort_dict() -> None:
         'tuple': (1, 2),
         'dict1': 'dict1',
         'list': ['d1list'],
-        'str': 'd1string'}
+        'str': 'd1string',
+        'null': None}

encommon/version.txt

@@ -1 +1 @@
-0.19.0
+0.19.2

{encommon-0.19.0.dist-info → encommon-0.19.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.19.0
+Version: 0.19.2
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -21,7 +21,7 @@ Requires-Dist: sqlalchemy
 
 # Enasis Network Common Library
 
-> :children_crossing: This project has not released its first major version.
+> :warning: This project has not released its first major version.
 
 Common classes and functions used in various public and private projects.
 

{encommon-0.19.0.dist-info → encommon-0.19.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
 encommon/__init__.py,sha256=YDGzuhpk5Gd1hq54LI0hw1NrrDvrJDrvH20TEy_0l5E,443
 encommon/conftest.py,sha256=qorgldYdoDt_LFQupdT0ZUF5eAVPuJ5X3Jvv4VIa78Q,1900
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=BsU91PIrLgA4yiu5rzLMGrfmmJjZnMO_oivZZfIarI8,7
+encommon/version.txt,sha256=n8nEL77-uL-2uK8EsWtDysdQM9Si-Tg-wqwbM7-QNKQ,7
 encommon/colors/__init__.py,sha256=XRiGimMj8oo040NO5a5ZsbsIUxaGVW4tf4xWTPWgnZY,269
 encommon/colors/color.py,sha256=EiUxNbVL1689Cqhw1LmO9ysmN3ulCVtGZGylyV8LuVA,10884
 encommon/colors/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
@@ -27,7 +27,7 @@ encommon/crypts/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLE
 encommon/crypts/test/test_crypts.py,sha256=F-81-2R8_xfPMRU8QLYzfnvp01uP5BB-xA0XtmMISJE,3482
 encommon/crypts/test/test_hashes.py,sha256=OmidSycLkUyso6K5Hfun2NopPXA1uL3SFqz_2aITOMM,1201
 encommon/parse/__init__.py,sha256=6uV4GCm_nOYC77x2jQvTDsa0F6vBGRbCgju_HCc96zM,422
-encommon/parse/jinja2.py,sha256=AzLermYAge3oN33hBDvIXSqlF09n34wWS-y_Hg6JWWc,6051
+encommon/parse/jinja2.py,sha256=2ZKTWjEGVHp6Dh8fkeMvuFp_AcIzCim-pA3UUf2TXWw,7067
 encommon/parse/network.py,sha256=PgQ6xV6Y9KmyH0iXqQ-b88Gtkrry75Fzc-tZd-BH0ng,8771
 encommon/parse/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/parse/test/test_jinja2.py,sha256=hZu4BaRWZgyU_edVUcDiJs9gJnoFoSWF9o7CPROmcAI,3760
@@ -57,15 +57,15 @@ encommon/times/test/test_window.py,sha256=gNJpWVrwQTnUFQ00OLzWUuvJjWUCoiCwydohr9
 encommon/times/test/test_windows.py,sha256=IaaxUXqf5n9IF9X0HkRqtCdyOdeCq5DYR1ySLORA9gE,4474
 encommon/types/__init__.py,sha256=wMgdz0PuJyL_LIfafDlWIDaDLJi-bhnQJ4YTuUgN2gY,1143
 encommon/types/classes.py,sha256=FYFTu8Uj-74JWudHOlhaOrsXXPxitorBfM9_QM3EGSU,1689
-encommon/types/dicts.py,sha256=lC2FmPzMEj9L73jUjf3o6OVQ-LqK_3gp5nBwYibdGfo,2265
+encommon/types/dicts.py,sha256=IuLoVdtilhM83ujT74mcz0Zi1HI87P4k7wjnnyMxPag,2821
 encommon/types/empty.py,sha256=n5y5maXkcM3xNYNYGK6iqvk98ivQSeguaedwc0HoMv4,2739
-encommon/types/lists.py,sha256=xjTDOzndqPHu_Cl0yWRDl60lvjLqEqHFW4P7uJ2lfvc,2046
+encommon/types/lists.py,sha256=AX-siqXfLwm_5mGDsomg_7XWalZOYLE60D3wHwbNEzo,2358
 encommon/types/notate.py,sha256=0JIzF5VDnQ6C4umZIpgxIvd91gFo3MXTZ7Kp54S538A,6454
 encommon/types/strings.py,sha256=LW2WZND64cKE1LhNip3vqsoP3elLsUP6cpS0dYnUKGE,2800
 encommon/types/types.py,sha256=DbzdDLLclD1Gk8bmyhDUUWVDnJ5LdaolLV3JYKHFVgA,322
-encommon/types/test/__init__.py,sha256=UIyNazTlIIdUzQS0brlD7hCPN_LYw_J6Ucxm8wh3cPU,789
+encommon/types/test/__init__.py,sha256=uauiJIPPJjk1bzp5WEH_YEFLR5m0zxVN_c1liYAYIro,827
 encommon/types/test/test_classes.py,sha256=CjthMInwz5WB7aTc7-GpzgcYAvkF9dRmC6nXJVoE91k,1475
-encommon/types/test/test_dicts.py,sha256=-RLkcyexCXGSyJyPx1e3QU8sNXEgtSvD9pZakdOwVvg,2702
+encommon/types/test/test_dicts.py,sha256=kVYIGlIyXOx9yiCPKbhhFMf0TpiTU0ESNOaJYIq0_Ms,3650
 encommon/types/test/test_empty.py,sha256=LVsZbKOg0deyKOtg_0Fhf0b_0c94LftwdDhijna-FbA,995
 encommon/types/test/test_lists.py,sha256=uRdON1vnDT21TBl2prlO15SHIkN7YOApZzHS78R-Bvs,1139
 encommon/types/test/test_notate.py,sha256=NfrDmMD6hOoVi9wlQ8yLZNnuHwS6Z7bLze70FkxOjSA,4008
@@ -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.19.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.19.0.dist-info/METADATA,sha256=wQiFB7-IXLGMcMeIqzFMcnhFOx6SbkY3r30lIJmMQEM,3494
-encommon-0.19.0.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-encommon-0.19.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.19.0.dist-info/RECORD,,
+encommon-0.19.2.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.19.2.dist-info/METADATA,sha256=V8H-MF9YmvKRwDTID1-AtYjnWfv-AOQpQBmjI0OQX44,3484
+encommon-0.19.2.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+encommon-0.19.2.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.19.2.dist-info/RECORD,,

{encommon-0.19.0.dist-info → encommon-0.19.2.dist-info}/WHEEL

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