Skip to content

Improve typehint #77

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.

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 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 15 additions & 3 deletions marshmallow_dataclass/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,21 @@ def decorator(clazz: Type[_U]) -> Type[_U]:
return decorator(_cls) if _cls else decorator


def class_schema(
clazz: type, base_schema: Optional[Type[marshmallow.Schema]] = None
) -> Type[marshmallow.Schema]:
T_Schema = TypeVar("T_Schema", bound=marshmallow.Schema)
T_SchemaType = Type[T_Schema]


@overload
def class_schema(clazz: type, base_schema: None = None) -> Type[marshmallow.Schema]:
...


@overload
def class_schema(clazz: type, base_schema: T_SchemaType) -> T_SchemaType:
Copy link
Owner

Choose a reason for hiding this comment

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

Is this annotation correct though ? The object returned by this function is a class that inherits from T_SchemaType, not T_SchemaType itself...

Copy link
Author

Choose a reason for hiding this comment

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

This function should return the same type that sanded throw base_schema. If base_schema is None then return default type.

Copy link
Owner

Choose a reason for hiding this comment

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

Yes, I understand the problem with the two different overloads for this function. However, I don't think the type annotation you added is correct. The type of base_schema and the output type of the function are not the same.

...


def class_schema(clazz, base_schema=None):

"""
Convert a class to a marshmallow schema
Expand Down
30 changes: 30 additions & 0 deletions tests/test_schema_type.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import unittest

import marshmallow

import marshmallow_dataclass


class MyBaseSchema(marshmallow.Schema):
pass


class A:
a: int


# Top-level so that this is checked by mypy
schema_with_base: MyBaseSchema = marshmallow_dataclass.class_schema(
A, base_schema=MyBaseSchema
)()

schema_without_base: marshmallow.Schema = marshmallow_dataclass.class_schema(A)()


# Regression test for https://github.com/lovasoa/marshmallow_dataclass/pull/77
class TestSchemaType(unittest.TestCase):
def test_custom_basechema_type(self):
self.assertIsInstance(schema_with_base, MyBaseSchema)

def test_no_basechema_type(self):
self.assertIsInstance(schema_without_base, marshmallow.Schema)