Skip to content

added missing dataclasses arguments kw_only, slots, match_args #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

added missing dataclasses arguments kw_only, slots, match_args #204

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c167677
added missing dataclasses arguments kw_only, slots, match_args
Aug 4, 2022
aebb9b7
fixed indentation issues
Aug 30, 2022
d12d08f
setup rollback
Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 74 additions & 65 deletions marshmallow_dataclass/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ class User:

from marshmallow_dataclass.lazy_class_attribute import lazy_class_attribute


__all__ = ["dataclass", "add_schema", "class_schema", "field_for_schema", "NewType"]

NoneType = type(None)
Expand All @@ -84,29 +83,35 @@ class User:

@overload
def dataclass(
_cls: Type[_U],
*,
repr: bool = True,
eq: bool = True,
order: bool = False,
unsafe_hash: bool = False,
frozen: bool = False,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
_cls: Type[_U],
Copy link

@mivade mivade Aug 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did the indentation change?

Copy link
Author

@lorenzosciuto lorenzosciuto Aug 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have the auto-indentation on and it automatically corrected the indentation on save.

Copy link

@mivade mivade Aug 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 spaces is a lot more standard than 8. Since changing the indentation is not relevant to this PR I think that should be adjusted.

Copy link

@crutcher crutcher Aug 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #205; adds version guard switching.

Copy link
Author

@lorenzosciuto lorenzosciuto Aug 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mivade fixed indentation, could you please check now?

*,
repr: bool = True,
eq: bool = True,
order: bool = False,
unsafe_hash: bool = False,
frozen: bool = False,
match_args=True,
kw_only=False,
slots=False,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
) -> Type[_U]:
...


@overload
def dataclass(
*,
repr: bool = True,
eq: bool = True,
order: bool = False,
unsafe_hash: bool = False,
frozen: bool = False,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
*,
repr: bool = True,
eq: bool = True,
order: bool = False,
unsafe_hash: bool = False,
frozen: bool = False,
match_args=True,
kw_only=False,
slots=False,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
) -> Callable[[Type[_U]], Type[_U]]:
...

