encommon 0.19.0__tar.gz → 0.19.1__tar.gz

{encommon-0.19.0/encommon.egg-info → encommon-0.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.19.0
+Version: 0.19.1
 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 → encommon-0.19.1}/README.md

@@ -1,6 +1,6 @@
 # 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 → encommon-0.19.1}/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}
 
 
@@ -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-0.19.0 → encommon-0.19.1}/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-0.19.0 → encommon-0.19.1}/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-0.19.0 → encommon-0.19.1}/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-0.19.0 → encommon-0.19.1}/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-0.19.1/encommon/version.txt

@@ -0,0 +1 @@
+0.19.1

{encommon-0.19.0 → encommon-0.19.1/encommon.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.19.0
+Version: 0.19.1
 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 → encommon-0.19.1}/setup.cfg

@@ -13,6 +13,7 @@ per-file-ignores =
 	encommon/crypts/hashes.py:S324,
 	encommon/parse/jinja2.py:ANN401,S701,
 	encommon/times/utils.py:DTZ001,
+	encommon/types/dicts.py:SIM114,
 	encommon/utils/test/test_stdout.py:LIT015,
 	encommon/utils/sample.py:ANN401,SIM114,
 	encommon/utils/stdout.py:SIM114,

encommon-0.19.0/encommon/version.txt

@@ -1 +0,0 @@
-0.19.0