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

encommon/parse/test/test_network.py

@@ -0,0 +1,226 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+"""
+
+
+
+from pytest import raises
+
+from ..network import Network
+from ..network import insubnet_ip
+from ..network import isvalid_ip
+from ...types import inrepr
+from ...types import instr
+from ...types import lattrs
+
+
+
+def test_Network() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+
+    naddr = Network('12.34.56.7')
+
+
+    attrs = lattrs(naddr)
+
+    assert attrs == [
+        '_Network__source']
+
+
+    assert inrepr(
+        "Network('12.34.",
+        naddr)
+
+    assert hash(naddr) > 0
+
+    assert instr(
+        '12.34.56.7/32',
+        naddr)
+
+
+    assert naddr == '12.34.56.7'
+    assert naddr != 'invalid'
+
+
+    assert naddr.source
+
+    assert naddr.version == 4
+
+    assert naddr.cidr == 32
+
+    assert naddr.address == '12.34.56.7'
+
+    assert naddr.address_cidr == '12.34.56.7/32'
+
+    assert naddr.address_host == '12.34.56.7/32'
+
+    assert naddr.network == '12.34.56.7'
+
+    assert naddr.network_cidr == '12.34.56.7/32'
+
+    assert not naddr.broadcast
+
+    assert naddr.netmask == '255.255.255.255'
+
+    assert naddr.padded == '012.034.056.007'
+
+    assert naddr.reverse == '7.56.34.12'
+
+    assert naddr.hwaddr == '01-20-34-05-60-07'
+
+    assert naddr.ispublic
+
+    assert not naddr.isprivate
+
+    assert not naddr.islinklocal
+
+    assert not naddr.islocalhost
+
+
+
+def test_Network_ipv4() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+
+    naddr = Network('12.34.56.7/24')
+
+
+    assert naddr.cidr == 24
+
+    assert naddr.address == '12.34.56.7'
+
+    assert naddr.address_cidr == '12.34.56.7/24'
+
+    assert naddr.address_host == '12.34.56.7/32'
+
+    assert naddr.network == '12.34.56.0'
+
+    assert naddr.network_cidr == '12.34.56.0/24'
+
+    assert naddr.broadcast == '12.34.56.255'
+
+    assert naddr.netmask == '255.255.255.0'
+
+    assert naddr.padded == '012.034.056.007'
+
+    assert naddr.reverse == '7.56.34.12'
+
+    assert naddr.hwaddr == '01-20-34-05-60-07'
+
+    assert naddr.ispublic
+
+    assert not naddr.isprivate
+
+    assert not naddr.islinklocal
+
+    assert not naddr.islocalhost
+
+
+
+def test_Network_ipv6() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+
+    naddr = Network('2001:db8::/64')
+
+
+    assert naddr.cidr == 64
+
+    assert naddr.address == '2001:db8::'
+
+    assert naddr.address_cidr == '2001:db8::/64'
+
+    assert naddr.address_host == '2001:db8::/128'
+
+    assert naddr.network == '2001:db8::'
+
+    assert naddr.network_cidr == '2001:db8::/64'
+
+    assert naddr.broadcast == (
+        '2001:db8::ffff:ffff:ffff:ffff')
+
+    assert naddr.netmask == (
+        'ffff:ffff:ffff:ffff::')
+
+    with raises(ValueError):
+        naddr.padded
+
+    with raises(ValueError):
+        naddr.reverse
+
+    with raises(ValueError):
+        naddr.hwaddr
+
+    assert not naddr.ispublic
+
+    assert naddr.isprivate
+
+    assert not naddr.islinklocal
+
+    assert not naddr.islocalhost
+
+
+
+def test_isvalid_ip() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert isvalid_ip('1.2.3.4')
+
+    assert not isvalid_ip('1.2')
+
+    assert not isvalid_ip(None)
+
+
+
+def test_insubnet_ip() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert insubnet_ip(
+        '192.168.1.1',
+        ['172.16.0.0/12',
+         '192.168.0.0/16'])
+
+    assert not insubnet_ip(
+        '1.2.3.4',
+        ['172.16.0.0/12',
+         '192.168.0.0/16'])
+
+    assert insubnet_ip(
+        '192.168.1.1',
+        ['192.168.1.1/32'])
+
+    assert insubnet_ip(
+        '192.168.1.1/32',
+        '192.168.1.1/32')
+
+    assert insubnet_ip(
+        '2001:db8::',
+        ['2001:db8::/128'])
+
+    assert insubnet_ip(
+        '2001:db8::',
+        ['2001:db8::/32'])
+
+    assert insubnet_ip(
+        '2001:db8::/128',
+        ['2001:db8::/32'])
+
+    with raises(ValueError):
+
+        insubnet_ip(
+            'invalid',
+            ['2001:db8::/32'])

encommon/types/__init__.py

@@ -13,6 +13,8 @@ from .classes import lattrs
 from .dicts import merge_dicts
 from .dicts import sort_dict
 from .empty import Empty
+from .lists import dedup_list
+from .lists import fuzzy_list
 from .lists import inlist
 from .notate import delate
 from .notate import getate
@@ -32,6 +34,8 @@ from .types import NCTrue
 __all__ = [
     'BaseModel',
     'clsname',
+    'dedup_list',
+    'fuzzy_list',
     'delate',
     'DictStrAny',
     'Empty',

encommon/types/lists.py

@@ -12,6 +12,77 @@ from typing import Sequence
 
 
 
+def dedup_list(
+    value: list[Any],
+    update: bool = True,
+) -> list[Any]:
+    """
+    Return the provided list values with duplicates removed.
+
+    .. warning::
+       This function will update the ``value`` reference.
+
+    :param value: List of values processed for duplication.
+    :returns: Provided list values with duplicates removed.
+    """
+
+    if update is False:
+
+        dedup = dict.fromkeys(value)
+
+        return list(dedup)
+
+
+    unique: list[Any] = []
+
+    for item in list(value):
+
+        if item in unique:
+
+            value.remove(item)
+
+            continue
+
+        unique.append(item)
+
+
+    return value
+
+
+
+def fuzzy_list(
+    values: str | list[str],
+    patterns: str | list[str],
+) -> list[str]:
+    """
+    Return the provided values that match provided patterns.
+
+    :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.
+    """
+
+    from ..utils import fuzz_match
+
+    if isinstance(values, str):
+        values = [values]
+
+    matched: list[str] = []
+
+    for value in values:
+
+        match = fuzz_match(
+            value, patterns)
+
+        if match is False:
+            continue
+
+        matched.append(value)
+
+    return matched
+
+
+
 def inlist(
     needle: Any,  # noqa: ANN401
     haystack: Sequence[Any],

encommon/types/test/test_lists.py

@@ -7,6 +7,8 @@ is permitted, for more information consult the project license file.
 
 
 
+from ..lists import dedup_list
+from ..lists import fuzzy_list
 from ..lists import inlist
 
 
@@ -21,3 +23,42 @@ def test_inlist() -> None:
     haystack = [123, 456]
 
     assert inlist(needle, haystack)
+
+
+
+def test_dedup_list() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    value = [1, 1, '2', 2, 3, 3]
+
+    dedup = dedup_list(
+        value,
+        update=False)
+
+    assert dedup != value
+    assert dedup == [1, '2', 2, 3]
+
+    dedup_list(value)
+
+    assert dedup == value
+    assert dedup == [1, '2', 2, 3]
+
+
+
+def test_fuzzy_list() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    values = ['1', '2']
+    patterns = ['1*']
+
+    matched = fuzzy_list(
+        values, patterns)
+
+    assert matched == ['1']
+
+    assert not (
+        fuzzy_list('', []))

encommon/version.txt

@@ -1 +1 @@
-0.17.2
+0.19.0

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.17.2
+Version: 0.19.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -11,6 +11,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: croniter
 Requires-Dist: cryptography
+Requires-Dist: jinja2
+Requires-Dist: netaddr
 Requires-Dist: pydantic
 Requires-Dist: python-dateutil
 Requires-Dist: pyyaml

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

@@ -1,13 +1,13 @@
 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=ubiMO6DptuNe8qTQK8J6LAIG8aH8uLh0mr6Q34-dDw0,7
+encommon/version.txt,sha256=BsU91PIrLgA4yiu5rzLMGrfmmJjZnMO_oivZZfIarI8,7
 encommon/colors/__init__.py,sha256=XRiGimMj8oo040NO5a5ZsbsIUxaGVW4tf4xWTPWgnZY,269
 encommon/colors/color.py,sha256=EiUxNbVL1689Cqhw1LmO9ysmN3ulCVtGZGylyV8LuVA,10884
 encommon/colors/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/colors/test/test_color.py,sha256=GKYzfnOlb2yKI0qmPDxumkeQNSXpvxTprUV9pAJPV94,4566
 encommon/config/__init__.py,sha256=iZdbW7A4m7iN4xt5cEeQqo0Klqs-CaPLdD5ocLmUYi8,856
-encommon/config/config.py,sha256=-votrrG3pvU3oWrHoIMKu-pPZSC2MpdGz-1RSK6uXtk,6953
+encommon/config/config.py,sha256=d66HM-7_6vH__NdGxx7eu2a6Bxu_N9GDW4t0TAS7bVc,6994
 encommon/config/files.py,sha256=dSuShvIbQXFiNmpkwNVHCKDI-phBWC03OJVUfKJnfX0,2433
 encommon/config/logger.py,sha256=MsGng6k1m4r5DnFkX8PhO33nj26AyiRYrKtFkjhAuNo,14556
 encommon/config/params.py,sha256=FtcWi3-CY6OHLN7o3S-iBktpS1yGt5wLVD0546XEKRY,2223
@@ -26,6 +26,12 @@ encommon/crypts/params.py,sha256=2uH_i1NBMlzhq7UtWgX2jsiUGNniOK69eTCeeiQFpdw,141
 encommon/crypts/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 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/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
+encommon/parse/test/test_network.py,sha256=apBv7rNtdjSbGnpXwg1VX-ybF3w-tyqYjpQDv6mlwfM,4148
 encommon/times/__init__.py,sha256=QX4iuZ59UlsMbEWbubnVJXJtrOubNxAAAv510urcLUA,972
 encommon/times/common.py,sha256=HWgWBbqDoyKHIqeg4bBAZZfRM3499X3WPu8dVCzt_5o,995
 encommon/times/duration.py,sha256=LTROiKcRXvPcs2Gz9KaB5Cmxo9NXd3TcMo5-jnTxPo0,10794
@@ -49,11 +55,11 @@ 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=gNJpWVrwQTnUFQ00OLzWUuvJjWUCoiCwydohr9mevT0,6116
 encommon/times/test/test_windows.py,sha256=IaaxUXqf5n9IF9X0HkRqtCdyOdeCq5DYR1ySLORA9gE,4474
-encommon/types/__init__.py,sha256=_DVoVFJWd-9aCpXtPEaB3CnZ-5gt-uYxMWzquXfXHpg,1047
+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/empty.py,sha256=n5y5maXkcM3xNYNYGK6iqvk98ivQSeguaedwc0HoMv4,2739
-encommon/types/lists.py,sha256=4xn1RqS1VMsNnhR-2Xpv4ykB6d2RteFa5zdiWKzo55o,745
+encommon/types/lists.py,sha256=xjTDOzndqPHu_Cl0yWRDl60lvjLqEqHFW4P7uJ2lfvc,2046
 encommon/types/notate.py,sha256=0JIzF5VDnQ6C4umZIpgxIvd91gFo3MXTZ7Kp54S538A,6454
 encommon/types/strings.py,sha256=LW2WZND64cKE1LhNip3vqsoP3elLsUP6cpS0dYnUKGE,2800
 encommon/types/types.py,sha256=DbzdDLLclD1Gk8bmyhDUUWVDnJ5LdaolLV3JYKHFVgA,322
@@ -61,7 +67,7 @@ encommon/types/test/__init__.py,sha256=UIyNazTlIIdUzQS0brlD7hCPN_LYw_J6Ucxm8wh3c
 encommon/types/test/test_classes.py,sha256=CjthMInwz5WB7aTc7-GpzgcYAvkF9dRmC6nXJVoE91k,1475
 encommon/types/test/test_dicts.py,sha256=-RLkcyexCXGSyJyPx1e3QU8sNXEgtSvD9pZakdOwVvg,2702
 encommon/types/test/test_empty.py,sha256=LVsZbKOg0deyKOtg_0Fhf0b_0c94LftwdDhijna-FbA,995
-encommon/types/test/test_lists.py,sha256=RXvIQvr1nODutPBRx5hMsPRq_10AzBWF594KINoMgU8,437
+encommon/types/test/test_lists.py,sha256=uRdON1vnDT21TBl2prlO15SHIkN7YOApZzHS78R-Bvs,1139
 encommon/types/test/test_notate.py,sha256=NfrDmMD6hOoVi9wlQ8yLZNnuHwS6Z7bLze70FkxOjSA,4008
 encommon/types/test/test_strings.py,sha256=oXusioFMdknHeBdwlP_GakDVS9Tf2YBndjonj22UfmM,1277
 encommon/utils/__init__.py,sha256=bBgh81wX_TwLgWkx0aBAyVLHNphrfcyQc1AF7-ziyNI,1027
@@ -77,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.17.2.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
-encommon-0.17.2.dist-info/METADATA,sha256=vY6bz8Oj1lrOkaIAbIwbNJG1QdSLnmH7HaIvGM2mT2k,3449
-encommon-0.17.2.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-encommon-0.17.2.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.17.2.dist-info/RECORD,,
+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,,