Expand All @@ -115,15 +120,18 @@ def dataclass(
# underscore. The presence of _cls is used to detect if this
# decorator is being called with parameters or not.
def dataclass(
_cls: Type[_U] = None,
*,
repr: bool = True,
eq: bool = True,
order: bool = False,
unsafe_hash: bool = False,
frozen: bool = False,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
_cls: Type[_U] = None,
*,
repr: bool = True,
eq: bool = True,
order: bool = False,
unsafe_hash: bool = False,
frozen: bool = False,
match_args=True,
kw_only=False,
slots=False,
base_schema: Optional[Type[marshmallow.Schema]] = None,
cls_frame: Optional[types.FrameType] = None,
) -> Union[Type[_U], Callable[[Type[_U]], Type[_U]]]:
"""
This decorator does the same as dataclasses.dataclass, but also applies :func:`add_schema`.
Expand Down Expand Up @@ -152,7 +160,8 @@ def dataclass(
"""
# dataclass's typing doesn't expect it to be called as a function, so ignore type check
dc = dataclasses.dataclass( # type: ignore
_cls, repr=repr, eq=eq, order=order, unsafe_hash=unsafe_hash, frozen=frozen
_cls, repr=repr, eq=eq, order=order, unsafe_hash=unsafe_hash, frozen=frozen, match_args=match_args,
kw_only=kw_only, slots=slots
)
if not cls_frame:
current_frame = inspect.currentframe()
Expand All @@ -172,16 +181,16 @@ def add_schema(_cls: Type[_U]) -> Type[_U]:

@overload
def add_schema(
base_schema: Type[marshmallow.Schema] = None,
base_schema: Type[marshmallow.Schema] = None,
) -> Callable[[Type[_U]], Type[_U]]:
...


@overload
def add_schema(
_cls: Type[_U],
base_schema: Type[marshmallow.Schema] = None,
cls_frame: types.FrameType = None,
_cls: Type[_U],
base_schema: Type[marshmallow.Schema] = None,
cls_frame: types.FrameType = None,
) -> Type[_U]:
...

Expand Down Expand Up @@ -221,9 +230,9 @@ def decorator(clazz: Type[_U]) -> Type[_U]:


def class_schema(
clazz: type,
base_schema: Optional[Type[marshmallow.Schema]] = None,
clazz_frame: types.FrameType = None,
clazz: type,
base_schema: Optional[Type[marshmallow.Schema]] = None,
clazz_frame: types.FrameType = None,
) -> Type[marshmallow.Schema]:
"""
Convert a class to a marshmallow schema
Expand Down Expand Up @@ -360,9 +369,9 @@ def class_schema(

@lru_cache(maxsize=MAX_CLASS_SCHEMA_CACHE_SIZE)
def _internal_class_schema(
clazz: type,
base_schema: Optional[Type[marshmallow.Schema]] = None,
clazz_frame: types.FrameType = None,
clazz: type,
base_schema: Optional[Type[marshmallow.Schema]] = None,
clazz_frame: types.FrameType = None,
) -> Type[marshmallow.Schema]:
_RECURSION_GUARD.seen_classes[clazz] = clazz.__name__
try:
Expand Down Expand Up @@ -419,20 +428,20 @@ def _internal_class_schema(


def _field_by_type(
typ: Union[type, Any], base_schema: Optional[Type[marshmallow.Schema]]
typ: Union[type, Any], base_schema: Optional[Type[marshmallow.Schema]]
) -> Optional[Type[marshmallow.fields.Field]]:
return (
base_schema and base_schema.TYPE_MAPPING.get(typ)
) or marshmallow.Schema.TYPE_MAPPING.get(typ)
base_schema and base_schema.TYPE_MAPPING.get(typ)
) or marshmallow.Schema.TYPE_MAPPING.get(typ)


def _field_by_supertype(
typ: Type,
default: Any,
newtype_supertype: Type,
metadata: dict,
base_schema: Optional[Type[marshmallow.Schema]],
typ_frame: Optional[types.FrameType],
typ: Type,
default: Any,
newtype_supertype: Type,
metadata: dict,
base_schema: Optional[Type[marshmallow.Schema]],
typ_frame: Optional[types.FrameType],
) -> marshmallow.fields.Field:
"""
Return a new field for fields based on a super field. (Usually spawned from NewType)
Expand Down Expand Up @@ -485,10 +494,10 @@ def _generic_type_add_any(typ: type) -> type:


def _field_for_generic_type(
typ: type,
base_schema: Optional[Type[marshmallow.Schema]],
typ_frame: Optional[types.FrameType],
**metadata: Any,
typ: type,
base_schema: Optional[Type[marshmallow.Schema]],
typ_frame: Optional[types.FrameType],
**metadata: Any,
) -> Optional[marshmallow.fields.Field]:
"""
If the type is a generic interface, resolve the arguments and construct the appropriate Field.
Expand Down Expand Up @@ -592,11 +601,11 @@ def _field_for_generic_type(


def field_for_schema(
typ: type,
default=marshmallow.missing,
metadata: Mapping[str, Any] = None,
base_schema: Optional[Type[marshmallow.Schema]] = None,
typ_frame: Optional[types.FrameType] = None,
typ: type,
default=marshmallow.missing,
metadata: Mapping[str, Any] = None,
base_schema: Optional[Type[marshmallow.Schema]] = None,
typ_frame: Optional[types.FrameType] = None,
) -> marshmallow.fields.Field:
"""
Get a marshmallow Field corresponding to the given python type.
Expand Down Expand Up @@ -723,17 +732,17 @@ def field_for_schema(
forward_reference = getattr(typ, "__forward_arg__", None)

nested = (
nested_schema
or forward_reference
or _RECURSION_GUARD.seen_classes.get(typ)
or _internal_class_schema(typ, base_schema, typ_frame)
nested_schema
or forward_reference
or _RECURSION_GUARD.seen_classes.get(typ)
or _internal_class_schema(typ, base_schema, typ_frame)
)

return marshmallow.fields.Nested(nested, **metadata)


def _base_schema(
clazz: type, base_schema: Optional[Type[marshmallow.Schema]] = None
clazz: type, base_schema: Optional[Type[marshmallow.Schema]] = None
) -> Type[marshmallow.Schema]:
"""
Base schema factory that creates a schema for `clazz` derived either from `base_schema`
Expand Down Expand Up @@ -771,10 +780,10 @@ def _get_field_default(field: dataclasses.Field):


def NewType(
name: str,
typ: Type[_U],
field: Optional[Type[marshmallow.fields.Field]] = None,
**kwargs,
name: str,
typ: Type[_U],
field: Optional[Type[marshmallow.fields.Field]] = None,
**kwargs,
) -> Callable[[_U], _U]:
"""NewType creates simple unique types
to which you can attach custom marshmallow attributes.
Expand Down
12 changes: 6 additions & 6 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from setuptools import setup, find_packages

VERSION = "8.5.8"
VERSION = "8.5.9"

CLASSIFIERS = [
"Development Status :: 4 - Beta",
Expand Down Expand Up @@ -33,11 +33,11 @@
],
}
EXTRAS_REQUIRE["dev"] = (
EXTRAS_REQUIRE["enum"]
+ EXTRAS_REQUIRE["union"]
+ EXTRAS_REQUIRE["lint"]
+ EXTRAS_REQUIRE["docs"]
+ EXTRAS_REQUIRE["tests"]
EXTRAS_REQUIRE["enum"]
+ EXTRAS_REQUIRE["union"]
+ EXTRAS_REQUIRE["lint"]
+ EXTRAS_REQUIRE["docs"]
+ EXTRAS_REQUIRE["tests"]
)

setup(
Expand Down