Open Dresdn opened 3 months ago
One other fun tidbit of information: not all fields throw an error.
models.FileField()
, models.ImageField()
, and models.JSONField()
don't throw a type error. As far as I can tell, all the others do (IntegerField()
, TextField()
, etc.)
I believe I'm getting the same issue - it asks for var-annotated
on nearly every field in a model that inherits from django extensions' TimeStampedModel
, for instance. I believe it was introduced in django-stubs 5.0.3.
I get similar issue with related managers - many of them are not resolved with update to 5.0.4, but a couple of them could be fixed if a model inherited from TimeStampedModel
using workaround described here.
https://github.com/typeddjango/django-stubs/issues/1354 seems relevant.
It tried to do a bisect and it seems the issue was maybe introduced in ac36393ba31ebafbd436b140576d8f828d8c7474.
Getting this with:
mypy==1.13.0
django-stubs==5.1.1
django-extensions==3.2.3
Here is a monkeypatch workaround:
import mypy_django_plugin.lib.helpers
from mypy_django_plugin.lib.helpers import is_model_type as patch
allowlist = {
"dotted.path.to.your.ModelClass",
}
def is_model_type(info):
if info.fullname in allowlist:
return True
return patch(info)
mypy_django_plugin.lib.helpers.is_model_type = is_model_type
It seems that for models inherited from 3rd party apps, info.metaclass_type is None
for some reason rather than being model metaclass.
Bug report
What's wrong
With the latest django-stubs v5.0.4, I've noticed strange behavior when using models that inherit from 3rd party packages. Specifically, mypy throws a "Need type annotation for" error on model fields.
Here’s the scenario:
django-cookiecutter
.mypy
v1.11.1,django-stubs
v5.0.4, and tested withDjango
4.2.11 and 5.0.8.local_app/models.py
, there are no errors.FooBase
class to a 3rd party package’smodels.py
(e.g.,site-packages/django_extensions/models.py
since that came with the cookiecutter install), I get a mypy error on theupdated_at
field ofBar
.This issue only started occurring with django-stubs v5.0.3 or v5.0.4 and mypy v1.11.0 or v1.11.1. It was working correctly with the previous versions (django-stubs v5.0.2 and mypy v1.10.1).
I am aware of issue #2011, which has been closed. However, the difference here is that the code was working fine with the prior django-stubs and mypy versions, but the error occurs after updating to the latest versions.
How is that should be
Type checking should pass without errors when using models that inherit from 3rd party packages, just as it did with previous versions of django-stubs and mypy.
System information
python
version: 3.11.9django
version: 5.0.8 & 4.2.11mypy
version: 1.11.1django-stubs
version: 5.0.4django-stubs-ext
version: 5.0.4mypy Settings