Add mypy plugin for NewType

[selimb]

Took a stab at fixing #50. I had the same problem.

As in tests/test_mypy.py, the following:

from dataclasses import dataclass
import marshmallow as ma
from marshmallow_dataclass import NewType

Email = NewType("Email", str, validate=ma.validate.Email)
UserID = NewType("UserID", validate=ma.validate.Length(equal=32), typ=str)

@dataclass
class User:
    id: UserID
    email: Email

user = User(id="a"*32, email="[email protected]")

reveal_type(user.id)
reveal_type(user.email)
User(id=42, email="[email protected]")
User(id="a"*32, email=["not", "a", "string"])

now outputs:

main.py:14: note: Revealed type is 'builtins.str'
main.py:15: note: Revealed type is 'builtins.str'
main.py:17: error: Argument "id" to "User" has incompatible type "int"; expected "str"
main.py:18: error: Argument "email" to "User" has incompatible type "List[str]"; expected "str"

• I can also add some documentation once you approve of the changes!

[selimb]

Hmm tests were failing on CI for pypy3 because typed-ast (a dependency of mypy) fails to install on pypy: python/typed_ast#111

I've tweaked setup.py and test_mypy.py to skip mypy tests on pypy.

[lovasoa]

Great, this looks good ! Thank you @selimb

@sloria, what do you think ?

[sloria]

Just some nits.

I don't have experience with mypy plugins and therefore don't have high confidence in evaluating plugin code, but the test output seems to verify the correct behavior.

Thank for working on this!

[sloria]

Can you use tempfile.TemporaryDirectory for this?

Sidenote: this is another good time to re-evaluate pytest, which has built-in functionality for this sort of thing. Not a blocker, but worth considering. @lovasoa

[lovasoa]

I argued against pytest in the past because I felt like it wasn't providing anything we needed for this project. But if there is a plugin that allows testing the mypy plugin easily, then I have nothing against switching to pytest and using it. It would definitely make the transition worth it.

[selimb]

Argh. Deleted previous comment by accident. Copied below for reference.

Hah, yeah I must admit I was bit surprised that this was using unittest. Note that there's also a pytest plugin to easily test mypy plugins, which would effectively remove the need for all the code in setup, teardown and assert_mypy_output.
Do you want me to leave a TODO somewhere, as a reminder to switch to (or at least consider) pytest-mypy-plugins if the project moves to pytest?

Also note that pytest supports unittest, so you could use the pytest runner without necessarily "rewriting" the existing tests.

[selimb]

@lovasoa Cool. How do you want to proceed re: existing tests and re: this PR?

[lovasoa]

Since switching to pytest doesn't require rewriting any of the existing tests, I think we can do it in this PR.

[selimb]

Alright! Will work on that later today.

[sloria]

Looks great!

Maybe just add a TODO somewhere--or just create a new issue--to port over existing tests to pytest style?

[selimb]

@sloria @lovasoa I was a bit bummed by the lack of Windows support (I happen to be developing on Windows at the moment), but at least it's just for tests. I might raise an issue on pytest-mypy-plugins though, since there's no good reason to require capturer.

[selimb]

typeddjango/pytest-mypy-plugins#13

[selimb]

Added note in documentation on enabling the mypy plugin.

Maybe just add a TODO somewhere--or just create a new issue--to port over existing tests to pytest style?

#56