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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.2.0
+Version: 1.3.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.3.0}/value_object_pattern/__init__.py

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

{value_object_pattern-1.2.0 → value_object_pattern-1.3.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.3.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.3.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.3.0}/value_object_pattern/usables/internet/port_value_object.py

@@ -5,6 +5,8 @@ PortValueObject value object.
 
 from __future__ import annotations
 
+from typing import NoReturn
+
 from value_object_pattern.decorators import validation
 from value_object_pattern.usables import IntegerValueObject
 
@@ -18,7 +20,6 @@ class PortValueObject(IntegerValueObject):
     from value_object_pattern.usables.internet import PortValueObject
 
     port = PortValueObject(value=443)
-
     print(repr(port))
     # >>> PortValueObject(value=443)
     ```
@@ -39,7 +40,19 @@ class PortValueObject(IntegerValueObject):
             ValueError: If the `value` is not a valid port.
         """
         if value < self._PORT_MIN_PORT or value > self._PORT_MAX_PORT:
-            raise ValueError(f'PortValueObject value <<<{value}>>> must be between {self._PORT_MIN_PORT} and {self._PORT_MAX_PORT}.')  # noqa: E501  # fmt: skip
+            self._raise_value_is_not_port(value=value)
+
+    def _raise_value_is_not_port(self, value: int) -> NoReturn:
+        """
+        Raises a ValueError if the value object `value` is not a valid port.
+
+        Args:
+            value (int): The provided value.
+
+        Raises:
+            ValueError: If the `value` is not a valid port.
+        """
+        raise ValueError(f'PortValueObject value <<<{value}>>> must be between {self._PORT_MIN_PORT} and {self._PORT_MAX_PORT}.')  # noqa: E501  # fmt: skip
 
     @classmethod
     def system_ports(cls) -> tuple[PortValueObject, PortValueObject]:
@@ -57,7 +70,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         system_ports = PortValueObject.system_ports()
-
         print(repr(system_ports))
         # >>> (PortValueObject(value=0), PortValueObject(value=1023))
         ```
@@ -80,7 +92,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         user_ports = PortValueObject.user_ports()
-
         print(repr(user_ports))
         # >>> (PortValueObject(value=1024), PortValueObject(value=49151))
         ```
@@ -123,7 +134,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.FTP_DATA()
-
         print(repr(port))
         # >>> PortValueObject(value=20)
         ```
@@ -143,7 +153,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.FTP_DATA()
-
         print(repr(port))
         # >>> PortValueObject(value=21)
         ```
@@ -163,7 +172,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.SSH()
-
         print(repr(port))
         # >>> PortValueObject(value=22)
         ```
@@ -183,7 +191,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.TELNET()
-
         print(repr(port))
         # >>> PortValueObject(value=23)
         ```
@@ -203,7 +210,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.SMTP()
-
         print(repr(port))
         # >>> PortValueObject(value=25)
         ```
@@ -223,7 +229,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.DNS()
-
         print(repr(port))
         # >>> PortValueObject(value=53)
         ```
@@ -243,7 +248,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.DHCP_SERVER()
-
         print(repr(port))
         # >>> PortValueObject(value=67)
         ```
@@ -263,7 +267,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.DHCP_CLIENT()
-
         print(repr(port))
         # >>> PortValueObject(value=68)
         ```
@@ -283,7 +286,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.HTTP()
-
         print(repr(port))
         # >>> PortValueObject(value=80)
         ```
@@ -303,7 +305,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.POP3()
-
         print(repr(port))
         # >>> PortValueObject(value=110)
         ```
@@ -323,7 +324,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.NTP()
-
         print(repr(port))
         # >>> PortValueObject(value=123)
         ```
@@ -343,7 +343,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.IMAP()
-
         print(repr(port))
         # >>> PortValueObject(value=143)
         ```
@@ -363,7 +362,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.SNMP_MONITOR()
-
         print(repr(port))
         # >>> PortValueObject(value=161)
         ```
