marshmallow 3.23.3__tar.gz → 3.24.1__tar.gz

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

@@ -1,6 +1,36 @@
 Changelog
 ---------
 
+3.24.1 (2025-01-06)
+*******************
+
+Bug fixes:
+
+- Typing: Fix typing for `class_registry.get_class <marshmallow.class_registry.get_class>` (:pr:`2735`).
+
+3.24.0 (2025-01-06)
+*******************
+
+Features:
+
+- Typing: Improve typings in `marshmallow.fields` (:pr:`2723`).
+- Typing: Replace type comments with inline typings (:pr:`2718`).
+
+Bug fixes:
+
+- Typing: Fix type hint for ``nested`` parameter of `Nested <marshmallow.fields.Nested>`.
+
+Deprecations:
+
+- Custom validators should raise a `ValidationError <marshmallow.exceptions.ValidationError>` for invalid values. 
+  Returning `False`` is no longer supported .
+- Deprecate ``context`` parameter of `Schema <marshmallow.schema.Schema>` (:issue:`1826`).
+  Use `contextVars.ContextVar` to pass context data instead.
+- `Field <marshmallow.fields.Field>`, `Mapping <marshmallow.fields.Mapping>`,
+  and `Number <marshmallow.fields.Number>` should no longer be used as fields within schemas.
+  Use their subclasses instead.
+
+
 3.23.3 (2025-01-03)
 *******************
 
@@ -1053,7 +1083,7 @@ Features:
   The ``strict`` parameter is removed.
 - *Backwards-incompatible*: ``Schema().load`` and ``Schema().dump`` return ``data`` instead of a
   ``(data, errors)`` tuple (:issue:`598`).
-- *Backwards-incomaptible*: ``Schema().load(None)`` raises a
+- *Backwards-incompatible*: ``Schema().load(None)`` raises a
   ``ValidationError`` (:issue:`511`).
 
 See :ref:`upgrading_3_0` for a guide on updating your code.
@@ -1256,7 +1286,7 @@ Bug fixes:
   This is a backport of the fix in :pr:`857`. Thanks :user:`cristi23` for the
   thorough bug report and the PR.
 
-Deprecation/Removal:
+Deprecation/Removals:
 
 - Python 2.6 is no longer officially supported (:issue:`1274`).
 

{marshmallow-3.23.3 → marshmallow-3.24.1}/CONTRIBUTING.rst

@@ -1,4 +1,4 @@
-Contributing Guidelines
+Contributing guidelines
 =======================
 
 So you're interested in contributing to marshmallow or `one of our associated
@@ -7,21 +7,21 @@ welcome contributions from anyone willing to work in good faith with
 other contributors and the community (see also our
 :doc:`code_of_conduct`).
 
-Security Contact Information
+Security contact information
 ----------------------------
 
 To report a security vulnerability, please use the
 `Tidelift security contact <https://tidelift.com/security>`_.
 Tidelift will coordinate the fix and disclosure.
 
-Questions, Feature Requests, Bug Reports, and Feedback…
+Questions, feature requests, bug reports, and feedback…
 -------------------------------------------------------
 
 …should all be reported on the `Github Issue Tracker`_ .
 
 .. _`Github Issue Tracker`: https://github.com/marshmallow-code/marshmallow/issues?state=open
 
-Ways to Contribute
+Ways to contribute
 ------------------
 
 - Comment on some of marshmallow's `open issues <https://github.com/marshmallow-code/marshmallow/issues>`_ (especially those `labeled "feedback welcome" <https://github.com/marshmallow-code/marshmallow/issues?q=is%3Aopen+is%3Aissue+label%3A%22feedback+welcome%22>`_). Share a solution or workaround. Make a suggestion for how a feature can be made better. Opinions are welcome!
@@ -34,10 +34,10 @@ Ways to Contribute
 - Send a PR for an open issue (especially one `labeled "help wanted" <https://github.com/marshmallow-code/marshmallow/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22>`_). The next section details how to contribute code.
 
 
-Contributing Code
+Contributing code
 -----------------
 
-Setting Up for Local Development
+Setting up for local development
 ++++++++++++++++++++++++++++++++
 
 1. Fork marshmallow_ on Github.
