value-object-pattern 1.32.0__tar.gz → 1.33.1__tar.gz

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.32.0
+Version: 1.33.1
 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.32.0 → value_object_pattern-1.33.1}/value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.32.0'
+__version__ = '1.33.1'
 
 from .decorators import process, validation
 from .models import BaseModel, EnumerationValueObject, UnionValueObject, ValueObject

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/__init__.py

@@ -1,4 +1,5 @@
 from .aws_cloud_region_value_object import AwsCloudRegionValueObject
+from .domain_or_localhost_value_object import DomainOrLocalhostValueObject
 from .domain_value_object import DomainValueObject
 from .email_address_value_object import EmailAddressValueObject
 from .host_value_object import HostValueObject
@@ -16,6 +17,7 @@ from .user_agent_value_object import UserAgentValueObject
 
 __all__ = (
     'AwsCloudRegionValueObject',
+    'DomainOrLocalhostValueObject',
     'DomainValueObject',
     'EmailAddressValueObject',
     'HostValueObject',

value_object_pattern-1.33.1/value_object_pattern/usables/internet/domain_or_localhost_value_object.py

@@ -0,0 +1,22 @@
+"""
+DomainOrLocalhostValueObject value object.
+"""
+
+from .domain_value_object import DomainValueObject
+
+
+class DomainOrLocalhostValueObject(DomainValueObject):
+    """
+    DomainOrLocalhostValueObject ensures the provided value is a valid domain or localhost.
+
+    Example:
+    ```python
+    from value_object_pattern.usables.internet import DomainOrLocalhostValueObject
+
+    domain = DomainOrLocalhostValueObject(value='localhost')
+    print(repr(domain))
+    # >>> DomainOrLocalhostValueObject(value=localhost)
+    ```
+    """
+
+    _DOMAIN_VALID_SINGLE_LABELS: frozenset[str] = frozenset({'localhost'})

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/domain_value_object.py

@@ -32,6 +32,7 @@ class DomainValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
     _DOMAIN_MAX_LABEL_LENGTH: int = 63
     _DOMAIN_MAX_DOMAIN_LENGTH: int = 253
     _DOMAIN_REGEX: Pattern[str] = re_compile(pattern=r'[0-9a-zA-Z-]+')
+    _DOMAIN_VALID_SINGLE_LABELS: frozenset[str] = frozenset()
 
     @process(order=0)
     def _ensure_domain_is_in_lowercase(self, value: str) -> str:
@@ -72,7 +73,10 @@ class DomainValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             ValueError: If domain value has not a valid top level domain.
         """
         if '.' not in processed_value:
-            self._raise_value_has_not_valid_top_level_domain(value=value)
+            if processed_value not in self._DOMAIN_VALID_SINGLE_LABELS:
+                self._raise_value_has_not_valid_top_level_domain(value=value)
+
+            return
 
         tdl = processed_value.split(sep='.')[-1]
         if tdl not in get_tld_dict():

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/email_address_value_object.py

@@ -214,8 +214,7 @@ class EmailAddressValueObject(NotEmptyStringValueObject, TrimmedStringValueObjec
         try:
             self._internal_domain_part = DomainValueObject(value=self._internal_domain_part).value
 
-        except Exception as exception:
-            print(f'{exception}')
+        except (TypeError, ValueError):
             self._raise_value_invalid_domain_error(value=value, domain_part=self._internal_domain_part)
 
     def _raise_email_address_domain_contains_invalid_characters_error(self, value: str, domain_part: str) -> NoReturn:

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/host_value_object.py

@@ -7,7 +7,7 @@ from typing import NoReturn
 from value_object_pattern import process, validation
 from value_object_pattern.usables import NotEmptyStringValueObject, TrimmedStringValueObject
 
-from .domain_value_object import DomainValueObject
+from .domain_or_localhost_value_object import DomainOrLocalhostValueObject
 from .ipv4_address_value_object import Ipv4AddressValueObject
 from .ipv6_address_value_object import Ipv6AddressValueObject
 
@@ -38,7 +38,7 @@ class HostValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             str: The host value stored in respective format.
         """
         if self._is_domain(value=value):
-            return DomainValueObject(value=value).value
+            return DomainOrLocalhostValueObject(value=value).value
 
         if self._is_ipv4_address(value=value):
             return Ipv4AddressValueObject(value=value).value
@@ -104,7 +104,7 @@ class HostValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             bool: True if the value is a domain, False otherwise.
         """
         try:
-            DomainValueObject(value=value)
+            DomainOrLocalhostValueObject(value=value)
             return True
 
         except (TypeError, ValueError):

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/uri/http_https_url_value_object.py

@@ -2,6 +2,8 @@
 HttpHttpsUrlValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern import validation
 
 from .url_value_object import UrlValueObject, split_url
@@ -36,4 +38,17 @@ class HttpHttpsUrlValueObject(UrlValueObject):
         scheme, *_ = split_url(value=value)
 
         if scheme not in ('http', 'https'):
-            raise ValueError(f'HttpHttpsUrlValueObject value <<<{value}>>> scheme is not HTTP or HTTPS')
+            self._raise_value_is_not_http_https_url(value=value, scheme=scheme)
+
+    def _raise_value_is_not_http_https_url(self, value: str, scheme: str) -> NoReturn:
+        """
+        Raise an error if the URL scheme is not HTTP or HTTPS.
+
+        Args:
+            value (str): The URL value.
+            scheme (str): The invalid scheme.
+
+        Raises:
+            ValueError: If the URL scheme is not HTTP or HTTPS.
+        """
+        raise ValueError(f'HttpHttpsUrlValueObject value <<<{value}>>> scheme is not HTTP or HTTPS')

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/uri/https_url_value_object.py

@@ -2,6 +2,8 @@
 HttpsUrlValueObject value object.
 """
 
+from typing import NoReturn
+
 from value_object_pattern import validation
 
 from .url_value_object import UrlValueObject, split_url
@@ -36,4 +38,17 @@ class HttpsUrlValueObject(UrlValueObject):
         scheme, *_ = split_url(value=value)
 
         if scheme != 'https':
-            raise ValueError(f'HttpsUrlValueObject value <<<{value}>>> scheme is not HTTPS')
+            self._raise_value_is_not_https_url(value=value, scheme=scheme)
+
+    def _raise_value_is_not_https_url(self, value: str, scheme: str) -> NoReturn:
+        """
+        Raise an error if the URL scheme is not HTTPS.
+
+        Args:
+            value (str): The URL value.
+            scheme (str): The invalid scheme.
+
+        Raises:
+            ValueError: If the URL scheme is not HTTPS.
+        """
+        raise ValueError(f'HttpsUrlValueObject value <<<{value}>>> scheme is not HTTPS')

{value_object_pattern-1.32.0 → value_object_pattern-1.33.1}/value_object_pattern/usables/internet/uri/url_value_object.py

@@ -4,6 +4,7 @@ UrlValueObject value object.
 
 from functools import lru_cache
 from re import Pattern, compile as re_compile
+from typing import NoReturn
 from urllib.parse import parse_qs, urlsplit
 
 from value_object_pattern import process, validation
@@ -37,6 +38,9 @@ def join_url(
     Returns:
         str: The URL joined.
     """
+    if ':' in host and not host.startswith('['):
+        host = f'[{host}]'
+
     netloc = host
     if user_information:
         netloc = f'{user_information}@{netloc}'
@@ -88,9 +92,18 @@ def split_netloc(value: str) -> tuple[str | None, str, int | None]:
         # prevent splitting passwords with @
         user_information, host_port = value.rsplit(sep='@', maxsplit=1)
 
+    if host_port.startswith('['):
+        host, _, port_string = host_port[1:].partition(']')
+        if port_string:
+            port = int(port_string.removeprefix(':'))
+
+        return user_information, host, port
+
+    if host_port.count(':') > 1:
+        raise ValueError('IPv6 URL hosts must be enclosed in brackets.')
+
     host = host_port
-    if ':' in host_port and host_port.count(':') == 1:
-        # prevent splitting IPv6 addresses
+    if ':' in host_port:
         host, port_string = host_port.rsplit(sep=':', maxsplit=1)
         port = int(port_string)
 
@@ -166,11 +179,23 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
         try:
             scheme, netloc, path, query, fragment = split_url(value=value)
 
-        except ValueError as error:
-            raise ValueError(f'UrlValueObject value <<<{value}>>> is not a valid url.') from error
+        except ValueError:
+            self._raise_value_is_not_valid_url(value=value)
 
         if not scheme and not netloc and not path and not query and not fragment:
-            raise ValueError(f'UrlValueObject value <<<{value}>>> is not a valid url.')
+            self._raise_value_is_not_valid_url(value=value)
+
+    def _raise_value_is_not_valid_url(self, value: str) -> NoReturn:
+        """
+        Raise an error if the value is not a valid URL.
+
+        Args:
+            value (str): The invalid URL value.
+
+        Raises:
+            ValueError: If the value is not a valid URL.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> is not a valid url.')
 
     @validation(order=1)
     def _validate_url_scheme(self, value: str) -> None:
@@ -188,7 +213,20 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
         """
         scheme, *_ = split_url(value=value)
         if not self._URL_SCHEME_REGEX.match(string=scheme):
-            raise ValueError(f'UrlValueObject value <<<{value}>>> contains an invalid scheme <<<{scheme}>>>.')
+            self._raise_value_has_not_valid_scheme(value=value, scheme=scheme)
+
+    def _raise_value_has_not_valid_scheme(self, value: str, scheme: str) -> NoReturn:
+        """
+        Raise an error if the URL scheme is invalid.
+
+        Args:
+            value (str): The URL value.
+            scheme (str): The invalid scheme.
+
+        Raises:
+            ValueError: If the URL scheme is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> contains an invalid scheme <<<{scheme}>>>.')
 
     @validation(order=2)
     def _validate_url_netloc(self, value: str) -> None:
@@ -207,23 +245,70 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             https://www.rfc-editor.org/rfc/rfc3986#section-3.2.3
         """
         _, netloc, *_ = split_url(value=value)
-        user_information, host, port = split_netloc(value=netloc)
+        try:
+            user_information, host, port = split_netloc(value=netloc)
+
+        except ValueError:
+            if netloc.count(':') > 1 and not netloc.startswith('['):
+                self._raise_value_is_not_valid_url(value=value)
+
+            invalid_port = netloc.rsplit(sep=':', maxsplit=1)[-1]
+            self._raise_value_has_not_valid_port(value=value, port=invalid_port)
 
         if user_information is not None and not self._URL_USER_INFORMATION_REGEX.match(string=user_information):  # noqa: E501  # fmt: skip
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid user information <<<{user_information}>>>.')  # noqa: E501  # fmt: skip
+            self._raise_value_has_not_valid_user_information(value=value, user_information=user_information)
 
         try:
             HostValueObject(value=host)
 
-        except ValueError as error:
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid host <<<{host}>>>.') from error
+        except (TypeError, ValueError):
+            self._raise_value_has_not_valid_host(value=value, host=host)
 
-        try:
-            if port is not None:
+        if port is not None:
+            try:
                 PortValueObject(value=port)
 
-        except ValueError as error:
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid port <<<{port}>>>.') from error
+            except (TypeError, ValueError):
+                self._raise_value_has_not_valid_port(value=value, port=port)
+
+    def _raise_value_has_not_valid_user_information(self, value: str, user_information: str) -> NoReturn:
+        """
+        Raise an error if the URL user information is invalid.
+
+        Args:
+            value (str): The URL value.
+            user_information (str): The invalid user information.
+
+        Raises:
+            ValueError: If the URL user information is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid user information <<<{user_information}>>>.')  # noqa: E501  # fmt: skip
+
+    def _raise_value_has_not_valid_host(self, value: str, host: str) -> NoReturn:
+        """
+        Raise an error if the URL host is invalid.
+
+        Args:
+            value (str): The URL value.
+            host (str): The invalid host.
+
+        Raises:
+            ValueError: If the URL host is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid host <<<{host}>>>.')
+
+    def _raise_value_has_not_valid_port(self, value: str, port: int | str) -> NoReturn:
+        """
+        Raise an error if the URL port is invalid.
+
+        Args:
+            value (str): The URL value.
+            port (int | str): The invalid port.
+
+        Raises:
+            ValueError: If the URL port is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid port <<<{port}>>>.')
 
     @validation(order=3)
     def _validate_url_path(self, value: str) -> None:
@@ -244,7 +329,20 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             return
 
         if not self._URL_PATH_REGEX.match(string=path):
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid path <<<{path}>>>.')
+            self._raise_value_has_not_valid_path(value=value, path=path)
+
+    def _raise_value_has_not_valid_path(self, value: str, path: str) -> NoReturn:
+        """
+        Raise an error if the URL path is invalid.
+
+        Args:
+            value (str): The URL value.
+            path (str): The invalid path.
+
+        Raises:
+            ValueError: If the URL path is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid path <<<{path}>>>.')
 
     @validation(order=4)
     def _validate_url_query(self, value: str) -> None:
@@ -267,11 +365,24 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
         try:
             parse_qs(qs=query)
 
-        except ValueError as error:
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid query <<<{query}>>>.') from error
+        except ValueError:
+            self._raise_value_has_not_valid_query(value=value, query=query)
 
         if not self._URL_QUERY_REGEX.match(string=query):
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid query <<<{query}>>>.')
+            self._raise_value_has_not_valid_query(value=value, query=query)
+
+    def _raise_value_has_not_valid_query(self, value: str, query: str) -> NoReturn:
+        """
+        Raise an error if the URL query is invalid.
+
+        Args:
+            value (str): The URL value.
+            query (str): The invalid query.
+
+        Raises:
+            ValueError: If the URL query is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid query <<<{query}>>>.')
 
     @validation(order=5)
     def _validate_url_fragment(self, value: str) -> None:
@@ -292,7 +403,20 @@ class UrlValueObject(NotEmptyStringValueObject, TrimmedStringValueObject):
             return
 
         if not self._URL_FRAGMENT_REGEX.match(string=fragment):
-            raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid fragment <<<{fragment}>>>.')
+            self._raise_value_has_not_valid_fragment(value=value, fragment=fragment)
+
+    def _raise_value_has_not_valid_fragment(self, value: str, fragment: str) -> NoReturn:
+        """
+        Raise an error if the URL fragment is invalid.
+
+        Args:
+            value (str): The URL value.
+            fragment (str): The invalid fragment.
+
+        Raises:
+            ValueError: If the URL fragment is invalid.
+        """
+        raise ValueError(f'UrlValueObject value <<<{value}>>> has not a valid fragment <<<{fragment}>>>.')
 
     @property
     def scheme(self) -> str: