marshmallow 3.25.0__py3-none-any.whl → 3.26.0__py3-none-any.whl

marshmallow/utils.py

@@ -1,5 +1,6 @@
 """Utility methods for marshmallow."""
 
+# ruff: noqa: T201, T203
 from __future__ import annotations
 
 import collections
@@ -18,6 +19,10 @@ from marshmallow.base import FieldABC
 from marshmallow.exceptions import FieldInstanceResolutionError
 from marshmallow.warnings import RemovedInMarshmallow4Warning
 
+if typing.TYPE_CHECKING:
+    from marshmallow.fields import Field
+
+
 EXCLUDE = "exclude"
 INCLUDE = "include"
 RAISE = "raise"
@@ -111,7 +116,7 @@ def from_rfc(datestring: str) -> dt.datetime:
 def rfcformat(datetime: dt.datetime) -> str:
     """Return the RFC822-formatted representation of a datetime object.
 
-    :param datetime datetime: The datetime.
+    :param datetime: The datetime.
     """
     return format_datetime(datetime)
 
@@ -133,7 +138,7 @@ _iso8601_time_re = re.compile(
 )
 
 
-def get_fixed_timezone(offset: int | float | dt.timedelta) -> dt.timezone:
+def get_fixed_timezone(offset: float | dt.timedelta) -> dt.timezone:
     """Return a tzinfo instance with a fixed offset from UTC."""
     if isinstance(offset, dt.timedelta):
         offset = offset.total_seconds() // 60
@@ -165,7 +170,7 @@ def from_iso_datetime(value):
         tzinfo = get_fixed_timezone(offset)
     kw = {k: int(v) for k, v in kw.items() if v is not None}
     kw["tzinfo"] = tzinfo
-    return dt.datetime(**kw)
+    return dt.datetime(**kw)  # noqa: DTZ001
 
 
 def from_iso_time(value):
@@ -229,7 +234,7 @@ def timestamp_ms(value: dt.datetime) -> float:
 def isoformat(datetime: dt.datetime) -> str:
     """Return the ISO8601-formatted representation of a datetime object.
 
-    :param datetime datetime: The datetime.
+    :param datetime: The datetime.
     """
     return datetime.isoformat()
 
@@ -275,17 +280,15 @@ def get_value(obj, key: int | str, default=missing):
     """
     if not isinstance(key, int) and "." in key:
         return _get_value_for_keys(obj, key.split("."), default)
-    else:
-        return _get_value_for_key(obj, key, default)
+    return _get_value_for_key(obj, key, default)
 
 
 def _get_value_for_keys(obj, keys, default):
     if len(keys) == 1:
         return _get_value_for_key(obj, keys[0], default)
-    else:
-        return _get_value_for_keys(
-            _get_value_for_key(obj, keys[0], default), keys[1:], default
-        )
+    return _get_value_for_keys(
+        _get_value_for_key(obj, keys[0], default), keys[1:], default
+    )
 
 
 def _get_value_for_key(obj, key, default):
@@ -314,7 +317,7 @@ def set_value(dct: dict[str, typing.Any], key: str, value: typing.Any):
         target = dct.setdefault(head, {})
         if not isinstance(target, dict):
             raise ValueError(
-                f"Cannot set {key} in {head} " f"due to existing value: {target}"
+                f"Cannot set {key} in {head} due to existing value: {target}"
             )
         set_value(target, rest, value)
     else:
@@ -347,19 +350,18 @@ def get_func_args(func: typing.Callable) -> list[str]:
     return _signature(func)
 
 
-def resolve_field_instance(cls_or_instance):
-    """Return a Schema instance from a Schema class or instance.
+def resolve_field_instance(cls_or_instance: type[Field] | Field) -> Field:
+    """Return a field instance from a field class or instance.
 
-    :param type|Schema cls_or_instance: Marshmallow Schema class or instance.
+    :param cls_or_instance: Field class or instance.
     """
     if isinstance(cls_or_instance, type):
         if not issubclass(cls_or_instance, FieldABC):
             raise FieldInstanceResolutionError
         return cls_or_instance()
-    else:
-        if not isinstance(cls_or_instance, FieldABC):
-            raise FieldInstanceResolutionError
-        return cls_or_instance
+    if not isinstance(cls_or_instance, FieldABC):
+        raise FieldInstanceResolutionError
+    return cls_or_instance
 
 
 def timedelta_to_microseconds(value: dt.timedelta) -> int:

marshmallow/validate.py

@@ -9,10 +9,12 @@ from abc import ABC, abstractmethod
 from itertools import zip_longest
 from operator import attrgetter
 
