marshmallow 3.26.1__py3-none-any.whl → 4.0.0__py3-none-any.whl

marshmallow/types.py

@@ -7,13 +7,23 @@
 
 from __future__ import annotations
 
+try:
+    from typing import TypeAlias
+except ImportError:  # Remove when dropping Python 3.9
+    from typing_extensions import TypeAlias
+
 import typing
 
 #: A type that can be either a sequence of strings or a set of strings
-StrSequenceOrSet = typing.Union[typing.Sequence[str], typing.AbstractSet[str]]
+StrSequenceOrSet: TypeAlias = typing.Union[
+    typing.Sequence[str], typing.AbstractSet[str]
+]
 
 #: Type for validator functions
-Validator = typing.Callable[[typing.Any], typing.Any]
+Validator: TypeAlias = typing.Callable[[typing.Any], typing.Any]
+
+#: A valid option for the ``unknown`` schema option and argument
+UnknownOption: TypeAlias = typing.Literal["exclude", "include", "raise"]
 
 
 class SchemaValidator(typing.Protocol):
@@ -23,6 +33,7 @@ class SchemaValidator(typing.Protocol):
         original_data: typing.Any = ...,
         *,
         partial: bool | StrSequenceOrSet | None = None,
+        unknown: UnknownOption | None = None,
         many: bool = False,
     ) -> None: ...
 
@@ -33,8 +44,5 @@ class RenderModule(typing.Protocol):
     ) -> str: ...
 
     def loads(
-        self,
-        json_data: str | bytes | bytearray,
-        *args: typing.Any,
-        **kwargs: typing.Any,
+        self, s: str | bytes | bytearray, *args: typing.Any, **kwargs: typing.Any
     ) -> typing.Any: ...

marshmallow/utils.py

@@ -3,99 +3,38 @@
 # ruff: noqa: T201, T203
 from __future__ import annotations
 
-import collections
 import datetime as dt
-import functools
 import inspect
-import json
-import re
 import typing
-import warnings
-from collections.abc import Mapping
-from email.utils import format_datetime, parsedate_to_datetime
-from pprint import pprint as py_pprint
+from collections.abc import Mapping, Sequence
 
-from marshmallow.base import FieldABC
-from marshmallow.exceptions import FieldInstanceResolutionError
-from marshmallow.warnings import RemovedInMarshmallow4Warning
+# Remove when we drop Python 3.9
+try:
+    from typing import TypeGuard
+except ImportError:
+    from typing_extensions import TypeGuard
 
-if typing.TYPE_CHECKING:
-    from marshmallow.fields import Field
+from marshmallow.constants import missing
 
 
-EXCLUDE = "exclude"
-INCLUDE = "include"
-RAISE = "raise"
-_UNKNOWN_VALUES = {EXCLUDE, INCLUDE, RAISE}
-
-
-class _Missing:
-    def __bool__(self):
-        return False
-
-    def __copy__(self):
-        return self
-
-    def __deepcopy__(self, _):
-        return self
-
-    def __repr__(self):
-        return "<marshmallow.missing>"
-
-
-# Singleton value that indicates that a field's value is missing from input
-# dict passed to `Schema.load <marshmallow.Schema.load>`. If the field's value is not required,
-# it's ``default`` value is used.
-missing = _Missing()
-
-
-def is_generator(obj) -> bool:
+def is_generator(obj) -> TypeGuard[typing.Generator]:
     """Return True if ``obj`` is a generator"""
     return inspect.isgeneratorfunction(obj) or inspect.isgenerator(obj)
 
 
-def is_iterable_but_not_string(obj) -> bool:
+def is_iterable_but_not_string(obj) -> TypeGuard[typing.Iterable]:
     """Return True if ``obj`` is an iterable object that isn't a string."""
     return (hasattr(obj, "__iter__") and not hasattr(obj, "strip")) or is_generator(obj)
 
 
-def is_collection(obj) -> bool:
-    """Return True if ``obj`` is a collection type, e.g list, tuple, queryset."""
-    return is_iterable_but_not_string(obj) and not isinstance(obj, Mapping)
-
-
-def is_instance_or_subclass(val, class_) -> bool:
-    """Return True if ``val`` is either a subclass or instance of ``class_``."""
-    try:
-        return issubclass(val, class_)
-    except TypeError:
-        return isinstance(val, class_)
-
-
-def is_keyed_tuple(obj) -> bool:
-    """Return True if ``obj`` has keyed tuple behavior, such as
-    namedtuples or SQLAlchemy's KeyedTuples.
-    """
-    return isinstance(obj, tuple) and hasattr(obj, "_fields")
+def is_sequence_but_not_string(obj) -> TypeGuard[Sequence]:
+    """Return True if ``obj`` is a sequence that isn't a string."""
+    return isinstance(obj, Sequence) and not isinstance(obj, (str, bytes))
 
 
-def pprint(obj, *args, **kwargs) -> None:
-    """Pretty-printing function that can pretty-print OrderedDicts
-    like regular dictionaries. Useful for printing the output of
-    :meth:`marshmallow.Schema.dump`.
-
-    .. deprecated:: 3.7.0
-        marshmallow.pprint will be removed in marshmallow 4.
-    """
-    warnings.warn(
-        "marshmallow's pprint function is deprecated and will be removed in marshmallow 4.",
-        RemovedInMarshmallow4Warning,
-        stacklevel=2,
-    )
-    if isinstance(obj, collections.OrderedDict):
-        print(json.dumps(obj, *args, **kwargs))
-    else:
-        py_pprint(obj, *args, **kwargs)
+def is_collection(obj) -> TypeGuard[typing.Iterable]:
+    """Return True if ``obj`` is a collection type, e.g list, tuple, queryset."""
+    return is_iterable_but_not_string(obj) and not isinstance(obj, Mapping)
 
 
 # https://stackoverflow.com/a/27596917
@@ -105,97 +44,6 @@ def is_aware(datetime: dt.datetime) -> bool:
     )
 
 
-def from_rfc(datestring: str) -> dt.datetime:
-    """Parse a RFC822-formatted datetime string and return a datetime object.
-
-    https://stackoverflow.com/questions/885015/how-to-parse-a-rfc-2822-date-time-into-a-python-datetime  # noqa: B950
-    """
-    return parsedate_to_datetime(datestring)
-
-
-def rfcformat(datetime: dt.datetime) -> str:
-    """Return the RFC822-formatted representation of a datetime object.
-
-    :param datetime: The datetime.
-    """
-    return format_datetime(datetime)
-
-
-# Hat tip to Django for ISO8601 deserialization functions
-
-_iso8601_datetime_re = re.compile(
-    r"(?P<year>\d{4})-(?P<month>\d{1,2})-(?P<day>\d{1,2})"
-    r"[T ](?P<hour>\d{1,2}):(?P<minute>\d{1,2})"
-    r"(?::(?P<second>\d{1,2})(?:\.(?P<microsecond>\d{1,6})\d{0,6})?)?"
-    r"(?P<tzinfo>Z|[+-]\d{2}(?::?\d{2})?)?$"
-)
-
-_iso8601_date_re = re.compile(r"(?P<year>\d{4})-(?P<month>\d{1,2})-(?P<day>\d{1,2})$")
-
-_iso8601_time_re = re.compile(
-    r"(?P<hour>\d{1,2}):(?P<minute>\d{1,2})"
-    r"(?::(?P<second>\d{1,2})(?:\.(?P<microsecond>\d{1,6})\d{0,6})?)?"
-)
-
-
-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
-    sign = "-" if offset < 0 else "+"
-    hhmm = "{:02d}{:02d}".format(*divmod(abs(offset), 60))
-    name = sign + hhmm
-    return dt.timezone(dt.timedelta(minutes=offset), name)
-
-
-def from_iso_datetime(value):
-    """Parse a string and return a datetime.datetime.
-
-    This function supports time zone offsets. When the input contains one,
-    the output uses a timezone with a fixed offset from UTC.
-    """
-    match = _iso8601_datetime_re.match(value)
-    if not match:
-        raise ValueError("Not a valid ISO8601-formatted datetime string")
-    kw = match.groupdict()
-    kw["microsecond"] = kw["microsecond"] and kw["microsecond"].ljust(6, "0")
-    tzinfo = kw.pop("tzinfo")
-    if tzinfo == "Z":
-        tzinfo = dt.timezone.utc
-    elif tzinfo is not None:
-        offset_mins = int(tzinfo[-2:]) if len(tzinfo) > 3 else 0
-        offset = 60 * int(tzinfo[1:3]) + offset_mins
-        if tzinfo[0] == "-":
-            offset = -offset
-        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)  # noqa: DTZ001
-
-
-def from_iso_time(value):
-    """Parse a string and return a datetime.time.
-
-    This function doesn't support time zone offsets.
-    """
-    match = _iso8601_time_re.match(value)
-    if not match:
-        raise ValueError("Not a valid ISO8601-formatted time string")
-    kw = match.groupdict()
-    kw["microsecond"] = kw["microsecond"] and kw["microsecond"].ljust(6, "0")
-    kw = {k: int(v) for k, v in kw.items() if v is not None}
-    return dt.time(**kw)
-
-
-def from_iso_date(value):
-    """Parse a string and return a datetime.date."""
-    match = _iso8601_date_re.match(value)
-    if not match:
-        raise ValueError("Not a valid ISO8601-formatted date string")
-    kw = {k: int(v) for k, v in match.groupdict().items()}
-    return dt.date(**kw)
-
-
 def from_timestamp(value: typing.Any) -> dt.datetime:
     if value is True or value is False:
         raise ValueError("Not a valid POSIX timestamp")
@@ -231,22 +79,6 @@ def timestamp_ms(value: dt.datetime) -> float:
     return timestamp(value) * 1000
 
 
-def isoformat(datetime: dt.datetime) -> str:
-    """Return the ISO8601-formatted representation of a datetime object.
-
-    :param datetime: The datetime.
-    """
-    return datetime.isoformat()
-
-
-def to_iso_time(time: dt.time) -> str:
-    return dt.time.isoformat(time)
-
-
-def to_iso_date(date: dt.date) -> str:
-    return dt.date.isoformat(date)
-
-
 def ensure_text_type(val: str | bytes) -> str:
     if isinstance(val, bytes):
         val = val.decode("utf-8")
@@ -331,50 +163,9 @@ def callable_or_raise(obj):
     return obj
 
 
-def _signature(func: typing.Callable) -> list[str]:
-    return list(inspect.signature(func).parameters.keys())
-
-
-def get_func_args(func: typing.Callable) -> list[str]:
-    """Given a callable, return a list of argument names. Handles
-    `functools.partial` objects and class-based callables.
-
-    .. versionchanged:: 3.0.0a1
-        Do not return bound arguments, eg. ``self``.
-    """
-    if inspect.isfunction(func) or inspect.ismethod(func):
-        return _signature(func)
-    if isinstance(func, functools.partial):
-        return _signature(func.func)
-    # Callable class
-    return _signature(func)
-
-
-def resolve_field_instance(cls_or_instance: type[Field] | Field) -> Field:
-    """Return a field instance from a field 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()
-    if not isinstance(cls_or_instance, FieldABC):
-        raise FieldInstanceResolutionError
-    return cls_or_instance
-
-
 def timedelta_to_microseconds(value: dt.timedelta) -> int:
-    """Compute the total microseconds of a timedelta
+    """Compute the total microseconds of a timedelta.
 
-    https://github.com/python/cpython/blob/bb3e0c240bc60fe08d332ff5955d54197f79751c/Lib/datetime.py#L665-L667  # noqa: B950
+    https://github.com/python/cpython/blob/v3.13.1/Lib/_pydatetime.py#L805-L807
     """
     return (value.days * (24 * 3600) + value.seconds) * 1000000 + value.microseconds
-
-
-def validate_unknown_parameter_value(obj: typing.Any) -> str:
-    if obj not in _UNKNOWN_VALUES:
-        raise ValueError(
-            f"Object {obj!r} is not a valid value for the 'unknown' parameter"
-        )
-    return obj

