value-object-pattern 0.1.0__py3-none-any.whl

value_object_pattern/usables/internet/ipv4_network_value_object.py

@@ -0,0 +1,165 @@
+# ruff: noqa: N802
+"""
+Ipv4NetworkValueObject value object.
+"""
+
+from ipaddress import AddressValueError, IPv4Network, NetmaskValueError
+
+from value_object_pattern.decorators import process, validation
+from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
+
+from .ipv4_address_value_object import Ipv4AddressValueObject
+
+
+class Ipv4NetworkValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+    """
+    Ipv4NetworkValueObject value object ensures the provided value is a valid IPv4 network.
+
+    Example:
+    ```python
+    from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+    network = Ipv4NetworkValueObject(value='66.162.207.81')
+
+    print(repr(network))
+    # >>> Ipv4NetworkValueObject(value=66.162.207.81/32)
+    ```
+    """
+
+    @process(order=0)
+    def _ensure_value_is_normalized(self, value: str) -> str:
+        """
+        Ensures the value object value is normalized IPv4 network.
+
+        Args:
+            value (str): Value.
+
+        Returns:
+            str: Value with the normalized IPv4 network.
+        """
+        return str(object=IPv4Network(address=value))
+
+    @validation(order=0)
+    def _ensure_value_is_valid_ipv4_network(self, value: str) -> None:
+        """
+        Ensures the value object value is a valid IPv4 network.
+
+        Args:
+            value (str): Value.
+
+        Raises:
+            ValueError: If the value is not a valid IPv4 network.
+        """
+        self._ipv4_network_validate(value=value)
+
+    @classmethod
+    def _ipv4_network_validate(cls, value: str) -> IPv4Network:
+        """
+        Validates the given IPv4 network.
+
+        Args:
+            value (str): IPv4 network.
+
+        Raises:
+            ValueError: If the value is not a valid IPv4 network.
+            ValueError: If the value has an invalid netmask.
+
+        Returns:
+            IPv4Network: IPv4 network.
+        """
+        try:
+            return IPv4Network(address=value)
+
+        except NetmaskValueError as error:
+            raise ValueError(f'Ipv4NetworkValueObject value <<<{value}>>> has an invalid netmask.') from error
+
+        except (AddressValueError, ValueError) as error:
+            raise ValueError(f'Ipv4NetworkValueObject value <<<{value}>>> is not a valid IPv4 network.') from error
+
+    def get_network(self) -> Ipv4AddressValueObject:
+        """
+        Returns the network of the given IPv4 network.
+
+        Args:
+            value (str): IPv4 network.
+
+        Returns:
+            Ipv4AddressValueObject: The network IPv4 address.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+        ip = Ipv4NetworkValueObject(value='192.168.10.0/24').get_network()
+
+        print(repr(ip))
+        # >>> Ipv4AddressValueObject(value=192.168.10.0)
+        ```
+        """
+        return Ipv4AddressValueObject(value=str(object=self._ipv4_network_validate(value=self.value).network_address))
+
+    def get_broadcast(self) -> Ipv4AddressValueObject:
+        """
+        Returns the broadcast of the given IPv4 network.
+
+        Args:
+            value (str): IPv4 network.
+
+        Returns:
+            Ipv4AddressValueObject: The broadcast IPv4 address.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+        ip = Ipv4NetworkValueObject(value='192.168.10.0/24').get_broadcast()
+
+        print(repr(ip))
+        # >>> Ipv4AddressValueObject(value=192.168.10.255)
+        ```
+        """
+        return Ipv4AddressValueObject(value=str(object=self._ipv4_network_validate(value=self.value).broadcast_address))
+
+    def get_mask(self) -> int:
+        """
+        Returns the mask of the given IPv4 network.
+
+        Args:
+            value (str): IPv4 network.
+
+        Returns:
+            int: The network mask.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+        mask = Ipv4NetworkValueObject(value='192.168.10.0/24').get_mask()
+
+        print(mask)
+        # >>> 24
+        ```
+        """
+        return self._ipv4_network_validate(value=self.value).prefixlen
+
+    def get_number_addresses(self) -> int:
+        """
+        Returns the number of addresses of the given IPv4 network.
+
+        Args:
+            value (str): IPv4 network.
+
+        Returns:
+            int: The number of addresses.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+        addresses = Ipv4NetworkValueObject(value='192.168.10.0/24').get_number_addresses()
+
+        print(addresses)
+        # >>> 256
+        ```
+        """
+        return self._ipv4_network_validate(value=self.value).num_addresses

value_object_pattern/usables/internet/ipv6_address_value_object.py

@@ -0,0 +1,288 @@
+# ruff: noqa: N802
+"""
+Ipv6AddressValueObject value object.
+"""
+
+from __future__ import annotations
+
+from ipaddress import AddressValueError, IPv6Address
+
+from value_object_pattern.decorators import process, validation
+from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
+
+
+class Ipv6AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+    """
+    Ipv6AddressValueObject value object ensures the provided value is a valid IPv6 address.
+
+    Example:
+    ```python
+    from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+    ip = Ipv6AddressValueObject(value='e8f5:bbcf:f16d:8fc1:ab49:a3ae:36eb:b254')
+
+    print(repr(ip))
+    # >>> Ipv6AddressValueObject(value=e8f5:bbcf:f16d:8fc1:ab49:a3ae:36eb:b254)
+    ```
+    """
+
+    @process(order=0)
+    def _ensure_value_is_normalized(self, value: str) -> str:
+        """
+        Ensures the value object value is normalized IPv6 address.
+
+        Args:
+            value (str): Value.
+
+        Returns:
+            str: Value with the normalized IPv6 address.
+        """
+        value = self._ipv6_address_normalize(value=value)
+        return str(object=self._ipv6_address_validate(value=value))
+
+    @validation(order=0)
+    def _ensure_value_is_valid_ipv6_address(self, value: str) -> None:
+        """
+        Ensures the value object value is a valid IPv6 address.
+
+        Args:
+            value (str): Value.
+
+        Raises:
+            ValueError: If the value is not a valid IPv6 address.
+        """
+        value = self._ipv6_address_normalize(value=value)
+        self._ipv6_address_validate(value=value)
+
+    @classmethod
+    def _ipv6_address_normalize(cls, value: str) -> str:
+        """
+        Normalizes the given IPv6 address.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            str: Normalized IPv6 address.
+        """
+        if '/' in value and value.endswith('/128'):
+            value = value[:-4]
+
+        if value.startswith('[') and value.endswith(']'):
+            value = value[1:-1]
+
+        return value
+
+    @classmethod
+    def _ipv6_address_validate(cls, value: str) -> IPv6Address:
+        """
+        Validates the given IPv6 address.
+
+        Args:
+            value (str): IPv6 address.
+
+        Raises:
+            ValueError: If the value is not a valid IPv6 address.
+
+        Returns:
+            IPv6Address: IPv6 address.
+        """
+        try:
+            return IPv6Address(address=value)
+
+        except AddressValueError as error:
+            raise ValueError(f'Ipv6AddressValueObject value <<<{value}>>> is not a valid IPv6 address.') from error
+
+    def is_reserved(self) -> bool:
+        """
+        Checks if the given IPv6 address is reserved.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is reserved, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_reserved = Ipv6AddressValueObject(value='800::').is_reserved()
+
+        print(is_reserved)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_reserved
+
+    def is_private(self) -> bool:
+        """
+        Checks if the given IPv6 address is private.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is private, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_private = Ipv6AddressValueObject(value='fd00::1').is_private()
+
+        print(is_private)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_private
+
+    def is_global(self) -> bool:
+        """
+        Checks if the given IPv6 address is global.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is global, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_global = Ipv6AddressValueObject(value='e8f5:bbcf:f16d:8fc1:ab49:a3ae:36eb:b254').is_global()
+
+        print(is_global)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_global
+
+    def is_multicast(self) -> bool:
+        """
+        Checks if the given IPv6 address is multicast.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is multicast, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_multicast = Ipv6AddressValueObject(value='ff02::1').is_multicast()
+
+        print(is_multicast)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_multicast
+
+    def is_unspecified(self) -> bool:
+        """
+        Checks if the given IPv6 address is unspecified.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is unspecified, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_unspecified = Ipv6AddressValueObject(value='::').is_unspecified()
+
+        print(is_unspecified)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_unspecified
+
+    def is_loopback(self) -> bool:
+        """
+        Checks if the given IPv6 address is loopback.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is loopback, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_loopback = Ipv6AddressValueObject(value='::1').is_loopback()
+
+        print(is_loopback)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_loopback
+
+    def is_link_local(self) -> bool:
+        """
+        Checks if the given IPv6 address is link-local.
+
+        Args:
+            value (str): IPv6 address.
+
+        Returns:
+            bool: True if the given IPv6 address is link-local, False otherwise.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        is_link_local = Ipv6AddressValueObject(value='fe80::1').is_link_local()
+
+        print(is_link_local)
+        # >>> True
+        ```
+        """
+        return self._ipv6_address_validate(value=self.value).is_link_local
+
+    @classmethod
+    def UNSPECIFIED(cls) -> Ipv6AddressValueObject:
+        """
+        Returns the unspecified IPv6 address (::).
+
+        Returns:
+            Ipv6AddressValueObject: Unspecified IPv6 address.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        ip = Ipv6AddressValueObject.UNSPECIFIED()
+
+        print(repr(ip))
+        # >>> Ipv6AddressValueObject(value=::)
+        ```
+        """
+        return cls(value='::')
+
+    @classmethod
+    def LOOPBACK(cls) -> Ipv6AddressValueObject:
+        """
+        Returns the loopback IPv6 address (::1).
+
+        Returns:
+            Ipv6AddressValueObject: Loopback IPv6 address.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6AddressValueObject
+
+        ip = Ipv6AddressValueObject.LOOPBACK()
+
+        print(repr(ip))
+        # >>> Ipv6AddressValueObject(value=::1)
+        ```
+        """
+        return cls(value='::1')