@@ -63,20 +63,20 @@ Setting Up for Local Development
     # The pre-commit CLI was installed above
     $ pre-commit install --allow-missing-config
 
-Git Branch Structure
+Git branch structure
 ++++++++++++++++++++
 
-Marshmallow abides by the following branching model:
+marshmallow abides by the following branching model:
 
 ``dev``
     Current development branch. **New features should branch off here**.
 
 ``X.Y-line``
-    Maintenance branch for release ``X.Y``. **Bug fixes should be sent to the most recent release branch.** The maintainer will forward-port the fix to ``dev``. Note: exceptions may be made for bug fixes that introduce large code changes.
+    Maintenance branch for release ``X.Y``. **Bug fixes should be sent to the most recent release branch.** A maintainer will forward-port the fix to ``dev``. Note: exceptions may be made for bug fixes that introduce large code changes.
 
 **Always make a new branch for your work**, no matter how small. Also, **do not put unrelated changes in the same branch or pull request**. This makes it more difficult to merge your changes.
 
-Pull Requests
+Pull requests
 ++++++++++++++
 
 1. Create a new local branch.
@@ -134,7 +134,7 @@ Changes in the `docs/` directory will automatically trigger a rebuild.
 
 .. _contributing_examples:
 
-Contributing Examples
+Contributing examples
 +++++++++++++++++++++
 
 Have a usage example you'd like to share? A custom `Field` that others might find useful? Feel free to add it to the `examples <https://github.com/marshmallow-code/marshmallow/tree/dev/examples>`_ directory and send a pull request.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: marshmallow
-Version: 3.23.3
+Version: 3.24.1
 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>

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/code_of_conduct.rst

@@ -8,7 +8,7 @@ organization.
 
 .. _coc-when-something-happens:
 
-When Something Happens
+When something happens
 ----------------------
 
 If you see a Code of Conduct violation, follow these steps:
@@ -32,7 +32,7 @@ resolve the situation.
 recipients of the violation over the comfort of the violator.** See
 :ref:`some examples below <coc-enforcement-examples>`.
 
-Our Pledge
+Our pledge
 ----------
 
 In the interest of fostering an open and welcoming environment, we as
@@ -43,7 +43,7 @@ identity and expression, level of experience, technical preferences,
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.
 
-Our Standards
+Our standards
 -------------
 
 Examples of behavior that contributes to creating a positive environment
@@ -112,7 +112,7 @@ to maintain the comfort and safety of its members.
 
 .. _coc-other-community-standards:
 
-Other Community Standards
+Other community standards
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 As a project on GitHub, this project is additionally covered by the
@@ -123,7 +123,7 @@ Enforcement of those guidelines after violations overlapping with the
 above are the responsibility of the entities, and enforcement may happen
 in any or all of the services/communities.
 
-Maintainer Enforcement Process
+Maintainer enforcement process
 ------------------------------
 
 Once the maintainers get involved, they will follow a documented series
@@ -133,7 +133,7 @@ members. This section covers actual concrete steps.
 
 .. _coc-contacting-maintainers:
 
-Contacting Maintainers
+Contacting maintainers
 ~~~~~~~~~~~~~~~~~~~~~~
 
 As a small and young project, we don't yet have a Code of Conduct
@@ -147,7 +147,7 @@ message is noticed quickly.
 
 .. _coc-further-enforcement:
 
-Further Enforcement
+Further enforcement
 ~~~~~~~~~~~~~~~~~~~
 
 If you've already followed the :ref:`initial enforcement steps
@@ -177,7 +177,7 @@ in any social setting that puts our members at risk.
 Members expelled from events or venues with any sort of paid attendance
 will not be refunded.
 
-Who Watches the Watchers?
+Who watches the watchers?
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Maintainers and other leaders who do not follow or enforce the Code of
@@ -194,10 +194,10 @@ procedures.
 
 .. _coc-enforcement-examples:
 
-Enforcement Examples
+Enforcement examples
 --------------------
 
-The Best Case
+The best case
 ~~~~~~~~~~~~~
 
 The vast majority of situations work out like this. This interaction is
