Skip to content

Complete type stubs for assertTemplateUsed / assertTemplateNotUsed #1278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bluetech merged 1 commit into from
Aug 3, 2026
+52 −1
Merged

Complete type stubs for assertTemplateUsed / assertTemplateNotUsed #1278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion pytest_django/asserts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,18 +112,69 @@ def assertFormSetError(
msg_prefix: str = ...,
) -> None: ...

# with assertTemplateUsed("template.html"): ... # noqa: ERA001
@overload
def assertTemplateUsed(
response: str,
template_name: None = ...,
msg_prefix: str = ...,
count: int | None = ...,
) -> AbstractContextManager[None]: ...

@bluetech bluetech Aug 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically it's not None, the context manager returns itself. I'll change that to Any.


# with assertTemplateUsed(template_name="template.html"): ... # noqa: ERA001
@overload
def assertTemplateUsed(
response: None = ...,
template_name: str | None = ...,
msg_prefix: str = ...,
count: int | None = ...,
) -> AbstractContextManager[None]: ...

# assertTemplateUsed(response, "template.html") # noqa: ERA001
@overload
def assertTemplateUsed(
response: HttpResponseBase,
template_name: str | None = ...,
msg_prefix: str = ...,
count: int | None = ...,
) -> None: ...

def assertTemplateUsed(
response: HttpResponseBase | str | None = ...,
template_name: str | None = ...,
msg_prefix: str = ...,
count: int | None = ...,
): ...

# with assertTemplateNotUsed("template.html"): ... # noqa: ERA001
@overload
def assertTemplateNotUsed(
response: str,
template_name: None = ...,
msg_prefix: str = ...,
) -> AbstractContextManager[None]: ...

# with assertTemplateNotUsed(template_name="template.html"): ... # noqa: ERA001
@overload
def assertTemplateNotUsed(
response: None = ...,
template_name: str | None = ...,
msg_prefix: str = ...,
) -> AbstractContextManager[None]: ...

# assertTemplateNotUsed(response, "template.html") # noqa: ERA001
@overload
def assertTemplateNotUsed(
response: HttpResponseBase,
template_name: str | None = ...,
msg_prefix: str = ...,
) -> None: ...

def assertTemplateNotUsed(
response: HttpResponseBase | str | None = ...,
template_name: str | None = ...,
msg_prefix: str = ...,
) -> None: ...
): ...

def assertRaisesMessage(
expected_exception: type[Exception],
Expand Down