mypy plugin support for dataclasses #966

koxudaxi · 2019-11-05T19:02:25Z

Change Summary

The PR supports dataclasses on mypy plugin

Related issue number

#957

Checklist

Unit tests for the changes exist
Tests pass on CI and coverage remains at 100%
Documentation reflects the changes where applicable
changes/<pull request or issue id>-<github username>.md file added describing change
(see changes/README.md for details)

tests/mypy/outputs/plugin-success.txt

codecov · 2019-11-05T19:21:34Z

Codecov Report

Merging #966 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #966   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          19     19           
  Lines        3287   3293    +6     
  Branches      650    651    +1     
=====================================
+ Hits         3287   3293    +6

Impacted Files	Coverage Δ
pydantic/dataclasses.py	`100% <100%> (ø)`	⬆️
pydantic/mypy.py	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update caa270a...ff1f630. Read the comment docs.

pydantic/dataclasses.py

pydantic/mypy.py

tests/mypy/outputs/plugin-success.txt

- change name of an expected file - update documents

samuelcolvin

we should also add a ! warning to usage/dataclasses.md saying that as of v1.2 the mypy plugin must be installed to type check pydantic dataclasses.

pydantic/mypy.py

tests/mypy/modules/fail4.py

docs/mypy_plugin.md

- update documents

Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>

koxudaxi · 2019-11-07T20:12:01Z

@dmontagu
Would you help me?
I get an unexpected result from the mypy test.
This problem is added empty lines on error out.
Also, The problem is happend only first time after make clean.

>           assert actual_out == expected_out, actual_out
E           AssertionError: 119: error: Unexpected keyword argument "name" for "AddProject"  [call-arg]
E             
E             119: error: Unexpected keyword argument "slug" for "AddProject"  [call-arg]
E             
E             119: error: Unexpected keyword argument "description" for "AddProject"  [call-arg]
E           assert '119: error: ..."  [call-arg]' == '119: error: ..."  [call-arg]'
E               119: error: Unexpected keyword argument "name" for "AddProject"  [call-arg]
E             - 
E               119: error: Unexpected keyword argument "slug" for "AddProject"  [call-arg]
E             - 
E               119: error: Unexpected keyword argument "description" for "AddProject"  [call-arg]

tests/mypy/test_mypy.py:61: AssertionError

dmontagu · 2019-11-07T21:01:06Z

Huh, that's very weird. If it's just whitespace differences, it seems like it's probably an issue with mypy?

