Skip to content

support defining marshmallow metadata on a class #231

Description

@mmerickel

#100 (comment) shows one workaround right now but the problem with it is that it requires defining the metadata at the location where the class is used, not where the class is defined.

It would be preferable many times to define the metadata on the class itself.

@desert.meta(unknown=marshmallow.EXCLUDE)
@dataclass
class Child:
    name: str

@dataclass
class Parent:
    name: str
    dummy_list: List[str]
    children: List[Child]

This is a lot less error prone in situations where I know that the Child schema might evolve and I want to define directly on it the intent that I don't want my deserialization to break when new fields are added.

Arguably the proposed desert.meta is ambiguous with the existing desert.metadata API so open to suggestions on naming as well...

I'm happy to contribute a PR if I can get some confidence that this will be accepted design-wise.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions