value-object-pattern 1.2.0__tar.gz → 1.4.0__tar.gz

{value_object_pattern-1.2.0 → value_object_pattern-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.2.0
+Version: 1.4.0
 Summary: The Value Object Pattern is a Python package that streamlines the creation and management of value objects in your projects.
 Project-URL: Homepage, https://github.com/adriamontoto/value-object-pattern
 Project-URL: Repository, https://github.com/adriamontoto/value-object-pattern

{value_object_pattern-1.2.0 → value_object_pattern-1.4.0}/value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.2.0'
+__version__ = '1.4.0'
 
 from .decorators import process, validation
 from .models import BaseModel, EnumerationValueObject, ValueObject

{value_object_pattern-1.2.0 → value_object_pattern-1.4.0}/value_object_pattern/models/value_object.py

@@ -11,7 +11,7 @@ else:
 
 from abc import ABC
 from collections import deque
-from typing import Any, Callable, Generic, NoReturn, TypeVar
+from typing import Any, Callable, Generic, TypeVar
 
 T = TypeVar('T')
 
@@ -215,7 +215,7 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
         return self._value == other.value
 
     @override
-    def __setattr__(self, key: str, value: T) -> NoReturn:
+    def __setattr__(self, key: str, value: T) -> None:
         """
         Prevents modification or addition of attributes in the value object.
 
@@ -230,6 +230,12 @@ class ValueObject(ABC, Generic[T]):  # noqa: UP046
         public_key = key.replace('_', '')
         public_slots1 = [slot.replace('_', '') for slot in self.__slots__]
 
+        if key.startswith('_internal_'):
+            # Allow internal attributes to be set, but not modified, those attributes should not be used outside the
+            # class, they are used for improving performance
+            object.__setattr__(self, key, value)
+            return
+
         if key in self.__slots__:
             raise AttributeError(f'Cannot modify attribute "{key}" of immutable instance.')
 

{value_object_pattern-1.2.0 → value_object_pattern-1.4.0}/value_object_pattern/usables/internet/aws_cloud_region_value_object.py

@@ -2,6 +2,8 @@
 AwsCloudRegionValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern import process, validation
 from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
 
@@ -19,9 +21,8 @@ class AwsCloudRegionValueObject(NotEmptyStringValueObject, TrimmedStringValueObj
     ```python
     from value_object_pattern.usables.internet import AwsCloudRegionValueObject
 
-    key = AwsCloudRegionValueObject(value='us-east-1')
-
-    print(repr(key))
+    region = AwsCloudRegionValueObject(value='us-east-1')
+    print(repr(region))
     # >>> AwsCloudRegionValueObject(value=us-east-1)
     ```
     """
@@ -51,4 +52,16 @@ class AwsCloudRegionValueObject(NotEmptyStringValueObject, TrimmedStringValueObj
             ValueError: If the region does not exist.
         """
         if value not in get_aws_cloud_regions():
-            raise ValueError(f'AwsCloudRegionValueObject value <<<{value}>>> does not exist.')
+            self._raise_value_is_not_valid_aws_cloud_region(value=value)
+
+    def _raise_value_is_not_valid_aws_cloud_region(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value is not a valid AWS cloud region.
+
+        Args:
+            value (str): The invalid AWS cloud region value.
+
+        Raises:
+            ValueError: If the value is not a valid AWS cloud region.
+        """
+        raise ValueError(f'AwsCloudRegionValueObject value <<<{value}>>> is not a valid AWS cloud region.')

{value_object_pattern-1.2.0 → value_object_pattern-1.4.0}/value_object_pattern/usables/internet/domain_value_object.py

@@ -21,9 +21,8 @@ class DomainValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
     ```python
     from value_object_pattern.usables.internet import DomainValueObject
 
-    key = DomainValueObject(value='github.com')
-
-    print(repr(key))
+    domain = DomainValueObject(value='github.com')
+    print(repr(domain))
     # >>> DomainValueObject(value=github.com)
     ```
     """
@@ -74,7 +73,7 @@ class DomainValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             raise ValueError(f'DomainValueObject value <<<{value}>>> has not a valid top level domain.')
 
         tdl = value.lower().rstrip('.').split(sep='.')[-1]
-        if tdl not in get_tld_dict()[len(tdl)]:
+        if tdl not in get_tld_dict():
             raise ValueError(f'DomainValueObject value <<<{value}>>> has not a valid top level domain <<<{tdl}>>>.')
 
     @validation(order=1)

{value_object_pattern-1.2.0 → value_object_pattern-1.4.0}/value_object_pattern/usables/internet/ipv4_address_value_object.py

@@ -5,7 +5,7 @@ Ipv4AddressValueObject value object.
 
 from __future__ import annotations
 
-from ipaddress import AddressValueError, IPv4Address
+from ipaddress import IPv4Address
 
 from value_object_pattern.decorators import process, validation
 from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
@@ -20,12 +20,13 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
     from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
     ip = Ipv4AddressValueObject(value='66.162.207.81')
-
     print(repr(ip))
     # >>> Ipv4AddressValueObject(value=66.162.207.81)
     ```
     """
 
+    _internal_ip_object: IPv4Address
+
     @process(order=0)
     def _ensure_value_is_normalized(self, value: str) -> str:
         """
@@ -37,7 +38,9 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         Returns:
             str: Value with the normalized IPv4 address.
         """
-        value = self._ipv4_address_normalize(value=value)
+        if '/' in value and value.endswith('/32'):
+            value = value[:-3]
+
         return str(object=IPv4Address(address=value))
 
     @validation(order=0)
@@ -51,44 +54,25 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         Raises:
             ValueError: If the value is not a valid IPv4 address.
         """
-        value = self._ipv4_address_normalize(value=value)
-        self._ipv4_address_validate(value=value)
+        processed_value = self._ensure_value_is_normalized(value=value)
 
-    @classmethod
-    def _ipv4_address_normalize(cls, value: str) -> str:
-        """
-        Normalizes the given IPv4 address.
-
-        Args:
-            value (str): IPv4 address.
-
-        Returns:
-            str: Normalized IPv4 address.
-        """
-        if '/' in value and value.endswith('/32'):
-            value = value[:-3]
+        try:
+            self._internal_ip_object = IPv4Address(address=processed_value)
 
-        return value
+        except Exception:
+            self._raise_value_is_not_valid_ipv4_address(value=value)
 
-    @classmethod
-    def _ipv4_address_validate(cls, value: str) -> IPv4Address:
+    def _raise_value_is_not_valid_ipv4_address(self, value: str) -> None:
         """
-        Validates the given IPv4 address.
+        Raises a ValueError if the value is not a valid IPv4 address.
 
         Args:
-            value (str): IPv4 address.
+            value (str): Value.
 
         Raises:
             ValueError: If the value is not a valid IPv4 address.
-
-        Returns:
-            IPv4Address: IPv4 address.
         """
-        try:
-            return IPv4Address(address=value)
-
-        except AddressValueError as error:
-            raise ValueError(f'Ipv4AddressValueObject value <<<{value}>>> is not a valid IPv4 address.') from error
+        raise ValueError(f'Ipv4AddressValueObject value <<<{value}>>> is not a valid IPv4 address.')
 
     def is_reserved(self) -> bool:
         """
@@ -104,13 +88,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_reserved = Ipv4AddressValueObject(value='240.0.0.0').is_reserved()
-
-        print(is_reserved)
+        ip = Ipv4AddressValueObject(value='240.0.0.0')
+        print(ip.is_reserved())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_reserved
+        return self._internal_ip_object.is_reserved
 
     def is_private(self) -> bool:
         """
@@ -126,13 +109,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_private = Ipv4AddressValueObject(value='192.168.10.4').is_private()
-
-        print(is_private)
+        ip = Ipv4AddressValueObject(value='192.168.10.4')
+        print(ip.is_private())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_private
+        return self._internal_ip_object.is_private
 
     def is_global(self) -> bool:
         """
@@ -148,13 +130,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_global = Ipv4AddressValueObject(value='66.162.207.81').is_global()
-
-        print(is_global)
+        ip = Ipv4AddressValueObject(value='66.162.207.81')
+        print(ip.is_global())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_global
+        return self._internal_ip_object.is_global
 
     def is_multicast(self) -> bool:
         """
@@ -170,13 +151,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_multicast = Ipv4AddressValueObject(value='224.0.0.1').is_multicast()
-
-        print(is_multicast)
+        ip = Ipv4AddressValueObject(value='224.0.0.1')
+        print(ip.is_multicast())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_multicast
+        return self._internal_ip_object.is_multicast
 
     def is_unspecified(self) -> bool:
         """
@@ -192,13 +172,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_unspecified = Ipv4AddressValueObject(value='0.0.0.0').is_unspecified()
-
-        print(is_unspecified)
+        ip = Ipv4AddressValueObject(value='0.0.0.0')
+        print(ip.is_unspecified())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_unspecified
+        return self._internal_ip_object.is_unspecified
 
     def is_loopback(self) -> bool:
         """
@@ -214,13 +193,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_loopback = Ipv4AddressValueObject(value='127.0.0.1').is_loopback()
-
-        print(is_loopback)
+        ip = Ipv4AddressValueObject(value='127.0.0.1')
+        print(ip.is_loopback())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_loopback
+        return self._internal_ip_object.is_loopback
 
     def is_link_local(self) -> bool:
         """
@@ -236,13 +214,12 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         ```python
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
-        is_link_local = Ipv4AddressValueObject(value='169.254.0.0').is_link_local()
-
-        print(is_link_local)
+        ip = Ipv4AddressValueObject(value='169.254.0.0')
+        print(ip.is_link_local())
         # >>> True
         ```
         """
-        return self._ipv4_address_validate(value=self.value).is_link_local
+        return self._internal_ip_object.is_link_local
 
     @classmethod
     def UNSPECIFIED(cls) -> Ipv4AddressValueObject:
@@ -257,7 +234,6 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
         ip = Ipv4AddressValueObject.UNSPECIFIED()
-
         print(repr(ip))
         # >>> Ipv4AddressValueObject(value=0.0.0.0)
         ```
@@ -277,7 +253,6 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
         ip = Ipv4AddressValueObject.LOOPBACK()
-
         print(repr(ip))
         # >>> Ipv4AddressValueObject(value=127.0.0.1)
         ```
@@ -297,7 +272,6 @@ class Ipv4AddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObject
         from value_object_pattern.usables.internet import Ipv4AddressValueObject
 
         ip = Ipv4AddressValueObject.BROADCAST()
-
         print(repr(ip))
         # >>> Ipv4AddressValueObject(value=255.255.255.255)
         ```

value_object_pattern-1.4.0/value_object_pattern/usables/internet/ipv4_network_value_object.py

@@ -0,0 +1,223 @@
+# ruff: noqa: N802
+"""
+Ipv4NetworkValueObject value object.
+"""
+
+from ipaddress import IPv4Network, NetmaskValueError
+from typing import Generator, NoReturn
+
+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)
+    ```
+    """
+
+    _internal_network_object: IPv4Network
+
+    @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 does not have a valid netmask.
+            ValueError: If the value is not a valid IPv4 network.
+        """
+        try:
+            self._internal_network_object = IPv4Network(address=value)
+
+        except NetmaskValueError:
+            self._raise_value_has_not_a_valid_netmask(value=value)
+
+        except Exception:
+            self._raise_value_is_not_ipv4_network(value=value)
+
+    def _raise_value_has_not_a_valid_netmask(self, value: str) -> NoReturn:
+        """
+        Raises a ValueError if the value does not have a valid netmask.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the value does not have a valid netmask.
+        """
+        raise ValueError(f'Ipv4NetworkValueObject value <<<{value}>>> has an invalid netmask.')
+
+    def _raise_value_is_not_ipv4_network(self, value: str) -> NoReturn:
+        """
+        Raises a TypeError if the value is not a valid IPv4 network.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            TypeError: If the value is not a valid IPv4 network.
+        """
+        raise ValueError(f'Ipv4NetworkValueObject value <<<{value}>>> is not a valid IPv4 network.')
+
+    def hosts(self) -> Generator[Ipv4AddressValueObject, None, None]:  # noqa: UP043
+        """
+        Returns an iterator over the addresses of the given IPv4 network excluding the network and broadcast addresses.
+        If you want to iterate over all the addresses including the network and broadcast addresses, use the
+        `all_addresses` method.
+
+        Returns:
+            Generator[Ipv4AddressValueObject, None, None]: Iterator of IP addresses.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+        network = Ipv4NetworkValueObject(value='192.168.10.0/24')
+        for address in network.hosts():
+            print(repr(address))
+        # >>> Ipv4AddressValueObject(value='192.168.10.1')
+        # >>> Ipv4AddressValueObject(value='192.168.10.2')
+        # >>> ...
+        # >>> Ipv4AddressValueObject(value='192.168.10.253')
+        # >>> Ipv4AddressValueObject(value='192.168.10.254')
+        ```
+        """
+        for address in self._internal_network_object.hosts():
+            yield Ipv4AddressValueObject(value=str(object=address))
+
+    def all_addresses(self) -> Generator[Ipv4AddressValueObject, None, None]:  # noqa: UP043
+        """
+        Returns an iterator over all the addresses of the given IPv4 network, including the network and broadcast
+        addresses. If you want to iterate over the addresses excluding the network and broadcast addresses,
+        use the `hosts` method.
+
+        Returns:
+            Generator[Ipv4AddressValueObject, None, None]: Iterator of IP addresses.
+
+        Example:
+        ```python
+        from value_object_pattern.usables.internet import Ipv4NetworkValueObject
+
+        network = Ipv4NetworkValueObject(value='192.168.10.0/24')
+        for address in network.all_addresses():
+            print(repr(address))
+        # >>> Ipv4AddressValueObject(value='192.168.10.0')
+        # >>> Ipv4AddressValueObject(value='192.168.10.1')
+        # >>> ...
+        # >>> Ipv4AddressValueObject(value='192.168.10.254')
+        # >>> Ipv4AddressValueObject(value='192.168.10.255')
+        ```
+        """
+        for address in self._internal_network_object:
+            yield Ipv4AddressValueObject(value=str(address))
+
+    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
+
+        network = Ipv4NetworkValueObject(value='192.168.10.0/24')
+        print(repr(network.get_network()))
+        # >>> Ipv4AddressValueObject(value=192.168.10.0)
+        ```
+        """
+        return Ipv4AddressValueObject(value=str(object=self._internal_network_object.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
+
+        network = Ipv4NetworkValueObject(value='192.168.10.0/24')
+        print(repr(network.get_broadcast()))
+        # >>> Ipv4AddressValueObject(value=192.168.10.255)
+        ```
+        """
+        return Ipv4AddressValueObject(value=str(object=self._internal_network_object.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
+
+        network = Ipv4NetworkValueObject(value='192.168.10.0/24')
+        print(network.get_mask())
+        # >>> 24
+        ```
+        """
+        return self._internal_network_object.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
+
+        network = Ipv4NetworkValueObject(value='192.168.10.0/24')
+        print(network.get_number_addresses())
+        # >>> 256
+        ```
+        """
+        return self._internal_network_object.num_addresses