marshmallow 3.23.1__tar.gz → 3.23.3__tar.gz

{marshmallow-3.23.1 → marshmallow-3.23.3}/CHANGELOG.rst

@@ -1,6 +1,29 @@
 Changelog
 ---------
 
+3.23.3 (2025-01-03)
+*******************
+
+Bug fixes:
+
+- Typing: Fix typing for `Schema.from_dict <marshmallow.schema.Schema.from_dict>` (:issue:`1653`).
+  Thanks :user:`SteadBytes` for reporting.
+
+Support:
+
+- Documentation: Various documentation cleanups, including more concise docs in the `marshmallow.fields` API reference (:issue:`2307`).
+  Thanks :user:`AbdealiLoKo` for reporting.
+
+3.23.2 (2024-12-18)
+*******************
+
+Bug fixes:
+
+- Improve type hint formatting for ``Field``, ``Nested``, and ``Function`` fields
+  to resolve PyCharm warnings (:issue:`2268`).
+  Thanks :user:`Fares-Abubaker` for reporting and fixing.
+
+
 3.23.1 (2024-11-01)
 *******************
 

{marshmallow-3.23.1 → marshmallow-3.23.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: marshmallow
-Version: 3.23.1
+Version: 3.23.3
 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>
@@ -22,7 +22,6 @@ 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: sphinx-version-warning==1.1.2 ; extra == "docs"
 Requires-Dist: autodocsumm==0.2.14 ; extra == "docs"
 Requires-Dist: pytest ; extra == "tests"
 Requires-Dist: simplejson ; extra == "tests"
@@ -59,19 +58,6 @@ marshmallow: simplified object serialization
 
 **marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
 
-Sponsor Message
-===============
-
-Input an OpenAPI spec to generate API docs that look as good as Stripe's. `Request a preview <https://form.typeform.com/to/uc55zY0F>`_ of your docs on Fern.
-
-.. image:: https://github.com/user-attachments/assets/69916225-0d61-4bd7-b3b9-e378557673cb
-    :target: https://form.typeform.com/to/uc55zY0F
-    :align: center
-    :alt: Fern logo
-
-Example
-=======
-
 .. code-block:: python
 
     from datetime import date

{marshmallow-3.23.1 → marshmallow-3.23.3}/README.rst

@@ -22,19 +22,6 @@ marshmallow: simplified object serialization
 
 **marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
 
-Sponsor Message
-===============
-
-Input an OpenAPI spec to generate API docs that look as good as Stripe's. `Request a preview <https://form.typeform.com/to/uc55zY0F>`_ of your docs on Fern.
-
-.. image:: https://github.com/user-attachments/assets/69916225-0d61-4bd7-b3b9-e378557673cb
-    :target: https://form.typeform.com/to/uc55zY0F
-    :align: center
-    :alt: Fern logo
-
-Example
-=======
-
 .. code-block:: python
 
     from datetime import date

{marshmallow-3.23.1 → marshmallow-3.23.3}/docs/api_reference.rst

@@ -13,13 +13,3 @@ API Reference
     marshmallow.error_store
     marshmallow.class_registry
     marshmallow.exceptions
-
-.. automodule:: marshmallow
-   :members:
-   :undoc-members:
-   :autosummary:
-
-.. data:: EXCLUDE
-.. data:: INCLUDE
-.. data:: RAISE
-.. data:: missing

{marshmallow-3.23.1 → marshmallow-3.23.3}/docs/conf.py

@@ -8,14 +8,13 @@ extensions = [
     "sphinx.ext.viewcode",
     "alabaster",
     "sphinx_issues",
-    "versionwarning.extension",
     "autodocsumm",
 ]
 
 primary_domain = "py"
 default_role = "py:obj"
 
-intersphinx_mapping = {"python": ("https://python.readthedocs.io/en/latest/", None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 issues_github_path = "marshmallow-code/marshmallow"
 
@@ -36,7 +35,6 @@ exclude_patterns = ["_build"]
 html_theme_path = [alabaster.get_path()]
 html_theme = "alabaster"
 html_static_path = ["_static"]
-html_css_files = ["css/versionwarning.css", "css/sponsor-message.css"]
 templates_path = ["_templates"]
 html_show_sourcelink = False
 
@@ -76,21 +74,3 @@ html_sidebars = {
         "relations.html",
     ],
 }
-
-# sphinx-version-warning config
-versionwarning_messages = {
-    "latest": (
-        "This document is for the development version. "
-        'For the stable version documentation, see <a href="/en/stable/">here</a>.'
-    ),
-    "2.x-line": (
-        "marshmallow 2 is no longer supported as of 2020-08-18. "
-        '<a href="https://marshmallow.readthedocs.io/en/latest/upgrading.html#upgrading-to-3-0">'
-        "Update your code to use marshmallow 3</a>."
-    ),
-}
-# Show warning at top of page
-versionwarning_body_selector = "div.document"
-versionwarning_banner_title = ""
-# For debugging locally
-# versionwarning_project_version = "latest"

{marshmallow-3.23.1 → marshmallow-3.23.3}/docs/index.rst

@@ -6,15 +6,6 @@ marshmallow: simplified object serialization
 
 Release v\ |version|. (:doc:`Changelog <changelog>`)
 
-.. admonition:: Sponsor Message
-
-    Input an OpenAPI spec to generate API docs that look as good as Stripe's. `Request a preview <https://form.typeform.com/to/uc55zY0F>`_ of your docs on Fern.
-
-    .. image:: https://github.com/user-attachments/assets/69916225-0d61-4bd7-b3b9-e378557673cb
-        :target: https://form.typeform.com/to/uc55zY0F
-        :align: center
-        :alt: Fern logo
-
 .. include:: about.rst.inc
 
 Upgrading from an older version?

marshmallow-3.23.3/docs/marshmallow.fields.rst

@@ -0,0 +1,18 @@
+.. _api_fields:
+
+Fields
+======
+
+Base Field Class
+----------------
+
+.. autoclass:: marshmallow.fields.Field
+    :private-members:
+
+Field Subclasses
+----------------
+
+.. automodule:: marshmallow.fields
+    :members:
+    :autosummary:
+    :exclude-members: Field, default_error_messages, mapping_type, num_type, DESERIALIZATION_CLASS

{marshmallow-3.23.1 → marshmallow-3.23.3}/docs/marshmallow.schema.rst

@@ -4,5 +4,6 @@ Schema
 .. autoclass:: marshmallow.schema.Schema
     :inherited-members:
     :autosummary:
+    :exclude-members: OPTIONS_CLASS
 
 .. autoclass:: marshmallow.schema.SchemaOpts

{marshmallow-3.23.1 → marshmallow-3.23.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "marshmallow"
-version = "3.23.1"
+version = "3.23.3"
 description = "A lightweight library for converting complex datatypes to and from native Python datatypes."
 readme = "README.rst"
 license = { file = "LICENSE" }
@@ -36,7 +36,6 @@ docs = [
   "sphinx==8.1.3",
   "sphinx-issues==5.0.0",
   "alabaster==1.0.0",
-  "sphinx-version-warning==1.1.2",
   "autodocsumm==0.2.14",
 ]
 tests = ["pytest", "simplejson"]

{marshmallow-3.23.1 → marshmallow-3.23.3}/src/marshmallow/fields.py

@@ -1,5 +1,3 @@
-"""Field classes for various types of data."""
-
 from __future__ import annotations
 
 import collections
@@ -84,7 +82,6 @@ class Field(FieldABC):
     """Basic field from which other fields should extend. It applies no
     formatting by default, and should only be used in cases where
     data does not need to be formatted before being serialized or deserialized.
-    On error, the name of the field will be returned.
 
     :param dump_default: If set, this value will be used during serialization if the
         input value is missing. If not set, the field will be excluded from the
@@ -108,8 +105,9 @@ class Field(FieldABC):
     :param required: Raise a :exc:`ValidationError` if the field value
         is not supplied during deserialization.
     :param allow_none: Set this to `True` if `None` should be considered a valid value during
-        validation/deserialization. If ``load_default=None`` and ``allow_none`` is unset,
-        will default to ``True``. Otherwise, the default is ``False``.
+        validation/deserialization. If set to `False` (the default), `None` is considered invalid input.
+        If ``load_default`` is explicitly set to `None` and ``allow_none`` is unset,
+        `allow_none` is implicitly set to ``True``.
     :param load_only: If `True` skip this field during serialization, otherwise
         its value will be present in the serialized data.
     :param dump_only: If `True` skip this field during deserialization, otherwise
@@ -118,28 +116,12 @@ class Field(FieldABC):
     :param dict error_messages: Overrides for `Field.default_error_messages`.
     :param metadata: Extra information to be stored as field metadata.
 
-    .. versionchanged:: 2.0.0
-        Removed `error` parameter. Use ``error_messages`` instead.
-
-    .. versionchanged:: 2.0.0
-        Added `allow_none` parameter, which makes validation/deserialization of `None`
-        consistent across fields.
-
-    .. versionchanged:: 2.0.0
-        Added `load_only` and `dump_only` parameters, which allow field skipping
-        during the (de)serialization process.
-
-    .. versionchanged:: 2.0.0
-        Added `missing` parameter, which indicates the value for a field if the field
-        is not found during deserialization.
-
-    .. versionchanged:: 2.0.0
-        ``default`` value is only used if explicitly set. Otherwise, missing values
-        inputs are excluded from serialized output.
-
     .. versionchanged:: 3.0.0b8
         Add ``data_key`` parameter for the specifying the key in the input and
         output data. This parameter replaced both ``load_from`` and ``dump_to``.
+
+    .. versionchanged:: 3.13.0
+        Replace ``missing`` and ``default`` parameters with ``load_default`` and ``dump_default``.
     """
 
     # Some fields, such as Method fields and Function fields, are not expected
@@ -166,9 +148,9 @@ class Field(FieldABC):
         data_key: str | None = None,
         attribute: str | None = None,
         validate: (
-            None
-            | typing.Callable[[typing.Any], typing.Any]
+            typing.Callable[[typing.Any], typing.Any]
             | typing.Iterable[typing.Callable[[typing.Any], typing.Any]]
+            | None
         ) = None,
         required: bool = False,
         allow_none: bool | None = None,
@@ -321,8 +303,9 @@ class Field(FieldABC):
         self,
         attr: str,
         obj: typing.Any,
-        accessor: typing.Callable[[typing.Any, str, typing.Any], typing.Any]
-        | None = None,
+        accessor: (
+            typing.Callable[[typing.Any, str, typing.Any], typing.Any] | None
+        ) = None,
         **kwargs,
     ):
         """Pulls the value for the given key from the object, applies the
@@ -425,9 +408,6 @@ class Field(FieldABC):
         :raise ValidationError: In case of formatting or validation failure.
         :return: The deserialized value.
 
-        .. versionchanged:: 2.0.0
-            Added ``attr`` and ``data`` parameters.
-
         .. versionchanged:: 3.0.0
             Added ``**kwargs`` to signature.
         """
@@ -538,11 +518,15 @@ class Nested(Field):
 
     def __init__(
         self,
-        nested: SchemaABC
-        | SchemaMeta
-        | str
-        | dict[str, Field | type[Field]]
-        | typing.Callable[[], SchemaABC | SchemaMeta | dict[str, Field | type[Field]]],
+        nested: (
+            SchemaABC
+            | SchemaMeta
+            | str
+            | dict[str, Field | type[Field]]
+            | typing.Callable[
+                [], SchemaABC | SchemaMeta | dict[str, Field | type[Field]]
+            ]
+        ),
         *,
         dump_default: typing.Any = missing_,
         default: typing.Any = missing_,
@@ -744,10 +728,6 @@ class List(Field):
     :param cls_or_instance: A field class or instance.
     :param kwargs: The same keyword arguments that :class:`Field` receives.
 
-    .. versionchanged:: 2.0.0
-        The ``allow_none`` parameter now applies to deserialization and
-        has the same semantics as the other fields.
-
     .. versionchanged:: 3.0.0rc9
         Does not serialize scalar values to single-item lists.
     """
@@ -1459,9 +1439,6 @@ class TimeDelta(Field):
     will always be truncated to microseconds.
     For example, `1.12345` interpreted as microseconds will result in `timedelta(microseconds=1)`.
 
-    .. versionchanged:: 2.0.0
-        Always serializes to an integer value to avoid rounding errors.
-        Add `precision` parameter.
     .. versionchanged:: 3.17.0
         Allow (de)serialization to `float` through use of a new `serialization_type` parameter.
         `int` is the default to retain previous behaviour.
@@ -1944,9 +1921,6 @@ class Method(Field):
         a value The method must take a single argument ``value``, which is the
         value to deserialize.
 
-    .. versionchanged:: 2.0.0
-        Removed optional ``context`` parameter on methods. Use ``self.context`` instead.
-
     .. versionchanged:: 2.3.0
         Deprecated ``method_name`` parameter in favor of ``serialize`` and allow
         ``serialize`` to not be passed at all.
@@ -2024,14 +1998,14 @@ class Function(Field):
     def __init__(
         self,
         serialize: (
-            None
-            | typing.Callable[[typing.Any], typing.Any]
+            typing.Callable[[typing.Any], typing.Any]
             | typing.Callable[[typing.Any, dict], typing.Any]
+            | None
         ) = None,
         deserialize: (
-            None
-            | typing.Callable[[typing.Any], typing.Any]
+            typing.Callable[[typing.Any], typing.Any]
             | typing.Callable[[typing.Any, dict], typing.Any]
+            | None
         ) = None,
         **kwargs,
     ):
@@ -2065,8 +2039,6 @@ class Constant(Field):
     ``dump_only=True`` or ``load_only=True`` respectively.
 
     :param constant: The constant to return for the field attribute.
-
-    .. versionadded:: 2.0.0
     """
 
     _CHECK_ATTRIBUTE = False

{marshmallow-3.23.1 → marshmallow-3.23.3}/src/marshmallow/schema.py

@@ -280,13 +280,6 @@ class Schema(base.SchemaABC, metaclass=SchemaMeta):
 
     .. versionchanged:: 3.0.0
         `prefix` parameter removed.
-
-    .. versionchanged:: 2.0.0
-        `__validators__`, `__preprocessors__`, and `__data_handlers__` are removed in favor of
-        `marshmallow.decorators.validates_schema`,
-        `marshmallow.decorators.pre_load` and `marshmallow.decorators.post_dump`.
-        `__accessor__` and `__error_handler__` are deprecated. Implement the
-        `handle_error` and `get_attribute` methods instead.
     """
 
     TYPE_MAPPING = {
@@ -422,7 +415,7 @@ class Schema(base.SchemaABC, metaclass=SchemaMeta):
     @classmethod
     def from_dict(
         cls,
-        fields: dict[str, ma_fields.Field | type[ma_fields.Field]],
+        fields: dict[str, ma_fields.Field],
         *,
         name: str = "GeneratedSchema",
     ) -> type[Schema]:
@@ -444,11 +437,10 @@ class Schema(base.SchemaABC, metaclass=SchemaMeta):
 
         .. versionadded:: 3.0.0
         """
-        attrs = fields.copy()
-        attrs["Meta"] = type(
+        Meta = type(
             "GeneratedMeta", (getattr(cls, "Meta", object),), {"register": False}
         )
-        schema_cls = type(name, (cls,), attrs)
+        schema_cls = type(name, (cls,), {**fields.copy(), "Meta": Meta})
         return schema_cls
 
     ##### Override-able methods #####
@@ -463,8 +455,6 @@ class Schema(base.SchemaABC, metaclass=SchemaMeta):
         :param many: Value of ``many`` on dump or load.
         :param partial: Value of ``partial`` on load.
 
-        .. versionadded:: 2.0.0
-
         .. versionchanged:: 3.0.0rc9
             Receives `many` and `partial` (on deserialization) as keyword arguments.
         """
@@ -473,8 +463,6 @@ class Schema(base.SchemaABC, metaclass=SchemaMeta):
     def get_attribute(self, obj: typing.Any, attr: str, default: typing.Any):
         """Defines how to pull values from an object to serialize.
 
-        .. versionadded:: 2.0.0
-
         .. versionchanged:: 3.0.0a1
             Changed position of ``obj`` and ``attr``.
         """
@@ -508,9 +496,6 @@ class Schema(base.SchemaABC, metaclass=SchemaMeta):
         :param obj: The object(s) to serialize.
         :param bool many: `True` if ``data`` should be serialized as a collection.
         :return: A dictionary of the serialized data
-
-        .. versionchanged:: 1.0.0
-            Renamed from ``marshal``.
         """
         if many and obj is not None:
             return [self._serialize(d, many=False) for d in obj]

{marshmallow-3.23.1 → marshmallow-3.23.3}/src/marshmallow/utils.py

@@ -138,7 +138,7 @@ def get_fixed_timezone(offset: int | float | dt.timedelta) -> dt.timezone:
     if isinstance(offset, dt.timedelta):
         offset = offset.total_seconds() // 60
     sign = "-" if offset < 0 else "+"
-    hhmm = "%02d%02d" % divmod(abs(offset), 60)
+    hhmm = "{:02d}{:02d}".format(*divmod(abs(offset), 60))
     name = sign + hhmm
     return dt.timezone(dt.timedelta(minutes=offset), name)
 

marshmallow-3.23.1/docs/_static/css/sponsor-message.css

@@ -1,15 +0,0 @@
-/* Override alabaster's admonition styling, which we used for sponsored messages */
-
-div.admonition-sponsor-message p.admonition-title {
-  font-size: 18px;
-  font-style: normal;
-}
-
-p.admonition-title::after  {
-  content: "";
-}
-
-div.admonition-sponsor-message p {
-  font-size: 14px;
-  font-style: italic;
-}

marshmallow-3.23.1/docs/_static/css/versionwarning.css

@@ -1,42 +0,0 @@
-#version-warning-banner {
-  margin: 10px 0;
-  padding: 10px;
-  border-radius: 4px;
-
-  letter-spacing: 1px;
-  color: #fff;
-  text-shadow: 0 0 2px #000;
-  text-align: center;
-  font-size: 0.9em;
-
-  background: #004b6b
-    repeating-linear-gradient(
-      135deg,
-      transparent,
-      transparent 20px,
-      rgba(255, 255, 255, 0.1) 20px,
-      rgba(255, 255, 255, 0.1) 40px
-    );
-}
-
-#version-warning-banner .admonition-title {
-  font-size: inherit;
-  font-weight: bold;
-}
-
-#version-warning-banner p.admonition-title::after {
-  content: none;
-}
-
-#version-warning-banner a {
-  color: #fff;
-  border-color: #fff;
-}
-
-#version-warning-banner p {
-  display: inline;
-}
-
-div.warning {
-  border: 0;
-}

marshmallow-3.23.1/docs/marshmallow.fields.rst

@@ -1,9 +0,0 @@
-.. _api_fields:
-
-Fields
-======
-
-.. automodule:: marshmallow.fields
-    :members:
-    :private-members:
-    :autosummary: