Fix type annotations for 3rd party models #2440
Conversation
| - django_extensions | ||
| - myapp | ||
| main: | | ||
| from myapp.models import A |
There was a problem hiding this comment.
please, add a reveal_type to A().name
| - path: myapp/models.py | ||
| content: | | ||
| from django.db import models | ||
| from django_extensions.db.models import TimeStampedModel # type: ignore[import-untyped] |
There was a problem hiding this comment.
I actually disagree with the changes here. The main issue in #2341 is that django-extensions is a package that doesn't export any type hints.
The ignore comment I'm highlighting here is saying precisely that. What is experienced in #2341 is how mypy behaves when there are no type hints.
What is attempted to be repaired here is only the first line of issues, there could be an arbitrary amount of other problems to solve after this one, coming from it being an untyped package.
There are multiple other approaches to resolve this, that integrates better with the type checker. e.g.
- Add and export type hints in
django-extensions - Create a stubs package(
.pyi) just likedjango-stubsfordjango-extrnsions - Add stubs (
.pyi-files) fordjango-extensionsto your project, locally - Perhaps
django-stubswould consider including stubs in a similar fashion totypeshed, that includes/maintains a bunch of 3rd party stubs?
Regardless, I think merging the changes here is a step in the wrong direction as it's outside of django-stubs domain
Fix type annotations for 3rd party models
The clean-up in PR #2263 that got released in v5.0.3 ended up breaking type annotations for models that are subclasses of models imported from 3rd party libraries.
I restored the logic that checks a model's fullname in the list of registered django apps. We still need to do this because Django models imported from untyped 3rd party libraries will have no
metaclass_type, sohelpers.is_model_typewill always fail for them.Related issues