@@ -383,7 +381,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.SNMP_TRAP()
-
         print(repr(port))
         # >>> PortValueObject(value=162)
         ```
@@ -403,7 +400,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.LDAP()
-
         print(repr(port))
         # >>> PortValueObject(value=389)
         ```
@@ -423,7 +419,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.HTTPS()
-
         print(repr(port))
         # >>> PortValueObject(value=443)
         ```
@@ -443,7 +438,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.DoH()
-
         print(repr(port))
         # >>> PortValueObject(value=443)
         ```
@@ -463,7 +457,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.SMTPS()
-
         print(repr(port))
         # >>> PortValueObject(value=465)
         ```
@@ -483,7 +476,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.DoT()
-
         print(repr(port))
         # >>> PortValueObject(value=853)
         ```
@@ -503,7 +495,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.IMAPS()
-
         print(repr(port))
         # >>> PortValueObject(value=993)
         ```
@@ -523,7 +514,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.POP3S()
-
         print(repr(port))
         # >>> PortValueObject(value=995)
         ```
@@ -543,7 +533,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.OPENVPN()
-
         print(repr(port))
         # >>> PortValueObject(value=1194)
         ```
@@ -563,7 +552,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.MICROSOFT_SQL_SERVER()
-
         print(repr(port))
         # >>> PortValueObject(value=1433)
         ```
@@ -583,7 +571,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.ORACLE()
-
         print(repr(port))
         # >>> PortValueObject(value=1521)
         ```
@@ -603,7 +590,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.MYSQL()
-
         print(repr(port))
         # >>> PortValueObject(value=3306)
         ```
@@ -623,7 +609,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.MARIADB()
-
         print(repr(port))
         # >>> PortValueObject(value=3306)
         ```
@@ -643,7 +628,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.RDP()
-
         print(repr(port))
         # >>> PortValueObject(value=3389)
         ```
@@ -663,7 +647,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.POSTGRESQL()
-
         print(repr(port))
         # >>> PortValueObject(value=5432)
         ```
@@ -683,7 +666,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.REDIS()
-
         print(repr(port))
         # >>> PortValueObject(value=6379)
         ```
@@ -703,7 +685,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.MINECRAFT()
-
         print(repr(port))
         # >>> PortValueObject(value=25565)
         ```
@@ -723,7 +704,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.MONGODB()
-
         print(repr(port))
         # >>> PortValueObject(value=27017)
         ```
@@ -743,7 +723,6 @@ class PortValueObject(IntegerValueObject):
         from value_object_pattern.usables.internet import PortValueObject
 
         port = PortValueObject.WIREGUARD()
-
         print(repr(port))
         # >>> PortValueObject(value=51820)
         ```

{value_object_pattern-1.2.0 → value_object_pattern-1.3.0}/value_object_pattern/usables/internet/utils/__init__.py

@@ -21,23 +21,18 @@ def get_aws_cloud_regions() -> tuple[str, ...]:
 
 
 @lru_cache(maxsize=1)
-def get_tld_dict() -> dict[int, tuple[str, ...]]:
+def get_tld_dict() -> tuple[str, ...]:
     """
-    Get top level domains from IANA in a dictionary sorted by domain length.
+    Get top level domains from IANA in a dictionary.
 
     Returns:
-        dict[int, tuple[str, ...]]: The top level domains in lower case sorted by domain length.
+        tuple[str, ...]: The top-level domains in lower case.
 
     References:
         TLD Domains: https://data.iana.org/TLD/tlds-alpha-by-domain.txt
     """
     with files(anchor='value_object_pattern.usables.internet.utils').joinpath('tld_domains.txt').open(mode='r') as file:
         lines = file.read().splitlines()
+        filtered_lines = tuple(line for line in lines if not line.startswith('#') and (_line := line.strip().lower()))
 
-    temp: dict[int, list[str]] = {}
-    tlds = tuple(line for line in lines if not line.startswith('#') and (_line := line.strip().lower()))
-    for tld in tlds:
-        key = len(tld)
-        temp.setdefault(key, []).append(tld)
-
-    return {key: tuple(value) for key, value in temp.items()}
+    return filtered_lines