@@ -211,7 +211,7 @@ common, and generally positive.
     Alex: "oh sorry, sure." -> edits old comment to say "it was really
     confusing!"
 
-The Maintainer Case
+The maintainer case
 ~~~~~~~~~~~~~~~~~~~
 
 Sometimes, though, you need to get maintainers involved. Maintainers
@@ -248,7 +248,7 @@ something **will take priority**.
     KeeperOfCommitBits: "@patt Thanks for that. I hear you on the
     stress. Burnout sucks :/. Have a good one!"
 
-The Nope Case
+The nope case
 ~~~~~~~~~~~~~
 
     PepeTheFrog🐸: "Hi, I am a literal actual nazi and I think white

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/custom_fields.rst

@@ -1,5 +1,4 @@
-
-Custom Fields
+Custom fields
 =============
 
 There are three ways to create a custom-formatted field for a `Schema`:
@@ -10,7 +9,7 @@ There are three ways to create a custom-formatted field for a `Schema`:
 
 The method you choose will depend on the manner in which you intend to reuse the field.
 
-Creating A Field Class
+Creating a field class
 ----------------------
 
 To create a custom field class, create a subclass of :class:`marshmallow.fields.Field` and implement its :meth:`_serialize <marshmallow.fields.Field._serialize>` and/or :meth:`_deserialize <marshmallow.fields.Field._deserialize>` methods.
@@ -43,7 +42,7 @@ To create a custom field class, create a subclass of :class:`marshmallow.fields.
         created_at = fields.DateTime()
         pin_code = PinCode()
 
-Method Fields
+Method fields
 -------------
 
 A :class:`Method <marshmallow.fields.Method>` field will serialize to the value returned by a method of the Schema. The method must take an ``obj`` parameter which is the object to be serialized.
@@ -59,7 +58,7 @@ A :class:`Method <marshmallow.fields.Method>` field will serialize to the value
         def get_days_since_created(self, obj):
             return dt.datetime.now().day - obj.created_at.day
 
-Function Fields
+Function fields
 ---------------
 
 A :class:`Function <marshmallow.fields.Function>` field will serialize the value of a function that is passed directly to it. Like a :class:`Method <marshmallow.fields.Method>` field, the function must take a single argument ``obj``.
@@ -97,7 +96,7 @@ Both :class:`Function <marshmallow.fields.Function>` and :class:`Method <marshma
 
 .. _adding-context:
 
-Adding Context to `Method` and `Function` Fields
+Adding context to `Method` and `Function` fields
 ------------------------------------------------
 
 A :class:`Function <marshmallow.fields.Function>` or :class:`Method <marshmallow.fields.Method>` field may need information about its environment to know how to serialize a value.
@@ -129,7 +128,7 @@ As an example, you might want your ``UserSchema`` to output whether or not a ``U
     result["likes_bikes"]  # => True
 
 
-Customizing Error Messages
+Customizing error messages
 --------------------------
 
 Validation error messages for fields can be configured at the class or instance level.
@@ -160,8 +159,8 @@ Error messages can also be passed to a `Field's` constructor.
         )
 
 
-Next Steps
+Next steps
 ----------
 
-- Need to add schema-level validation, post-processing, or error handling behavior? See the :doc:`Extending Schemas <extending>` page.
+- Need to add schema-level validation, post-processing, or error handling behavior? See the :doc:`Extending schemas <extending>` page.
 - For example applications using marshmallow, check out the :doc:`Examples <examples>` page.

marshmallow-3.24.1/docs/dashing.json

@@ -0,0 +1,22 @@
+{
+  "name": "marshmallow",
+  "package": "marshmallow",
+  "index": "_build/index.html",
+  "selectors": {
+    "dl.class dt": {
+      "type": "Class",
+      "attr": "id"
+    },
+    "dl.exception dt": {
+      "type": "Exception",
+      "attr": "id"
+    },
+    "dl.function dt": {
+      "type": "Function",
+      "attr": "id"
+    }
+  },
+  "icon32x32": "",
+  "allowJS": false,
+  "ExternalURL": ""
+}

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/examples.rst

@@ -291,8 +291,8 @@ After registering a user and creating some todo items in the database, here is a
     }
 
 