value_object_pattern/usables/internet/ipv6_network_value_object.py

@@ -0,0 +1,145 @@
+# ruff: noqa: N802
+"""
+Ipv6NetworkValueObject value object.
+"""
+
+from ipaddress import AddressValueError, IPv6Network, NetmaskValueError
+
+from value_object_pattern.decorators import process, validation
+from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
+
+from .ipv6_address_value_object import Ipv6AddressValueObject
+
+
+class Ipv6NetworkValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
+    """
+    Ipv6NetworkValueObject value object ensures the provided value is a valid IPv6 network.
+
+    Example:
+    ```python
+    from value_object_pattern.usables.internet import Ipv6NetworkValueObject
+
+    network = Ipv6NetworkValueObject(value='e8f5:bbcf:f16d:8fc1:ab49:a3ae:36eb:b254')
+
+    print(repr(network))
+    # >>> Ipv6NetworkValueObject(value=e8f5:bbcf:f16d:8fc1:ab49:a3ae:36eb:b254/128)
+    ```
+    """
+
+    @process(order=0)
+    def _ensure_value_is_normalized(self, value: str) -> str:
+        """
+        Ensures the value object value is normalized IPv6 network.
+
+        Args:
+            value (str): Value.
+
+        Returns:
+            str: Value with the normalized IPv6 network.
+        """
+        return str(object=IPv6Network(address=value))
+
+    @validation(order=0)
+    def _ensure_value_is_valid_ipv6_network(self, value: str) -> None:
+        """
+        Ensures the value object value is a valid IPv6 network.
+
+        Args:
+            value (str): Value.
+
+        Raises:
+            ValueError: If the value is not a valid IPv6 network.
+        """
+        self._ipv6_network_validate(value=value)
+
+    @classmethod
+    def _ipv6_network_validate(cls, value: str) -> IPv6Network:
+        """
+        Validates the given IPv6 network.
+
+        Args:
+            value (str): IPv6 network.
+
+        Raises:
+            ValueError: If the value is not a valid IPv6 network.
+            ValueError: If the value has an invalid netmask.
+
+        Returns:
+            IPv6Network: IPv6 network.
+        """
+        try:
+            return IPv6Network(address=value)
+
+        except NetmaskValueError as error:
+            raise ValueError(f'Ipv6NetworkValueObject value <<<{value}>>> has an invalid netmask.') from error
+
+        except (AddressValueError, ValueError) as error:
+            raise ValueError(f'Ipv6NetworkValueObject value <<<{value}>>> is not a valid IPv6 network.') from error
+
+    def get_network(self) -> Ipv6AddressValueObject:
+        """
+        Returns the network of the given IPv6 network.
+
+        Args:
+            value (str): IPv6 network.
+
+        Returns:
+            Ipv6AddressValueObject: The network IPv6 address.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6NetworkValueObject
+
+        ip = Ipv6NetworkValueObject(value='fd5b:207::/48').get_network()
+
+        print(repr(ip))
+        # >>> Ipv6AddressValueObject(value=fd5b:207::)
+        ```
+        """
+        return Ipv6AddressValueObject(value=str(object=self._ipv6_network_validate(value=self.value).network_address))
+
+    def get_mask(self) -> int:
+        """
+        Returns the mask of the given IPv6 network.
+
+        Args:
+            value (str): IPv6 network.
+
+        Returns:
+            int: The network mask.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6NetworkValueObject
+
+        mask = Ipv6NetworkValueObject(value='fd5b:207::/48').get_mask()
+
+        print(mask)
+        # >>> 48
+        ```
+        """
+        return self._ipv6_network_validate(value=self.value).prefixlen
+
+    def get_number_addresses(self) -> int:
+        """
+        Returns the number of addresses of the given IPv6 network.
+
+        Args:
+            value (str): IPv6 network.
+
+        Returns:
+            int: The number of addresses.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv6NetworkValueObject
+
+        addresses = Ipv6NetworkValueObject(value='fd5b:207::/48').get_number_addresses()
+
+        print(addresses)
+        # >>> 1208925819614629174706176
+        ```
+        """
+        return self._ipv6_network_validate(value=self.value).num_addresses
+
+    # TODO: def get_addresses(self) -> list[Ipv6AddressValueObject]: