👷 Use own workflow for creating and publishing new releases

This should help users see the exact line they wrote that triggered the warning.

.github/workflows/ci.yaml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: master
+    tags: 'v*.*.*'
+
+jobs:
+  test:
+    name: Test
+    uses: daniil-berg/reusable-workflows/.github/workflows/python-test.yaml@v0.2.1
+    with:
+      versions: '["3.9", "3.10", "3.11"]'
+      unittest-command: 'scripts/test.sh'
+      coverage-command: 'scripts/cov.sh'
+      unittest-requirements: "-e '.[dev]'"
+      typecheck-command: 'scripts/typecheck.sh'
+      typecheck-requirements: '-Ur requirements/dev.txt'
+      typecheck-all-versions: true
+      lint-command: 'scripts/lint.sh'
+      lint-requirements: '-Ur requirements/dev.txt'
+
+  release:
+    name: Release
+    if: ${{ github.ref_type == 'tag' }}
+    needs: test
+    uses: daniil-berg/reusable-workflows/.github/workflows/python-release.yaml@v0.2.1
+    with:
+      git-ref: ${{ github.ref_name }}
+    secrets:
+      release-token: ${{ secrets.TOKEN_GITHUB_CREATE_RELEASE }}
+      publish-token: ${{ secrets.TOKEN_PYPI_PROJECT }}
+    permissions:
+      contents: write

.gitignore

@@ -21,5 +21,5 @@ __pycache__/
 # Testing:
 /.coverage
 
-# mypy:
+# Miscellaneous cache:
-.mypy_cache/
+.cache/

docs/index.md

@@ -10,19 +10,18 @@
 
 ---
 
-Extension for <a href="https://github.com/marshmallow-code/marshmallow" target="_blank">`marshmallow`</a> to make <a href="https://marshmallow.readthedocs.io/en/stable/quickstart.html#deserializing-to-objects" target="_blank">deserialization to objects</a> easier and improve type safety.
+Extension for <a href="https://github.com/marshmallow-code/marshmallow" target="_blank">**`marshmallow`**</a> to make <a href="https://marshmallow.readthedocs.io/en/stable/quickstart.html#deserializing-to-objects" target="_blank">deserialization to objects</a> easier and improve type safety.
 
 The main `GenericSchema` class extends <a href="https://marshmallow.readthedocs.io/en/stable/marshmallow.schema.html#marshmallow.schema.Schema" target="_blank">`marshmallow.Schema`</a> making it **generic** in terms of the class that data should be deserialized to, when calling <a href="https://marshmallow.readthedocs.io/en/stable/marshmallow.schema.html#marshmallow.schema.Schema.load" target="_blank">`load`/`loads`</a>.
 
 With `GenericSchema` there is no need to explicitly write `post_load` hooks to initialize the object anymore. 🎉
 
-If the "model" class is (for example) `User`, it just needs to be passed as the type argument, when subclassing `GenericSchema`. Depending on whether `many` is `True` or not, the output of the `load`/`loads` method will then be automatically inferred as either `User` or `list[User]` by any competent type checker. ✨
+If the "model" class is (for example) `User`, it just needs to be passed as the type argument, when subclassing `GenericSchema`. The output of the `load`/`loads` method will then be automatically inferred as either `User` or `list[User]` (depending on whether `many` is `True` or not) by any competent type checker. ✨
 
 ## Usage Example
 
 ```python
-from marshmallow import fields
+from marshmallow_generic import GenericSchema, fields
-from marshmallow_generic import GenericSchema
 
 
 class User:

mkdocs.yaml

@@ -30,8 +30,11 @@ plugins:
       handlers:
         python:
           options:
+            line_length: 80
             show_source: false
             show_root_toc_entry: false
+            separate_signature: true
+            show_signature_annotations: true
           import:
             - https://marshmallow.readthedocs.io/en/stable/objects.inv
 

pyproject.toml

@@ -20,7 +20,7 @@ keywords = [
 ]
 license = { text = "Apache Software License Version 2.0" }
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -37,34 +37,32 @@ dynamic = [
 ]
 
 [project.optional-dependencies]
-full = [
-
-]
 dev = [
-    "black",
+    "black==23.3.0",
-    "build",
+    "build==0.10.0",
-    "coverage[toml]",
+    "coverage[toml]==7.2.3",
-    "isort",
+    "isort==5.12.0",
-    "mkdocs-material",
+    "mkdocs-material==9.1.6",
-    "mkdocstrings[python]",
+    "mkdocstrings[python]==0.21.2",
-    "mypy",
+    "mypy==1.2.0",
-    "ruff",
+    "ruff==0.0.262",
 ]
 
 [project.urls]
-repository = "https://github.com/daniil-berg/marshmallow-generic"
+"Repository" = "https://github.com/daniil-berg/marshmallow-generic"
-bug_tracker = "https://github.com/daniil-berg/marshmallow-generic/issues"
+"Issue Tracker" = "https://github.com/daniil-berg/marshmallow-generic/issues"
-documentation = "http://daniil-berg.github.io/marshmallow-generic"
+"Documentation" = "http://daniil-berg.github.io/marshmallow-generic"
 
 [tool.setuptools.dynamic]
 dependencies = { file = "requirements/common.txt" }
-readme = { file = ["README.md"] }
+readme = { file = ["README.md"], content-type = "text/markdown" }
-version = {attr = "marshmallow_generic.__version__"}
+version = { attr = "marshmallow_generic.__version__" }
 
 #########################
 # Static type checking: #
 
 [tool.mypy]
+cache_dir = ".cache/mypy"
 files = [
     "src/",
     "tests/",
@@ -80,6 +78,7 @@ plugins = [
 # Unit test coverage: #
 
 [tool.coverage.run]
+data_file = ".cache/coverage"
 source = [
     "src/",
 ]
@@ -105,6 +104,7 @@ omit = [
 # Linting and style checking: #
 
 [tool.ruff]
+cache-dir = ".cache/ruff"
 select = [
     "E",   # pycodestyle errors
     "W",   # pycodestyle warnings

requirements/common.txt

@@ -1 +1 @@
-marshmallow
+marshmallow>=3.12.0

requirements/dev.txt

@@ -1,9 +1,9 @@
 -r common.txt
-black
+black==23.3.0
-build
+build==0.10.0
-coverage[toml]
+coverage[toml]==7.2.3
-isort
+isort==5.12.0
-mkdocs-material
+mkdocs-material==9.1.6
-mkdocstrings[python]
+mkdocstrings[python]==0.21.2
-mypy
+mypy==1.2.0
-ruff
+ruff==0.0.262

scripts/ci.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+# Runs full CI pipeline (test, typecheck, lint).
+
+typeset scripts_dir="$(dirname $(realpath $0))"
+
+source "${scripts_dir}/util.sh"
+
+"${scripts_dir}/test.sh"
+"${scripts_dir}/typecheck.sh"
+"${scripts_dir}/lint.sh"
+
+echo -e "${background_black}${bold_green}✅ 🎉 All checks passed!${color_reset}"

scripts/cov.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# Runs unit tests.
+# If successful, prints only the coverage percentage.
+# If an error occurs, prints the entire unit tests progress output.
+
+source "$(dirname $(realpath $0))/util.sh"
+
+coverage erase
+run_and_capture coverage run
+coverage report | awk '$1 == "TOTAL" {print $NF; exit}'

scripts/lint.sh

@@ -1,18 +1,17 @@
 #!/usr/bin/env bash
-# Runs type checker and linters.
+# Runs various linters.
 
-# Ensure that we return to the current working directory
+source "$(dirname $(realpath $0))/util.sh"
-# and exit the script immediately in case of an error:
-trap "cd $(realpath ${PWD}); exit 1" ERR
-# Change into project root directory:
-cd "$(dirname $(dirname $(realpath $0)))"
-
-echo 'Performing type checks...'
-mypy
-echo
 
 echo 'Linting source and test files...'
+
+echo '  isort - consistent imports'
 isort src/ tests/ --check-only
+
+echo '  ruff - extensive linting'
 ruff src/ tests/
-black src/ tests/ --check
+
-echo -e 'No issues found.'
+echo '  black - consistent style'
+run_and_capture black src/ tests/ --check
+
+echo -e "${bold_green}No issues found${color_reset}\n"

scripts/test.sh

@@ -1,17 +1,12 @@
 #!/usr/bin/env bash
-# Runs unit tests and prints only coverage percentage, if successful.
+# Runs unit tests and reports coverage percentage.
-# If an error occurs, prints the entire unit tests progress output.
 
-# Ensure that we return to the current working directory in case of an error:
+source "$(dirname $(realpath $0))/util.sh"
-trap "cd $(realpath ${PWD})" ERR
-# Change into project root directory:
-cd "$(dirname $(dirname $(realpath $0)))"
 
-coverage erase
+echo 'Running unit tests...'
-# Capture the test progression in a variable:
+coverage run
-typeset progress
+typeset percentage
-progress=$(coverage run 2>&1)
+typeset color
-# If tests failed or produced errors, write progress/messages to stderr and exit:
+percentage="$(coverage report | awk '$1 == "TOTAL" {print $NF; exit}')"
-[[ $? -eq 0 ]] || { >&2 echo "${progress}"; exit 1; }
+[[ $percentage == "100%" ]] && color="${bold_green}" || color="${yellow}"
-# Otherwise extract the total coverage percentage from the produced report and write it to stdout:
+echo -e "${color}${percentage} coverage${color_reset}\n"
-coverage report | awk '$1 == "TOTAL" {print $NF; exit}'

scripts/typecheck.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Runs type checker.
+
+source "$(dirname $(realpath $0))/util.sh"
+
+echo 'Performing type checks...'
+mypy
+echo

scripts/util.sh

@@ -0,0 +1,20 @@
+run_and_capture() {
+  # Captures stderr of any command passed to it
+  # and releases it only if the command exits with a non-zero code.
+  typeset output
+  output=$($@ 2>&1)
+  typeset exit_status=$?
+  [[ $exit_status == 0 ]] || >&2 echo "${output}"
+  return $exit_status
+}
+
+# Ensure that we return to the current working directory
+# and exit the script immediately in case of an error:
+trap "cd $(realpath ${PWD}); exit 1" ERR
+# Change into project root directory:
+cd "$(dirname $(dirname $(realpath $0)))"
+
+typeset background_black='\033[40m'
+typeset bold_green='\033[1;92m'
+typeset yellow='\033[0;33m'
+typeset color_reset='\033[0m'

src/marshmallow_generic/__init__.py

@@ -13,11 +13,45 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License."""
 
-__version__ = "0.0.1"
+__version__ = "1.0.0"
 
 __doc__ = """
 Generic schema with full typing support and minimal boilerplate.
 """
 
-from .decorators import post_load
+__all__ = [
-from .schema import GenericSchema
+    # Custom:
+    "GenericSchema",
+    "post_load",
+    # Re-exports from marshmallow:
+    "EXCLUDE",
+    "INCLUDE",
+    "RAISE",
+    "Schema",
+    "SchemaOpts",
+    "fields",
+    "validates",
+    "validates_schema",
+    "pre_dump",
+    "post_dump",
+    "pre_load",
+    # "post_load",
+    "pprint",
+    "ValidationError",
+    "missing",
+]
+
+from marshmallow import fields
+from marshmallow.decorators import (  # `post_load` overloaded
+    post_dump,
+    pre_dump,
+    pre_load,
+    validates,
+    validates_schema,
+)
+from marshmallow.exceptions import ValidationError
+from marshmallow.schema import Schema, SchemaOpts
+from marshmallow.utils import EXCLUDE, INCLUDE, RAISE, missing, pprint
+
+from marshmallow_generic.decorators import post_load
+from marshmallow_generic.schema import GenericSchema

src/marshmallow_generic/_util.py

@@ -1,10 +1,28 @@
-from typing import Any, Generic, Optional, TypeVar, get_args, get_origin
+from typing import (
+    Any,
+    Generic,
+    Literal,
+    Optional,
+    TypeVar,
+    Union,
+    get_args,
+    get_origin,
+    overload,
+)
 
-_T = TypeVar("_T")
+_T0 = TypeVar("_T0")
+_T1 = TypeVar("_T1")
+_T2 = TypeVar("_T2")
+_T3 = TypeVar("_T3")
+_T4 = TypeVar("_T4")
 
 
-class GenericInsightMixin(Generic[_T]):
+class GenericInsightMixin(Generic[_T0, _T1, _T2, _T3, _T4]):
-    _type_arg: Optional[type[_T]] = None
+    _type_arg_0: Optional[type[_T0]] = None
+    _type_arg_1: Optional[type[_T1]] = None
+    _type_arg_2: Optional[type[_T2]] = None
+    _type_arg_3: Optional[type[_T3]] = None
+    _type_arg_4: Optional[type[_T4]] = None
 
     @classmethod
     def __init_subclass__(cls, **kwargs: Any) -> None:
@@ -14,17 +32,70 @@ class GenericInsightMixin(Generic[_T]):
             origin = get_origin(base)
             if origin is None or not issubclass(origin, GenericInsightMixin):
                 continue
-            type_arg = get_args(base)[0]
+            type_args = get_args(base)
-            # Do not set the attribute for GENERIC subclasses!
+            for idx, arg in enumerate(type_args):
-            if not isinstance(type_arg, TypeVar):
+                # Do not set the attribute for generics:
-                cls._type_arg = type_arg
+                if isinstance(arg, TypeVar):
-                return
+                    continue
+                # Do not set `NoneType`:
+                if isinstance(arg, type) and isinstance(None, arg):
+                    continue
+                setattr(cls, f"_type_arg_{idx}", arg)
+            return
 
     @classmethod
-    def _get_type_arg(cls) -> type[_T]:
+    @overload
+    def _get_type_arg(cls, idx: Literal[0]) -> type[_T0]:
+        ...
+
+    @classmethod
+    @overload
+    def _get_type_arg(cls, idx: Literal[1]) -> type[_T1]:
+        ...
+
+    @classmethod
+    @overload
+    def _get_type_arg(cls, idx: Literal[2]) -> type[_T2]:
+        ...
+
+    @classmethod
+    @overload
+    def _get_type_arg(cls, idx: Literal[3]) -> type[_T3]:
+        ...
+
+    @classmethod
+    @overload
+    def _get_type_arg(cls, idx: Literal[4]) -> type[_T4]:
+        ...
+
+    @classmethod
+    def _get_type_arg(
+        cls,
+        idx: Literal[0, 1, 2, 3, 4],
+    ) -> Union[type[_T0], type[_T1], type[_T2], type[_T3], type[_T4]]:
         """Returns the type argument of the class (if specified)."""
-        if cls._type_arg is None:
+        if idx == 0:
+            type_ = cls._type_arg_0
+        elif idx == 1:
+            type_ = cls._type_arg_1
+        elif idx == 2:  # noqa: PLR2004
+            type_ = cls._type_arg_2
+        elif idx == 3:  # noqa: PLR2004
+            type_ = cls._type_arg_3
+        elif idx == 4:  # noqa: PLR2004
+            type_ = cls._type_arg_4
+        else:
+            raise ValueError("Only 5 type parameters available")
+        if type_ is None:
             raise AttributeError(
-                f"{cls.__name__} is generic; type argument unspecified"
+                f"{cls.__name__} is generic; type argument {idx} unspecified"
             )
-        return cls._type_arg
+        return type_
+
+
+class GenericInsightMixin1(GenericInsightMixin[_T0, None, None, None, None]):
+    pass
+
+
+class GenericInsightMixin2(GenericInsightMixin[_T0, _T1, None, None, None]):
+    pass

src/marshmallow_generic/schema.py

@@ -7,16 +7,22 @@ documentation of [`marshmallow.Schema`][marshmallow.Schema].
 
 from collections.abc import Iterable, Mapping, Sequence
 from typing import TYPE_CHECKING, Any, Literal, Optional, TypeVar, Union, overload
+from warnings import warn
 
 from marshmallow import Schema
 
-from ._util import GenericInsightMixin
+from ._util import GenericInsightMixin1
 from .decorators import post_load
 
 Model = TypeVar("Model")
 
+MANY_SCHEMA_UNSAFE = (
+    "Changing `many` schema-wide breaks type safety. "
+    "Use the the `many` parameter of specific methods (like `load`) instead."
+)
 
-class GenericSchema(GenericInsightMixin[Model], Schema):
+
+class GenericSchema(GenericInsightMixin1[Model], Schema):
     """
     Generic schema parameterized by a **`Model`** class.
 
@@ -43,19 +49,99 @@ class GenericSchema(GenericInsightMixin[Model], Schema):
     ```
     """
 
+    def __init__(
+        self,
+        *,
+        only: Union[Sequence[str], set[str], None] = None,
+        exclude: Union[Sequence[str], set[str]] = (),
+        context: Union[dict[str, Any], None] = None,
+        load_only: Union[Sequence[str], set[str]] = (),
+        dump_only: Union[Sequence[str], set[str]] = (),
+        partial: Union[bool, Sequence[str], set[str]] = False,
+        unknown: Optional[str] = None,
+        many: bool = False,  # usage discouraged
+    ) -> None:
+        """
+        Emits a warning, if the `many` argument is not `False`.
+
+        Otherwise the same as in [`marshmallow.Schema`][marshmallow.Schema].
+
+        Args:
+            only:
+                Whitelist of the declared fields to select when instantiating
+                the Schema. If `None`, all fields are used. Nested fields can
+                be represented with dot delimiters.
+            exclude:
+                Blacklist of the declared fields to exclude when instantiating
+                the Schema. If a field appears in both `only` and `exclude`,
+                it is not used. Nested fields can be represented with dot
+                delimiters.
+            context:
+                Optional context passed to
+                [`Method`][marshmallow.fields.Method] and
+                [`Function`][marshmallow.fields.Function] fields.
+            load_only:
+                Fields to skip during serialization (write-only fields)
+            dump_only:
+                Fields to skip during deserialization (read-only fields)
+            partial:
+                Whether to ignore missing fields and not require any fields
+                declared. Propagates down to
+                [`Nested`][marshmallow.fields.Nested] fields as well. If its
+                value is an iterable, only missing fields listed in that
+                iterable will be ignored. Use dot delimiters to specify nested
+                fields.
+            unknown:
+                Whether to exclude, include, or raise an error for unknown
+                fields in the data. Use `EXCLUDE`, `INCLUDE` or `RAISE`.
+            many:
+                !!! warning
+                    Changing this option schema-wide undermines the type
+                    safety that this class aims to provide. Passing `True`
+                    will therefore trigger a warning. You should instead use
+                    the method-specific `many` parameter, when calling
+                    [`dump`][marshmallow_generic.GenericSchema.dump]/
+                    [`dumps`][marshmallow_generic.GenericSchema.dumps] or
+                    [`load`][marshmallow_generic.GenericSchema.load]/
+                    [`loads`][marshmallow_generic.GenericSchema.loads].
+        """
+        self._pre_init = True
+        super().__init__(
+            only=only,
+            exclude=exclude,
+            many=many,
+            context=context,
+            load_only=load_only,
+            dump_only=dump_only,
+            partial=partial,
+            unknown=unknown,
+        )
+        self._pre_init = False
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """
+        Warns, when trying to set `many` to anything other than `False`.
+
+        Otherwise the same the normal
+        [`object.__setattr__`](https://docs.python.org/3/reference/datamodel.html#object.__setattr__).
+        """
+        if name == "many" and value is not False:
+            warn(MANY_SCHEMA_UNSAFE, stacklevel=4 if self._pre_init else 2)
+        super().__setattr__(name, value)
+
     @post_load
     def instantiate(self, data: dict[str, Any], **_kwargs: Any) -> Model:
         """
         Unpacks `data` into the constructor of the specified **`Model`**.
 
-        Registered as a [`@post_load`]
+        Registered as a
-        [marshmallow_generic.decorators.post_load] hook for the schema.
+        [`@post_load`][marshmallow_generic.decorators.post_load]
+        hook for the schema.
 
         !!! warning
-            You should probably **not** use this method directly;
+            You should probably not use this method directly. No parsing,
-            no parsing, transformation or validation of any kind is done
+            transformation or validation of any kind is done in this method.
-            in this method. The `data` passed to the **`Model`** constructor
+            The `data` is passed to the **`Model`** constructor "as is".
-            "as is".
 
         Args:
             data:
@@ -65,10 +151,90 @@ class GenericSchema(GenericInsightMixin[Model], Schema):
         Returns:
             Instance of the schema's **`Model`** initialized with `**data`
         """
-        return self._get_type_arg()(**data)
+        return self._get_type_arg(0)(**data)
 
     if TYPE_CHECKING:
 
+        @overload  # type: ignore[override]
+        def dump(
+            self,
+            obj: Iterable[Model],
+            *,
+            many: Literal[True],
+        ) -> list[dict[str, Any]]:
+            ...
+
+        @overload
+        def dump(
+            self,
+            obj: Model,
+            *,
+            many: Optional[Literal[False]] = None,
+        ) -> dict[str, Any]:
+            ...
+
+        def dump(
+            self,
+            obj: Union[Model, Iterable[Model]],
+            *,
+            many: Optional[bool] = None,
+        ) -> Union[dict[str, Any], list[dict[str, Any]]]:
+            """
+            Serializes **`Model`** objects to native Python data types.
+
+            Same as
+            [`marshmallow.Schema.dump`][marshmallow.schema.Schema.dump]
+            at runtime.
+
+            Annotations ensure that type checkers will infer the return type
+            correctly based on the `many` argument, and also enforce the `obj`
+            argument to be an a `list` of **`Model`** instances, if `many` is
+            set to `True` or a single instance of it, if `many` is `False`
+            (or omitted).
+
+            Args:
+                obj:
+                    The object or iterable of objects to serialize
+                many:
+                    Whether to serialize `obj` as a collection. If `None`, the
+                    value for `self.many` is used.
+
+            Returns:
+                (dict[str, Any]): if `many` is set to `False`
+                (list[dict[str, Any]]): if `many` is set to `True`
+            """
+            ...
+
+        @overload  # type: ignore[override]
+        def dumps(
+            self,
+            obj: Iterable[Model],
+            *args: Any,
+            many: Literal[True],
+            **kwargs: Any,
+        ) -> str:
+            ...
+
+        @overload
+        def dumps(
+            self,
+            obj: Model,
+            *args: Any,
+            many: Optional[Literal[False]] = None,
+            **kwargs: Any,
+        ) -> str:
+            ...
+
+        def dumps(
+            self,
+            obj: Union[Model, Iterable[Model]],
+            *args: Any,
+            many: Optional[bool] = None,
+            **kwargs: Any,
+        ) -> str:
+            """Same as [`dump`][marshmallow_generic.GenericSchema.dump], but returns a JSON-encoded string."""
+            ...
+
         @overload  # type: ignore[override]
         def load(
             self,
@@ -102,10 +268,10 @@ class GenericSchema(GenericInsightMixin[Model], Schema):
             """
             Deserializes data to objects of the specified **`Model`** class.
 
-            Same as [`marshmallow.Schema.load`]
+            Same as
-            [marshmallow.schema.Schema.load] at runtime, but data will always
+            [`marshmallow.Schema.load`][marshmallow.schema.Schema.load] at
-            pass through the [`instantiate`]
+            runtime, but data will always pass through the
-            [marshmallow_generic.schema.GenericSchema.instantiate]
+            [`instantiate`][marshmallow_generic.schema.GenericSchema.instantiate]
             hook after deserialization.
 
             Annotations ensure that type checkers will infer the return type
@@ -119,11 +285,11 @@ class GenericSchema(GenericInsightMixin[Model], Schema):
                     the value for `self.many` is used.
                 partial:
                     Whether to ignore missing fields and not require any
-                    fields declared. Propagates down to [`Nested`]
+                    fields declared. Propagates down to
-                    [marshmallow.fields.Nested] fields as well. If its value
+                    [`Nested`][marshmallow.fields.Nested] fields as well. If
-                    is an iterable, only missing fields listed in that
+                    its value is an iterable, only missing fields listed in
-                    iterable will be ignored. Use dot delimiters to specify
+                    that iterable will be ignored. Use dot delimiters to
-                    nested fields.
+                    specify nested fields.
                 unknown:
                     Whether to exclude, include, or raise an error for unknown
                     fields in the data. Use `EXCLUDE`, `INCLUDE` or `RAISE`.
@@ -171,10 +337,10 @@ class GenericSchema(GenericInsightMixin[Model], Schema):
             """
             Deserializes data to objects of the specified **`Model`** class.
 
-            Same as [`marshmallow.Schema.loads`]
+            Same as
-            [marshmallow.schema.Schema.loads] at runtime, but data will always
+            [`marshmallow.Schema.loads`][marshmallow.schema.Schema.loads] at
-            pass through the [`instantiate`]
+            runtime, but data will always pass through the
-            [marshmallow_generic.schema.GenericSchema.instantiate]
+            [`instantiate`][marshmallow_generic.schema.GenericSchema.instantiate]
             hook after deserialization.
 
             Annotations ensure that type checkers will infer the return type
@@ -188,11 +354,11 @@ class GenericSchema(GenericInsightMixin[Model], Schema):
                     the value for `self.many` is used.
                 partial:
                     Whether to ignore missing fields and not require any
-                    fields declared. Propagates down to [`Nested`]
+                    fields declared. Propagates down to
-                    [marshmallow.fields.Nested] fields as well. If its value
+                    [`Nested`][marshmallow.fields.Nested] fields as well. If
-                    is an iterable, only missing fields listed in that
+                    its value is an iterable, only missing fields listed in
-                    iterable will be ignored. Use dot delimiters to specify
+                    that iterable will be ignored. Use dot delimiters to
-                    nested fields.
+                    specify nested fields.
                 unknown:
                     Whether to exclude, include, or raise an error for unknown
                     fields in the data. Use `EXCLUDE`, `INCLUDE` or `RAISE`.

tests/test__util.py

@@ -12,7 +12,11 @@ class GenericInsightMixinTestCase(TestCase):
         mock_super.return_value = MagicMock(__init_subclass__=mock_super_meth)
 
         # Should be `None` by default:
-        self.assertIsNone(_util.GenericInsightMixin._type_arg)  # type: ignore[misc]
+        self.assertIsNone(_util.GenericInsightMixin._type_arg_0)  # type: ignore[misc]
+        self.assertIsNone(_util.GenericInsightMixin._type_arg_1)  # type: ignore[misc]
+        self.assertIsNone(_util.GenericInsightMixin._type_arg_2)  # type: ignore[misc]
+        self.assertIsNone(_util.GenericInsightMixin._type_arg_3)  # type: ignore[misc]
+        self.assertIsNone(_util.GenericInsightMixin._type_arg_4)  # type: ignore[misc]
 
         # If the mixin type argument was not specified (still generic),
         # ensure that the attribute remains `None` on the subclass:
@@ -24,30 +28,55 @@ class GenericInsightMixinTestCase(TestCase):
         class Bar(Generic[t]):
             pass
 
-        class TestSchema1(Bar[str], _util.GenericInsightMixin[t]):
+        class TestCls(Bar[str], _util.GenericInsightMixin[t, None, int, str, bool]):
             pass
 
-        self.assertIsNone(TestSchema1._type_arg)  # type: ignore[misc]
+        self.assertIsNone(TestCls._type_arg_0)  # type: ignore[misc]
+        self.assertIsNone(TestCls._type_arg_1)  # type: ignore[misc]
+        self.assertIs(int, TestCls._type_arg_2)  # type: ignore[misc]
+        self.assertIs(str, TestCls._type_arg_3)  # type: ignore[misc]
+        self.assertIs(bool, TestCls._type_arg_4)  # type: ignore[misc]
         mock_super.assert_called_once()
         mock_super_meth.assert_called_once_with()
 
         mock_super.reset_mock()
         mock_super_meth.reset_mock()
 
-        # If the mixin type argument was specified,
+        # If the mixin type arguments were omitted,
-        # ensure it was assigned to the attribute on the child class:
+        # ensure the attributes remained `None`:
 
-        class TestSchema2(Bar[str], _util.GenericInsightMixin[Foo]):
+        class UnspecifiedCls(_util.GenericInsightMixin):  # type: ignore[type-arg]
             pass
 
-        self.assertIs(Foo, TestSchema2._type_arg)  # type: ignore[misc]
+        self.assertIsNone(UnspecifiedCls._type_arg_0)  # type: ignore[misc]
+        self.assertIsNone(UnspecifiedCls._type_arg_1)  # type: ignore[misc]
+        self.assertIsNone(UnspecifiedCls._type_arg_2)  # type: ignore[misc]
+        self.assertIsNone(UnspecifiedCls._type_arg_3)  # type: ignore[misc]
+        self.assertIsNone(UnspecifiedCls._type_arg_4)  # type: ignore[misc]
         mock_super.assert_called_once()
         mock_super_meth.assert_called_once_with()
 
     def test__get_type_arg(self) -> None:
         with self.assertRaises(AttributeError):
-            _util.GenericInsightMixin._get_type_arg()
+            _util.GenericInsightMixin._get_type_arg(0)
 
-        _type = object()
+        _type_0 = object()
-        with patch.object(_util.GenericInsightMixin, "_type_arg", new=_type):
+        _type_1 = object()
-            self.assertIs(_type, _util.GenericInsightMixin._get_type_arg())
+        _type_2 = object()
+        _type_3 = object()
+        _type_4 = object()
+        with patch.multiple(
+            _util.GenericInsightMixin,
+            _type_arg_0=_type_0,
+            _type_arg_1=_type_1,
+            _type_arg_2=_type_2,
+            _type_arg_3=_type_3,
+            _type_arg_4=_type_4,
+        ):
+            self.assertIs(_type_0, _util.GenericInsightMixin._get_type_arg(0))
+            self.assertIs(_type_1, _util.GenericInsightMixin._get_type_arg(1))
+            self.assertIs(_type_2, _util.GenericInsightMixin._get_type_arg(2))
+            self.assertIs(_type_3, _util.GenericInsightMixin._get_type_arg(3))
+            self.assertIs(_type_4, _util.GenericInsightMixin._get_type_arg(4))
+            with self.assertRaises(ValueError):
+                _util.GenericInsightMixin._get_type_arg(5)  # type: ignore[call-overload]

tests/test_schema.py

@@ -1,3 +1,4 @@
+from typing import Any
 from unittest import TestCase
 from unittest.mock import MagicMock, patch
 
@@ -5,6 +6,33 @@ from marshmallow_generic import _util, schema
 
 
 class GenericSchemaTestCase(TestCase):
+    @patch("marshmallow.schema.Schema.__init__")
+    def test___init__(self, mock_super_init: MagicMock) -> None:
+        class Foo:
+            pass
+
+        kwargs: dict[str, Any] = {
+            "only": object(),
+            "exclude": object(),
+            "context": object(),
+            "load_only": object(),
+            "dump_only": object(),
+            "partial": object(),
+            "unknown": object(),
+            "many": object(),
+        }
+        schema.GenericSchema[Foo](**kwargs)
+        mock_super_init.assert_called_once_with(**kwargs)
+
+    def test___setattr__(self) -> None:
+        class Foo:
+            pass
+
+        obj = schema.GenericSchema[Foo]()
+        with self.assertWarns(UserWarning):
+            obj.many = new = MagicMock()
+        self.assertIs(new, obj.many)
+
     @patch.object(_util.GenericInsightMixin, "_get_type_arg")
     def test_instantiate(self, mock__get_type_arg: MagicMock) -> None:
         mock__get_type_arg.return_value = mock_cls = MagicMock()
@@ -17,9 +45,29 @@ class GenericSchemaTestCase(TestCase):
         # Explicit annotation to possibly catch mypy errors:
         output: Foo = schema_obj.instantiate(mock_data)
         self.assertIs(mock_cls.return_value, output)
-        mock__get_type_arg.assert_called_once_with()
+        mock__get_type_arg.assert_called_once_with(0)
         mock_cls.assert_called_once_with(**mock_data)
 
+    def test_dump_and_dumps(self) -> None:
+        """Mainly for static type checking purposes."""
+
+        class Foo:
+            pass
+
+        class TestSchema(schema.GenericSchema[Foo]):
+            pass
+
+        foo = Foo()
+        single: dict[str, Any] = TestSchema().dump(foo)
+        self.assertDictEqual({}, single)
+        json_string: str = TestSchema().dumps(foo)
+        self.assertEqual("{}", json_string)
+
+        multiple: list[dict[str, Any]] = TestSchema().dump([foo], many=True)
+        self.assertListEqual([{}], multiple)
+        json_string = TestSchema().dumps([foo], many=True)
+        self.assertEqual("[{}]", json_string)
+
     def test_load_and_loads(self) -> None:
         """Mainly for static type checking purposes."""