-Inflection (Camel-casing Keys)
-==============================
+Inflection (camel-cased keys)
+=============================
 
 HTTP APIs will often use camel-cased keys for their input and output representations. This example shows how you can use the
 `Schema.on_bind_field <marshmallow.Schema.on_bind_field>` hook to automatically inflect keys.

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/extending.rst

@@ -1,9 +1,9 @@
 .. module:: marshmallow
 
-Extending Schemas
+Extending schemas
 =================
 
-Pre-processing and Post-processing Methods
+Pre-processing and post-processing methods
 ------------------------------------------
 
 Data pre-processing and post-processing methods can be registered using the `pre_load <marshmallow.decorators.pre_load>`, `post_load <marshmallow.decorators.post_load>`, `pre_dump <marshmallow.decorators.pre_dump>`, and `post_dump <marshmallow.decorators.post_dump>` decorators.
@@ -97,8 +97,7 @@ One common use case is to wrap data in a namespace upon serialization and unwrap
     user_objs = user_schema.load(users_data, many=True)
     # [<User(name='Keith Richards')>, <User(name='Charlie Watts')>]
 
-
-Raising Errors in Pre-/Post-processor Methods
+Raising errors in pre-/post-processor methods
 +++++++++++++++++++++++++++++++++++++++++++++
 
 Pre- and post-processing methods may raise a `ValidationError <marshmallow.exceptions.ValidationError>`. By default, errors will be stored on the ``"_schema"`` key in the errors dictionary.
@@ -151,8 +150,7 @@ If you want to store and error on a different key, pass the key name as the seco
         err.messages
     # {'_preprocessing': ['Input data must have a "data" key.']}
 
-
-Pre-/Post-processor Invocation Order
+Pre-/post-processor invocation order
 ++++++++++++++++++++++++++++++++++++
 
 In summary, the processing pipeline for deserialization is as follows:
@@ -215,10 +213,7 @@ The pipeline for serialization is similar, except that the ``pass_many=True`` pr
             def step2(self, data, **kwargs):
                 do_step2(data)
 
-
-.. _schemavalidation:
-
-Schema-level Validation
+Schema-level validation
 -----------------------
 
 You can register schema-level validation functions for a :class:`Schema` using the `marshmallow.validates_schema <marshmallow.decorators.validates_schema>` decorator. By default, schema-level validation errors will be stored on the ``_schema`` key of the errors dictionary.
@@ -245,7 +240,7 @@ You can register schema-level validation functions for a :class:`Schema` using t
         err.messages["_schema"]
     # => ["field_a must be greater than field_b"]
 
-Storing Errors on Specific Fields
+Storing errors on specific fields
 +++++++++++++++++++++++++++++++++
 
 It is possible to report errors on fields and subfields using a `dict`.
@@ -300,8 +295,7 @@ When multiple schema-leval validator return errors, the error structures are mer
     #     ]
     #    }
 
-
-Using Original Input Data
+Using original input data
 -------------------------
 
 If you want to use the original, unprocessed input, you can add ``pass_original=True`` to
@@ -332,7 +326,7 @@ If you want to use the original, unprocessed input, you can add ``pass_original=
 
    The default behavior for unspecified fields can be controlled with the ``unknown`` option, see :ref:`Handling Unknown Fields <unknown>` for more information.
 
-Overriding How Attributes Are Accessed
+Overriding how attributes are accessed
 --------------------------------------
 
 By default, marshmallow uses `utils.get_value` to pull attributes from various types of objects for serialization. This will work for *most* use cases.
@@ -350,7 +344,7 @@ However, if you want to specify how values are accessed from an object, you can
         def get_attribute(self, obj, key, default):
             return obj.get(key, default)
 
-Custom Error Handling
+Custom error handling
 ---------------------
 
 By default, :meth:`Schema.load` will raise a :exc:`ValidationError <marshmallow.exceptions.ValidationError>` if passed invalid data.
@@ -379,15 +373,14 @@ You can specify a custom error-handling function for a :class:`Schema` by overri
     schema = UserSchema()
     schema.load({"email": "invalid-email"})  # raises AppError
 