-from marshmallow import types
 from marshmallow.exceptions import ValidationError
 from marshmallow.warnings import ChangedInMarshmallow4Warning
 
+if typing.TYPE_CHECKING:
+    from marshmallow import types
+
 _T = typing.TypeVar("_T")
 
 
@@ -73,8 +75,8 @@ class And(Validator):
         return f"validators={self.validators!r}"
 
     def __call__(self, value: typing.Any) -> typing.Any:
-        errors = []
-        kwargs = {}
+        errors: list[str | dict] = []
+        kwargs: dict[str, typing.Any] = {}
         for validator in self.validators:
             try:
                 r = validator(value)
@@ -85,14 +87,13 @@ class And(Validator):
                         ChangedInMarshmallow4Warning,
                         stacklevel=2,
                     )
-                    raise ValidationError(self.error)
+                    raise ValidationError(self.error)  # noqa: TRY301
             except ValidationError as err:
                 kwargs.update(err.kwargs)
                 if isinstance(err.messages, dict):
                     errors.append(err.messages)
                 else:
-                    # FIXME : Get rid of cast
-                    errors.extend(typing.cast(list, err.messages))
+                    errors.extend(err.messages)
         if errors:
             raise ValidationError(errors, **kwargs)
         return value
@@ -115,7 +116,7 @@ class URL(Validator):
             self._memoized = {}
 
         def _regex_generator(
-            self, relative: bool, absolute: bool, require_tld: bool
+            self, *, relative: bool, absolute: bool, require_tld: bool
         ) -> typing.Pattern:
             hostname_variants = [
                 # a normal domain name, expressed in [A-Z0-9] chars with hyphens allowed only in the middle
@@ -169,12 +170,12 @@ class URL(Validator):
             return re.compile("".join(parts), re.IGNORECASE)
 
         def __call__(
-            self, relative: bool, absolute: bool, require_tld: bool
+            self, *, relative: bool, absolute: bool, require_tld: bool
         ) -> typing.Pattern:
             key = (relative, absolute, require_tld)
             if key not in self._memoized:
                 self._memoized[key] = self._regex_generator(
-                    relative, absolute, require_tld
+                    relative=relative, absolute=absolute, require_tld=require_tld
                 )
 
             return self._memoized[key]
@@ -215,14 +216,24 @@ class URL(Validator):
             raise ValidationError(message)
 
         # Check first if the scheme is valid
+        scheme = None
         if "://" in value:
             scheme = value.split("://")[0].lower()
             if scheme not in self.schemes:
                 raise ValidationError(message)
 
-        regex = self._regex(self.relative, self.absolute, self.require_tld)
+        regex = self._regex(
+            relative=self.relative, absolute=self.absolute, require_tld=self.require_tld
+        )
+
+        # Hostname is optional for file URLS. If absent it means `localhost`.
+        # Fill it in for the validation if needed
+        if scheme == "file" and value.startswith("file:///"):
+            matched = regex.search(value.replace("file:///", "file://localhost/", 1))
+        else:
+            matched = regex.search(value)
 
-        if not regex.search(value):
+        if not matched:
             raise ValidationError(message)
 
         return value
@@ -318,8 +329,8 @@ class Range(Validator):
 
     def __init__(
         self,
-        min=None,
-        max=None,
+        min=None,  # noqa: A002
+        max=None,  # noqa: A002
         *,
         min_inclusive: bool = True,
         max_inclusive: bool = True,
@@ -365,6 +376,9 @@ class Range(Validator):
         return value
 
 
+_SizedT = typing.TypeVar("_SizedT", bound=typing.Sized)
+
+
 class Length(Validator):
     """Validator which succeeds if the value passed to it has a
     length between a minimum and maximum. Uses len(), so it
@@ -387,8 +401,8 @@ class Length(Validator):
 
     def __init__(
         self,
-        min: int | None = None,
-        max: int | None = None,
+        min: int | None = None,  # noqa: A002
+        max: int | None = None,  # noqa: A002
         *,
         equal: int | None = None,
         error: str | None = None,
@@ -407,12 +421,12 @@ class Length(Validator):
     def _repr_args(self) -> str:
         return f"min={self.min!r}, max={self.max!r}, equal={self.equal!r}"
 
-    def _format_error(self, value: typing.Sized, message: str) -> str:
+    def _format_error(self, value: _SizedT, message: str) -> str:
         return (self.error or message).format(
             input=value, min=self.min, max=self.max, equal=self.equal
         )
 
-    def __call__(self, value: typing.Sized) -> typing.Sized:
+    def __call__(self, value: _SizedT) -> _SizedT:
         length = len(value)
 
         if self.equal is not None:
@@ -531,7 +545,7 @@ class Predicate(Validator):
     def _format_error(self, value: typing.Any) -> str:
         return self.error.format(input=value, method=self.method)
 
-    def __call__(self, value: typing.Any) -> typing.Any:
+    def __call__(self, value: _T) -> _T:
         method = getattr(value, self.method)
 
         if not method(**self.kwargs):
@@ -637,9 +651,9 @@ class ContainsOnly(OneOf):
     in the sequence is also in the sequence passed as ``choices``. Empty input
     is considered valid.
 
-    :param iterable choices: Same as :class:`OneOf`.
-    :param iterable labels: Same as :class:`OneOf`.
-    :param str error: Same as :class:`OneOf`.
+    :param choices: Same as :class:`OneOf`.
+    :param labels: Same as :class:`OneOf`.
+    :param error: Same as :class:`OneOf`.
 
     .. versionchanged:: 3.0.0b2
         Duplicate values are considered valid.
@@ -667,8 +681,8 @@ class ContainsNoneOf(NoneOf):
     in the sequence is a member of the sequence passed as ``iterable``. Empty input
     is considered valid.
 
-    :param iterable iterable: Same as :class:`NoneOf`.
-    :param str error: Same as :class:`NoneOf`.
+    :param iterable: Same as :class:`NoneOf`.
+    :param error: Same as :class:`NoneOf`.
 
     .. versionadded:: 3.6.0
     """

{marshmallow-3.25.0.dist-info → marshmallow-3.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: marshmallow
-Version: 3.25.0
+Version: 3.26.0
 Summary: A lightweight library for converting complex datatypes to and from native Python datatypes.
 Author-email: Steven Loria <sloria1@gmail.com>
 Maintainer-email: Steven Loria <sloria1@gmail.com>, Jérôme Lafréchoux <jerome@jolimont.fr>, Jared Deckard <jared@shademaps.com>
@@ -19,10 +19,12 @@ Requires-Dist: packaging>=17.0
 Requires-Dist: marshmallow[tests] ; extra == "dev"
 Requires-Dist: tox ; extra == "dev"
 Requires-Dist: pre-commit>=3.5,<5.0 ; extra == "dev"
-Requires-Dist: sphinx==8.1.3 ; extra == "docs"
-Requires-Dist: sphinx-issues==5.0.0 ; extra == "docs"
-Requires-Dist: alabaster==1.0.0 ; extra == "docs"
 Requires-Dist: autodocsumm==0.2.14 ; extra == "docs"
+Requires-Dist: furo==2024.8.6 ; extra == "docs"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "docs"
+Requires-Dist: sphinx-issues==5.0.0 ; extra == "docs"
+Requires-Dist: sphinx==8.1.3 ; extra == "docs"
+Requires-Dist: sphinxext-opengraph==0.9.1 ; extra == "docs"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: simplejson ; extra == "tests"
 Project-URL: Changelog, https://marshmallow.readthedocs.io/en/latest/changelog.html
@@ -56,6 +58,8 @@ marshmallow: simplified object serialization
    :target: https://marshmallow.readthedocs.io/
    :alt: Documentation
 
+.. start elevator-pitch
+
 **marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
 
 .. code-block:: python
@@ -86,20 +90,21 @@ marshmallow: simplified object serialization
     #   'release_date': '1971-12-17',
     #   'title': 'Hunky Dory'}
 
-
 In short, marshmallow schemas can be used to:
 
 - **Validate** input data.
 - **Deserialize** input data to app-level objects.
 - **Serialize** app-level objects to primitive Python types. The serialized objects can then be rendered to standard formats such as JSON for use in an HTTP API.
 
-Get It Now
+Get it now
 ==========
 
-::
+.. code-block:: shell-session
 
     $ pip install -U marshmallow
 
+.. end elevator-pitch
+
 Documentation
 =============
 
@@ -146,6 +151,8 @@ Thank you to all our backers! [`Become a backer`_]
 Sponsors
 --------
 
+.. start sponsors
+
 marshmallow is sponsored by `Route4Me <https://route4me.com>`_.
 
 .. image:: https://github.com/user-attachments/assets/018c2e23-032e-4a11-98da-8b6dc25b9054
@@ -157,6 +164,8 @@ Your logo will be displayed here with a link to your website. [`Become a sponsor
 
 .. _`Become a sponsor`: https://opencollective.com/marshmallow#sponsor
 
+.. end sponsors
+
 Professional Support
 ====================
 

marshmallow-3.26.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+marshmallow/__init__.py,sha256=TU1arjtOLs87YDfW4Z35YVbaY2CUXK-VgylcuL8LaQg,2387
+marshmallow/base.py,sha256=39W78-rnuzzx5T95YWBEECzjtqxdUA8XzYJNHd39VLg,1362
+marshmallow/class_registry.py,sha256=HTC9srCEaRsiy5L_vUKQso7IQfeZeRXxZfz4_2NitoM,3029
+marshmallow/decorators.py,sha256=pMjGPaXBZCRfAdQS3Bz5ieTZGA3BOv61FdTPsLwCtMQ,8749
+marshmallow/error_store.py,sha256=iCPSdw8nJGiS4fjWuIAY1aSI_Hhckcdo3l_g-7pjaMw,2240
+marshmallow/exceptions.py,sha256=DuARdOcirCdJxmlp16V97hQKAXOokvdW12jXtYOlGyk,2326
+marshmallow/fields.py,sha256=DjjL5m5YZbwMVHE97MQDNfoFf_e75qMR3eIs17UuVMc,74763
+marshmallow/orderedset.py,sha256=-Lq83AWIIFs2bxptDwkHtfQ63ebX3WD3R6N3B5rRnVI,2936
+marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+marshmallow/schema.py,sha256=bSBynndwixq1zcOOPdoZkX7DmpVSpHBaNEh1zqiD888,52128
+marshmallow/types.py,sha256=VY0_D-Xou7nKjcvWB1iccm8cZtxI3rkis1nhNelNn5Q,979
+marshmallow/utils.py,sha256=tLzu9FDL3Ph51qKsoqWIyPSwg8dZ8rzjeXXGLUndHFE,11943
+marshmallow/validate.py,sha256=Fx3F8F20dBGg-Wrv84Chx5SYedX9E0l592hR4MxS0kQ,24652
+marshmallow/warnings.py,sha256=YHC0kQQBbTKCiA1FuwnbnXqrph7oKuU9BjTV4cxwnzE,192
+marshmallow-3.26.0.dist-info/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
+marshmallow-3.26.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+marshmallow-3.26.0.dist-info/METADATA,sha256=Scbh6z8NMiWGVQ3EYrwo6H9-PNczOrepN_tFFZu_A9k,7310
+marshmallow-3.26.0.dist-info/RECORD,,

marshmallow-3.25.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-marshmallow/__init__.py,sha256=C-zbaQJ9dlJLJxotIqTa5OOaD6ojGNRqW8moGrMsGr8,2387
-marshmallow/base.py,sha256=39W78-rnuzzx5T95YWBEECzjtqxdUA8XzYJNHd39VLg,1362
-marshmallow/class_registry.py,sha256=ZULbtwFxnj4bbzQqfwTLyNPUpr6xAZTLFMar4YJfKJQ,3032
-marshmallow/decorators.py,sha256=B8Z-PsxWrftY4jTq3y_wt7kwlJWQI2vVQQyApMY5IeQ,8490
-marshmallow/error_store.py,sha256=A7AxgLMw9ffSmaxRH4x3wcBWibx-DuGH4LwSDpVn50I,2223
-marshmallow/exceptions.py,sha256=DuARdOcirCdJxmlp16V97hQKAXOokvdW12jXtYOlGyk,2326
-marshmallow/fields.py,sha256=Z8wS9If4tqcv0KFnbm7HS5csMiVOD6--Donv6FlMfOc,74082
-marshmallow/orderedset.py,sha256=C2aAG6w1faIL1phinbAltbe3AUAnF5MN6n7fzESNDhI,2922
-marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-marshmallow/schema.py,sha256=qUY1MvcYxtEuztzjoom2fYaC7x2t16cAx4FBdgz3SDY,48696
-marshmallow/types.py,sha256=RDS4IfasIehvH2rGWh9e4RTBtsMp-JFFtjApajV22zc,283
-marshmallow/utils.py,sha256=pLZXqQWu7PHaQrQCrgwnR8eI_-aq_BVct5CCwyygUvk,11917
-marshmallow/validate.py,sha256=t5-4Qg_XlSQgcCujf_pimKIdZE0QT63jHyQP-miJNK0,24151
-marshmallow/warnings.py,sha256=YHC0kQQBbTKCiA1FuwnbnXqrph7oKuU9BjTV4cxwnzE,192
-marshmallow-3.25.0.dist-info/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
-marshmallow-3.25.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-marshmallow-3.25.0.dist-info/METADATA,sha256=yQLETlmBAzADnSDY4fAT_4zsyjlAxPlRFT6NVIovaYo,7084
-marshmallow-3.25.0.dist-info/RECORD,,