marshmallow/validate.py

@@ -4,13 +4,11 @@ from __future__ import annotations
 
 import re
 import typing
-import warnings
 from abc import ABC, abstractmethod
 from itertools import zip_longest
 from operator import attrgetter
 
 from marshmallow.exceptions import ValidationError
-from marshmallow.warnings import ChangedInMarshmallow4Warning
 
 if typing.TYPE_CHECKING:
     from marshmallow import types
@@ -62,14 +60,10 @@ class And(Validator):
         # ValidationError: ['Must be greater than or equal to 0.', 'Not an even value.']
 
     :param validators: Validators to combine.
-    :param error: Error message to use when a validator returns ``False``.
     """
 
-    default_error_message = "Invalid value."
-
-    def __init__(self, *validators: types.Validator, error: str | None = None):
+    def __init__(self, *validators: types.Validator):
         self.validators = tuple(validators)
-        self.error: str = error or self.default_error_message
 
     def _repr_args(self) -> str:
         return f"validators={self.validators!r}"
@@ -79,15 +73,7 @@ class And(Validator):
         kwargs: dict[str, typing.Any] = {}
         for validator in self.validators:
             try:
-                r = validator(value)
-                if not isinstance(validator, Validator) and r is False:
-                    warnings.warn(
-                        "Returning `False` from a validator is deprecated. "
-                        "Raise a `ValidationError` instead.",
-                        ChangedInMarshmallow4Warning,
-                        stacklevel=2,
-                    )
-                    raise ValidationError(self.error)  # noqa: TRY301
+                validator(value)
             except ValidationError as err:
                 kwargs.update(err.kwargs)
                 if isinstance(err.messages, dict):

{marshmallow-3.26.1.dist-info → marshmallow-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: marshmallow
-Version: 3.26.1
+Version: 4.0.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>
@@ -15,16 +15,18 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: packaging>=17.0
+License-File: LICENSE
+Requires-Dist: backports-datetime-fromisoformat; python_version < '3.11'
+Requires-Dist: typing-extensions; python_version < '3.11'
 Requires-Dist: marshmallow[tests] ; extra == "dev"
 Requires-Dist: tox ; extra == "dev"
 Requires-Dist: pre-commit>=3.5,<5.0 ; extra == "dev"
 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: sphinx-issues==5.0.1 ; extra == "docs"
+Requires-Dist: sphinx==8.2.3 ; extra == "docs"
+Requires-Dist: sphinxext-opengraph==0.10.0 ; extra == "docs"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: simplejson ; extra == "tests"
 Project-URL: Changelog, https://marshmallow.readthedocs.io/en/latest/changelog.html

marshmallow-4.0.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+marshmallow/__init__.py,sha256=EEHr24mHh2kH_pszxdnToOfBG6Z2wqeOKbb0iiDGFv4,587
+marshmallow/class_registry.py,sha256=HTC9srCEaRsiy5L_vUKQso7IQfeZeRXxZfz4_2NitoM,3029
+marshmallow/constants.py,sha256=maYmT3pvjQgfummof45SJI_pDqHDFWSu3knVN7su78M,374
+marshmallow/decorators.py,sha256=CwD37uih8cyquwYGv-qKVPUUtKmj4tgas45AKwTdlZk,9987
+marshmallow/error_store.py,sha256=iCPSdw8nJGiS4fjWuIAY1aSI_Hhckcdo3l_g-7pjaMw,2240
+marshmallow/exceptions.py,sha256=CFb7Xb4KNIqsWycl6cUYlrQFGyNBR7zm18HI0BbXs_I,2335
+marshmallow/fields.py,sha256=CIpnQ_MzX6h4_yO81mR0nJg34CjvieGYFQ7MQOycUOM,72081
+marshmallow/orderedset.py,sha256=-Lq83AWIIFs2bxptDwkHtfQ63ebX3WD3R6N3B5rRnVI,2936
+marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+marshmallow/schema.py,sha256=fIF1M3JS8wwNxrzchP7HhrtcDEn-KrLrujLqalA84S8,49904
+marshmallow/types.py,sha256=EAMyppcDjDmSd57IWpBRk5RFY6uPoI8CvDr4pLaBXj8,1297
+marshmallow/utils.py,sha256=T05FkN2S3z3Bc1jF6hfnA9jJEaUqULI3p60bGgFL8Fc,5467
+marshmallow/validate.py,sha256=X6uhUir-2DqUVzKMkEN6I8LrLPJ1mbL8RECRggByllU,23931
+marshmallow/experimental/__init__.py,sha256=5_iaUmT7_f6QML2LJXmA3xqgk5UBAgCeIazHtC1GVgc,147
+marshmallow/experimental/context.py,sha256=_4KF6sNK6pE0MckyYTGXmU3hJL2tY-TN4oVmE_eDob0,2040
+marshmallow-4.0.0.dist-info/licenses/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
+marshmallow-4.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+marshmallow-4.0.0.dist-info/METADATA,sha256=UsJ51KLqw0tcRrYZfoCL3mi7e1Hd9-TFKfRWYHIWEMQ,7432
+marshmallow-4.0.0.dist-info/RECORD,,

{marshmallow-3.26.1.dist-info → marshmallow-4.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.10.1
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any

marshmallow/base.py

@@ -1,61 +0,0 @@
-"""Abstract base classes.
-
-These are necessary to avoid circular imports between schema.py and fields.py.
-
-.. warning::
-
-    This module is deprecated. Users should not import from this module.
-    Use `marshmallow.fields.Field` and `marshmallow.schema.Schema` as base classes instead.
-"""
-
-from __future__ import annotations
-
-from abc import ABC, abstractmethod
-
-
-class FieldABC(ABC):
-    """Abstract base class from which all Field classes inherit."""
-
-    @abstractmethod
-    def serialize(self, attr, obj, accessor=None):
-        pass
-
-    @abstractmethod
-    def deserialize(self, value):
-        pass
-
-    @abstractmethod
-    def _serialize(self, value, attr, obj, **kwargs):
-        pass
-
-    @abstractmethod
-    def _deserialize(self, value, attr, data, **kwargs):
-        pass
-
-
-class SchemaABC(ABC):
-    """Abstract base class from which all Schemas inherit."""
-
-    @abstractmethod
-    def dump(self, obj, *, many: bool | None = None):
-        pass
-
-    @abstractmethod
-    def dumps(self, obj, *, many: bool | None = None):
-        pass
-
-    @abstractmethod
-    def load(self, data, *, many: bool | None = None, partial=None, unknown=None):
-        pass
-
-    @abstractmethod
-    def loads(
-        self,
-        json_data,
-        *,
-        many: bool | None = None,
-        partial=None,
-        unknown=None,
-        **kwargs,
-    ):
-        pass

marshmallow/warnings.py

@@ -1,10 +0,0 @@
-class Marshmallow4Warning(DeprecationWarning):
-    pass
-
-
-class ChangedInMarshmallow4Warning(Marshmallow4Warning):
-    pass
-
-
-class RemovedInMarshmallow4Warning(Marshmallow4Warning):
-    pass

marshmallow-3.26.1.dist-info/RECORD

@@ -1,18 +0,0 @@
-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=TKVxFY9hLpq7ch6_HEb1be5uPw0fgs-uC4n5o_fTkg8,74756
-marshmallow/orderedset.py,sha256=-Lq83AWIIFs2bxptDwkHtfQ63ebX3WD3R6N3B5rRnVI,2936
-marshmallow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-marshmallow/schema.py,sha256=Dc6ent2eI-0g9phGc1FB4EURpSNDRGFOjpyE2BWwYTc,52207
-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.1.dist-info/LICENSE,sha256=kGtdkFHkJhRMsXOtkRZnuOvQWpxYTCwmwTWzKj7RIAE,1064
-marshmallow-3.26.1.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-marshmallow-3.26.1.dist-info/METADATA,sha256=9TJTS8CSQ5yUx_cNqkUz_0dQU9p0gCQcsJ_lUeq_7tE,7310
-marshmallow-3.26.1.dist-info/RECORD,,