Complete type stubs for assertTemplateUsed / assertTemplateNotUsed - #1278
Merged
bluetech merged 1 commit intoAug 3, 2026
Merged
Conversation
brianhelba
force-pushed
the
fix-assertTemplateUsed-overloads
branch
from
April 14, 2026 05:47
d63cb82 to
319d2a8
Compare
mypy 1.20 (python/mypy#20350) changes how it types the return value of functions that return `None`: previously it used `Any` (suppressing downstream errors), now it propagates the actual `None` type. This means the existing `-> None` annotation on `assertTemplateUsed` / `assertTemplateNotUsed` causes type errors when these functions are used as context managers. This adds `@overload` signatures to distinguish the two calling conventions, matching the pattern already used by `assertNumQueries` in this file: * `response` is `HttpResponseBase`: direct assertion, returns `None` * `response` is a `str` (shorthand for `template_name`): returns context manager * `response` is `None` (`template_name` passed by keyword): returns context manager
brianhelba
force-pushed
the
fix-assertTemplateUsed-overloads
branch
from
April 14, 2026 05:52
319d2a8 to
7ad6c89
Compare
Contributor
Author
|
@kingbuzzman Please take a look. |
Contributor
Author
|
@kingbuzzman Could you take a look? This is a typing-only bugfix, to add support for Mypy 1.20+. |
bluetech
approved these changes
Aug 3, 2026
bluetech
left a comment
bluetech
left a comment
Member
There was a problem hiding this comment.
Thanks!
Consider also submitting this improvement to django-stubs, it can improve the typing there as well: https://github.com/typeddjango/django-stubs/blob/61a3af749523e9645861057588fe67230ac6b6dd/django-stubs/test/testcases.pyi#L119-L125
| template_name: None = ..., | ||
| msg_prefix: str = ..., | ||
| count: int | None = ..., | ||
| ) -> AbstractContextManager[None]: ... |
Member
There was a problem hiding this comment.
Technically it's not None, the context manager returns itself. I'll change that to Any.
Contributor
Author
|
@bluetech Thanks! I took your suggestion to fix upstream too: typeddjango/django-stubs#3564 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mypy 1.20 (python/mypy#20350) changes how it types the return value of functions that return
None: previously it usedAny(suppressing downstream errors), now it propagates the actualNonetype. This means the existing-> Noneannotation onassertTemplateUsed/assertTemplateNotUsedcauses type errors when these functions are used as context managers.This adds
@overloadsignatures to distinguish the two calling conventions, matching the pattern already used byassertNumQueriesin this file:responseisHttpResponseBase: direct assertion, returnsNoneresponseis astr(shorthand fortemplate_name): returns context managerresponseisNone(template_namepassed by keyword): returns context manager