If the issue is just extra whitespace, I would just apply actual_output = re.sub(r'\n\s*\n', r'\n', actual_output) or whatever actually works to remove the blank lines (didn't check if that statement actually works).

koxudaxi · 2019-11-08T02:31:43Z

@dmontagu

Thank you for your advice.
I tested this command. but, I did not look extra whitespaces.

mypy --config-file tests/mypy/configs/mypy-default.ini  --show-error-codes tests/mypy/modules/success.py

I use this method to resolve the error. actual_output = re.sub(r'\n\s*\n', r'\n', actual_output)

samuelcolvin

Good except, as per the names success.py and plugin_success.py should pass and therefore have no output.

tests/mypy/modules/success.py

tests/mypy/outputs/plugin-success.txt

samuelcolvin

otherwise LGTM

docs/usage/dataclasses.md

samuelcolvin · 2019-11-09T12:19:43Z

@dmontagu are you happy with this?

Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>

dmontagu · 2019-11-13T21:43:25Z

@koxudaxi It looks to me like the received config isn't currently used by mypy, it's just allowed to be passed without raising an error -- is that right?

@samuelcolvin This looks good to me as a first release ensuring compatibility with the config argument. Eventually it would be nice to have the config values affect the type checking where relevant (I guess I'm not totally sure it affects anything mypy would detect anyway), but I don't think that needs to block a release.

Looks good to me!

dmontagu · 2019-11-13T21:44:31Z

pydantic/dataclasses.py

@@ -22,6 +22,9 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
        def __validate__(cls, v: Any) -> 'DataclassType':
            pass

+        def __call__(self, *args: Any, **kwargs: Any) -> 'DataclassType':


Should this use a TypeVar?

Did you expect this?

def __call__(self: T, *args: Any, **kwargs: Any) -> T: pass

Also, Did you want to replace other -> 'DataclassType' like __init__ ?

Yeah, that's what I meant, I think it would be better (assuming that is the right signature, which I think it is?).

I don't think the __init__ signature needs to change, but maybe the _validate_dataclass one should.

(Any other places where 'DataclassType' is currently used probably should; I believe this is what is done for factory classmethods for BaseModel -- I don't see why it shouldn't be that way for the dataclasses.)

Also, I would recommend using something like DataclassT as the name of the TypeVar, to make it slightly more obvious what's happening, and give it bound=DataclassType. (The TypeVar for BaseModel in pydantic.main is called Model; I think that's nice.)

tests/mypy/outputs/plugin-fail-strict.txt

tests/mypy/modules/plugin_success.py

samuelcolvin · 2019-11-14T11:01:54Z

As far as I can tell, we're just waiting for a tweak to the signature of __call__. Is that correct?

If not, let me know and I'll merge.

koxudaxi · 2019-11-14T11:17:51Z

@samuelcolvin
Sorry, I have pushed it which is changed by @dmontagu's review

samuelcolvin · 2019-11-14T11:26:56Z

Woop woop. Thank you very much.

* mypy plugin support for dataclassesv * fix styles and types * - change type-hint for `Config` - change name of an expected file - update documents * fix broken a reference of a document. * - update unittest - update documents * fix a document link * Update docs/mypy_plugin.md Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Update docs/mypy_plugin.md Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Update docs/mypy_plugin.md Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * remove extra whitespaces on mypy test results * fix output file name of mypy test * Update docs/usage/dataclasses.md Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * use TypeVar for DataclassType

mypy plugin support for dataclassesv

fb109d0

dmontagu reviewed Nov 5, 2019

View reviewed changes

tests/mypy/outputs/plugin-success.txt Outdated Show resolved Hide resolved

fix styles and types

1898087

koxudaxi commented Nov 5, 2019

View reviewed changes

pydantic/dataclasses.py Outdated Show resolved Hide resolved

samuelcolvin reviewed Nov 6, 2019

View reviewed changes

pydantic/dataclasses.py Outdated Show resolved Hide resolved

pydantic/mypy.py Show resolved Hide resolved

tests/mypy/outputs/plugin-success.txt Outdated Show resolved Hide resolved

koxudaxi added 2 commits November 8, 2019 00:57

- change type-hint for Config

192187a

- change name of an expected file - update documents

fix broken a reference of a document.

19d49ec

samuelcolvin reviewed Nov 7, 2019

View reviewed changes

pydantic/mypy.py Show resolved Hide resolved

tests/mypy/modules/fail4.py Outdated Show resolved Hide resolved

docs/mypy_plugin.md Outdated Show resolved Hide resolved

docs/mypy_plugin.md Outdated Show resolved Hide resolved

docs/mypy_plugin.md Outdated Show resolved Hide resolved

koxudaxi and others added 5 commits November 8, 2019 03:01

- update unittest

92eada1

- update documents

fix a document link

7e97368

Update docs/mypy_plugin.md

4652387

Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>

Update docs/mypy_plugin.md

9576bd0

Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>

Update docs/mypy_plugin.md

35302bd

Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>

remove extra whitespaces on mypy test results

5068657

samuelcolvin reviewed Nov 8, 2019

View reviewed changes

tests/mypy/modules/success.py Outdated Show resolved Hide resolved

tests/mypy/outputs/plugin-success.txt Outdated Show resolved Hide resolved

fix output file name of mypy test

05ca1ca

samuelcolvin approved these changes Nov 9, 2019

View reviewed changes

docs/usage/dataclasses.md Outdated Show resolved Hide resolved

koxudaxi and others added 2 commits November 9, 2019 21:58

Update docs/usage/dataclasses.md

d036cf0

Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>

Merge branch 'master' into mypy_plugin_support_for_dataclasses

e39b8f9

samuelcolvin requested a review from dmontagu November 13, 2019 15:30

dmontagu reviewed Nov 13, 2019

View reviewed changes

tests/mypy/outputs/plugin-fail-strict.txt Show resolved Hide resolved

koxudaxi commented Nov 14, 2019

View reviewed changes

tests/mypy/modules/plugin_success.py Show resolved Hide resolved

use TypeVar for DataclassType

ff1f630

samuelcolvin merged commit 33b3dc1 into pydantic:master Nov 14, 2019

koxudaxi deleted the mypy_plugin_support_for_dataclasses branch November 14, 2019 11:27

PrettyWood mentioned this pull request Dec 13, 2020

mypy plugin support for dataclasses #957

Closed

alexdrydew pushed a commit to alexdrydew/pydantic that referenced this pull request Dec 23, 2023

update to coverage_attribute feature (pydantic#966)

3dfecd7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mypy plugin support for dataclasses #966

mypy plugin support for dataclasses #966

koxudaxi commented Nov 5, 2019 •

edited

codecov bot commented Nov 5, 2019 •

edited

samuelcolvin left a comment

koxudaxi commented Nov 7, 2019

dmontagu commented Nov 7, 2019

koxudaxi commented Nov 8, 2019

samuelcolvin left a comment

samuelcolvin left a comment

samuelcolvin commented Nov 9, 2019

dmontagu commented Nov 13, 2019 •

edited

dmontagu Nov 13, 2019

koxudaxi Nov 14, 2019

dmontagu Nov 14, 2019 •

edited

samuelcolvin commented Nov 14, 2019

koxudaxi commented Nov 14, 2019

samuelcolvin commented Nov 14, 2019

mypy plugin support for dataclasses #966

mypy plugin support for dataclasses #966

Conversation

koxudaxi commented Nov 5, 2019 • edited

Change Summary

Related issue number

Checklist

codecov bot commented Nov 5, 2019 • edited

Codecov Report

samuelcolvin left a comment

Choose a reason for hiding this comment

koxudaxi commented Nov 7, 2019

dmontagu commented Nov 7, 2019

koxudaxi commented Nov 8, 2019

samuelcolvin left a comment

Choose a reason for hiding this comment

samuelcolvin left a comment

Choose a reason for hiding this comment

samuelcolvin commented Nov 9, 2019

dmontagu commented Nov 13, 2019 • edited

dmontagu Nov 13, 2019

Choose a reason for hiding this comment

koxudaxi Nov 14, 2019

Choose a reason for hiding this comment

dmontagu Nov 14, 2019 • edited

Choose a reason for hiding this comment

samuelcolvin commented Nov 14, 2019

koxudaxi commented Nov 14, 2019

samuelcolvin commented Nov 14, 2019

koxudaxi commented Nov 5, 2019 •

edited

codecov bot commented Nov 5, 2019 •

edited

dmontagu commented Nov 13, 2019 •

edited

dmontagu Nov 14, 2019 •

edited