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

encommon/parse/network.py

@@ -0,0 +1,453 @@
+"""
+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 contextlib import suppress
+from typing import Any
+from typing import Optional
+
+from netaddr import IPAddress
+from netaddr import IPNetwork
+
+
+
+class Network:
+    """
+    Convert the network into the various supported formats.
+
+    :param source: Network IPv4 or IPv6 network or address.
+    """
+
+    __source: IPNetwork
+
+
+    def __init__(
+        self,
+        source: str,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        network = IPNetwork(source)
+
+        self.__source = network
+
+
+    def __repr__(
+        self,
+    ) -> str:
+        """
+        Built-in method for representing the values for instance.
+
+        :returns: String representation for values from instance.
+        """
+
+        return f"Network('{self.address_cidr}')"
+
+
+    def __hash__(
+        self,
+    ) -> int:
+        """
+        Built-in method called when performing hashing operation.
+
+        :returns: Boolean indicating outcome from the operation.
+        """
+
+        return hash(self.__source)
+
+
+    def __str__(
+        self,
+    ) -> str:
+        """
+        Built-in method for representing the values for instance.
+
+        :returns: String representation for values from instance.
+        """
+
+        return self.address_cidr
+
+
+    def __eq__(
+        self,
+        other: object,
+    ) -> bool:
+        """
+        Built-in method for comparing this instance with another.
+
+        :param other: Other value being compared with instance.
+        :returns: Boolean indicating outcome from the operation.
+        """
+
+        source = self.__source
+
+        with suppress(Exception):
+
+            other = IPNetwork(str(other))
+
+            return source == other
+
+        return False
+
+
+    def __ne__(
+        self,
+        other: object,
+    ) -> bool:
+        """
+        Built-in method for comparing this instance with another.
+
+        :param other: Other value being compared with instance.
+        :returns: Boolean indicating outcome from the operation.
+        """
+
+        return not self.__eq__(other)
+
+
+    @property
+    def source(
+        self,
+    ) -> IPNetwork:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        return self.__source
+
+
+    @property
+    def version(
+        self,
+    ) -> int:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        return self.__source.version
+
+
+    @property
+    def cidr(
+        self,
+    ) -> int:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        source = self.__source
+
+        return source.prefixlen
+
+
+    @property
+    def address(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        source = self.__source
+
+        return str(source.ip)
+
+
+    @property
+    def address_cidr(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        address = self.address
+
+        return f'{address}/{self.cidr}'
+
+
+    @property
+    def address_host(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        address = self.address
+
+        prefix = (
+            128
+            if self.version == 6
+            else 32)
+
+        return f'{address}/{prefix}'
+
+
+    @property
+    def network(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        source = self.__source
+
+        return str(source.network)
+
+
+    @property
+    def network_cidr(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        network = self.network
+
+        return f'{network}/{self.cidr}'
+
+
+    @property
+    def broadcast(
+        self,
+    ) -> Optional[str]:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        source = self.__source
+
+        address = source.broadcast
+
+        if address is None:
+            return None
+
+        return str(address)
+
+
+    @property
+    def padded(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        if self.version != 4:
+            raise ValueError('version')
+
+        address = self.address
+
+        octets = address.split('.')
+
+        pads = [
+            x.zfill(3)
+            for x in octets]
+
+        return '.'.join(pads)
+
+
+    @property
+    def reverse(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        if self.version != 4:
+            raise ValueError('version')
+
+
+        address = self.address
+
+        octets = address.split('.')
+
+        reverse = list(reversed(octets))
+
+        return '.'.join(reverse)
+
+
+    @property
+    def hwaddr(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        if self.version != 4:
+            raise ValueError('version')
+
+        padded = self.padded
+
+        nodots = (
+            padded
+            .replace('.', ''))
+
+        ranged = range(
+            0, len(nodots), 2)
+
+        pairs = [
+            nodots[x:x + 2]
+            for x in ranged]
+
+        return '-'.join(pairs)
+
+
+    @property
+    def netmask(
+        self,
+    ) -> str:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        source = self.__source
+
+        return str(source.netmask)
+
+
+
+    @property
+    def ispublic(
+        self,
+    ) -> bool:
+        """
+        Return the boolean indicating whether instance is state.
+        """
+
+        return (
+            self.source.ip
+            .is_global())
+
+
+    @property
+    def isprivate(
+        self,
+    ) -> bool:
+        """
+        Return the boolean indicating whether instance is state.
+        """
+
+        return not self.ispublic
+
+
+    @property
+    def islinklocal(
+        self,
+    ) -> bool:
+        """
+        Return the boolean indicating whether instance is state.
+        """
+
+        return (
+            self.source
+            .is_link_local())
+
+
+    @property
+    def islocalhost(
+        self,
+    ) -> bool:
+        """
+        Return the boolean indicating whether instance is state.
+        """
+
+        return (
+            self.source
+            .is_loopback())
+
+
+
+def insubnet_ip(
+    address: str,
+    networks: str | list[str] | tuple[str, ...],
+) -> bool:
+    """
+    Return the boolean indicating address is in the network.
+
+    :param address: Provided address to find in the network.
+    :param network: Networks which values can be within any.
+    :returns: Boolean indicating address is in the network.
+    """
+
+    if isinstance(networks, str):
+        networks = [networks]
+
+    networks = list(networks)
+
+    if not isvalid_ip(address):
+        raise ValueError('address')
+
+    naddr = Network(address)
+
+    if (naddr.version == 4
+            and naddr.cidr == 32):
+        address = naddr.address
+
+    if (naddr.version == 6
+            and naddr.cidr == 128):
+        address = naddr.address
+
+    parsed = IPAddress(address)
+
+    return any(
+        parsed in IPNetwork(x)
+        for x in networks)
+
+
+
+def isvalid_ip(
+    value: Any,  # noqa: ANN401
+) -> bool:
+    """
+    Return the boolean indicating whether the value is valid.
+
+    :param value: Value that will be validated as an address.
+    :returns: Boolean indicating whether the value is valid.
+    """
+
+    value = str(value)
+
+    try:
+        Network(value)
+        return True
+
+    except Exception:
+        return False

encommon/parse/test/__init__.py

@@ -0,0 +1,6 @@
+"""
+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.
+"""

encommon/parse/test/test_jinja2.py

@@ -0,0 +1,190 @@
+"""
+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 typing import Any
+
+from pytest import fixture
+from pytest import mark
+
+from ..jinja2 import Jinja2
+from ... import PROJECT
+from ...times.common import UNIXMPOCH
+from ...types import inrepr
+from ...types import instr
+from ...types import lattrs
+
+
+
+@fixture
+def jinja2() -> Jinja2:
+    """
+    Construct the instance for use in the downstream tests.
+
+    :returns: Newly constructed instance of related class.
+    """
+
+
+    def strval(
+        # NOCVR,
+        input: str,
+    ) -> str:
+        return str(input)
+
+
+    return Jinja2(
+        {'PROJECT': PROJECT},
+        {'strval': strval})
+
+
+
+def test_Jinja2(
+    jinja2: Jinja2,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param jinja2: Parsing class for the Jinja2 templating.
+    """
+
+
+    attrs = lattrs(jinja2)
+
+    assert attrs == [
+        '_Jinja2__statics',
+        '_Jinja2__filters',
+        '_Jinja2__jinjenv']
+
+
+    assert inrepr(
+        'jinja2.Jinja2 object',
+        jinja2)
+
+    assert hash(jinja2) > 0
+
+    assert instr(
+        'jinja2.Jinja2 object',
+        jinja2)
+
+
+    assert jinja2.statics
+
+    assert jinja2.filters
+
+    assert jinja2.jinjenv
+
+    assert jinja2.parse('1') == 1
+
+
+
+def test_Jinja2_recurse(
+    jinja2: Jinja2,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param jinja2: Parsing class for the Jinja2 templating.
+    """
+
+    parse = jinja2.parse
+
+    source = {
+        'dict': {'key': '{{ "val" }}'},
+        'list': [1, '{{ 2 }}', 3, '4'],
+        'deep': '{{ {"foo": "bar"} }}'}
+
+    parsed = parse(source)
+
+    assert parsed == {
+        'dict': {'key': 'val'},
+        'list': [1, 2, 3, 4],
+        'deep': {'foo': 'bar'}}
+
+    _parsed = parse(f'{source}')
+
+    assert _parsed == parsed
+
+
+
+@mark.parametrize(
+    'value,expect',
+    [('{{ none }}', None),
+     ('{{ 123 }}', 123),
+     ('{{ 1.2 }}', 1.2),
+     ('{{ -1.2 }}', -1.2)])
+def test_Jinja2_literal(
+    jinja2: Jinja2,
+    value: Any,  # noqa: ANN401
+    expect: Any,  # noqa: ANN401
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param jinja2: Parsing class for the Jinja2 templating.
+    :param value: Input that will be processed and returned.
+    :param expect: Expected output from the testing routine.
+    """
+
+    parse = jinja2.parse
+
+    parsed = parse(value)
+
+    parsed = parse(
+        value,
+        literal=False)
+
+    assert parsed == str(expect)
+
+    parsed = parse(
+        value,
+        literal=True)
+
+    assert parsed == expect
+
+
+
+@mark.parametrize(
+    'value,expect',
+    [('foo', 'foo'),
+     ('1.0.0', '1.0.0'),
+     ('1', 1),
+     ('1.0', 1.0),
+     ({'a': 'b'}, {'a': 'b'}),
+     ("{'a': 'b'}", {'a': 'b'}),
+     ('{{ 1 }}', 1),
+     ('{{ "1" | float }}', 1.0),
+     ('{{ "1" | int }}', 1),
+     ('{{ 0 | Time }}', UNIXMPOCH),
+     (100000, 100000),
+     ('100000', 100000),
+     (10.001, 10.001),
+     ('10.001', 10.001),
+     ([1, 2], [1, 2]),
+     ('[1, 2]', [1, 2]),
+     ('01', '01'),
+     ('{{ "01" }}', '01'),
+     ('-01', '-01'),
+     ('{{ "-01" }}', '-01')])
+def test_Jinja2_cover(
+    jinja2: Jinja2,
+    value: Any,  # noqa: ANN401
+    expect: Any,  # noqa: ANN401
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param jinja2: Parsing class for the Jinja2 templating.
+    :param value: Input that will be processed and returned.
+    :param expect: Expected output from the testing routine.
+    """
+
+    parse = jinja2.parse
+
+    parsed = parse(value)
+
+    assert parsed == expect