-
-Custom "class Meta" Options
+Custom "class Meta" options
 ---------------------------
 
 ``class Meta`` options are a way to configure and modify a :class:`Schema's <Schema>` behavior. See the :class:`API docs <Schema.Meta>` for a listing of available options.
 
 You can add custom ``class Meta`` options by subclassing :class:`SchemaOpts`.
 
-Example: Enveloping, Revisited
+Example: Enveloping, revisited
 ++++++++++++++++++++++++++++++
 
 Let's build upon the example above for adding an envelope to serialized output. This time, we will allow the envelope key to be customizable with ``class Meta`` options.
@@ -461,7 +454,7 @@ Our application schemas can now inherit from our custom schema class.
     result = ser.dump(user)
     result  # {"user": {"name": "Keith", "email": "keith@stones.com"}}
 
-Using Context
+Using context
 -------------
 
 The ``context`` attribute of a `Schema` is a general-purpose store for extra information that may be needed for (de)serialization. It may be used in both ``Schema`` and ``Field`` methods.
@@ -474,7 +467,7 @@ The ``context`` attribute of a `Schema` is a general-purpose store for extra inf
     schema.context["request"] = request
     schema.dump(user)
 
-Custom Error Messages
+Custom error messages
 ---------------------
 
 To customize the schema-level error messages that `load <marshmallow.Schema.load>` and `loads <marshmallow.Schema.loads>` use when raising a `ValidationError <marshmallow.exceptions.ValidationError>`, override the `error_messages <marshmallow.Schema.error_messages>` class variable:

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/install.rst

@@ -5,7 +5,7 @@ Installation
 
 **marshmallow** has no external dependencies other than the `packaging` library.
 
-Installing/Upgrading from the PyPI
+Installing/upgrading from the PyPI
 ----------------------------------
 
 To install the latest stable version from the PyPI:
@@ -20,7 +20,7 @@ To install the latest pre-release version from the PyPI:
 
     $ pip install -U marshmallow --pre
 
-Get the Bleeding Edge Version
+Get the bleeding edge version
 -----------------------------
 
 To get the latest development version of marshmallow, run

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/marshmallow.fields.rst

@@ -9,7 +9,7 @@ Base Field Class
 .. autoclass:: marshmallow.fields.Field
     :private-members:
 
-Field Subclasses
+Field subclasses
 ----------------
 
 .. automodule:: marshmallow.fields

{marshmallow-3.23.3 → marshmallow-3.24.1}/docs/nesting.rst

@@ -1,4 +1,4 @@
-Nesting Schemas
+Nesting schemas
 ===============
 
 Schemas can be nested to represent relationships between objects (e.g. foreign key relationships). For example, a ``Blog`` may have an author represented by a User object.
@@ -63,7 +63,7 @@ The serialized blog will have the nested user representation.
 
 .. _specifying-nested-fields:
 
-Specifying Which Fields to Nest
+Specifying which fields to nest
 -------------------------------
 
 You can explicitly specify which attributes of the nested objects you want to (de)serialize with the ``only`` argument to the schema.
@@ -129,7 +129,7 @@ You can replace nested data with a single value (or flat list of values if ``man
 
 .. _partial-loading:
 
-Partial Loading
+Partial loading
 ---------------
 
 Nested schemas also inherit the ``partial`` parameter of the parent ``load`` call.
@@ -165,7 +165,7 @@ You can specify a subset of the fields to allow partial loading using dot delimi
 
 .. _two-way-nesting:
 
-Two-way Nesting
+Two-way nesting
 ---------------
 
 If you have two objects that nest each other, you can pass a callable to `Nested <marshmallow.fields.Nested>`.
@@ -258,7 +258,7 @@ This is useful for avoiding circular imports when your schemas are located in di
 
 .. _self-nesting:
 
-Nesting A Schema Within Itself
+Nesting a schema within itself
 ------------------------------
 
 If the object to be marshalled has a relationship to an object of the same type, you can nest the `Schema` within itself by passing a callable that returns an instance of the same schema.
@@ -303,7 +303,7 @@ If the object to be marshalled has a relationship to an object of the same type,
     #     }
     # }
 
-Next Steps
+Next steps
 ----------
 
 - Want to create your own field type? See the :doc:`Custom Fields <custom_fields>` page.