fix: Add context_data attribute to _MonkeyPatchedW/ASGIResponse.
#2509
Conversation
This file contains 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
As detailed in Django's documentation [0], when a non-standard template backend is being used, the `context_data` attribute is populated instead of `context` when the test API call was successful. In reality, I've seen this to be a populated attribute regardless of the backend template engine being used. Regardless, this near hidden attribute is missing and should be included to help improve unit testing when validating the response data contains the expected data.
sobolevn
reviewed
Feb 11, 2025
| # `context_data` only exists if the response was successful too as the return type changes. | ||
| # `HTTPResponse` when API failed and `TemplateResponse` when successful. | ||
| # https://docs.djangoproject.com/en/stable/topics/testing/tools/#django.test.Response.context | ||
| context: ContextList | dict[str, Any] | None |
There was a problem hiding this comment.
I think that this can ruin valid use, basically you would have to do:
assert response.context
assert response.context[key]Right?
This attribute is only populated when using the [DjangoTemplates](https://docs.djangoproject.com/en/5.1/topics/templates/#django.template.backends.django.DjangoTemplates) backend. If you’re using another template engine, [context_data](https://docs.djangoproject.com/en/5.1/ref/template-response/#django.template.response.SimpleTemplateResponse.context_data) may be a suitable alternative on responses with that attribute.
There was a problem hiding this comment.
If you have a custom Template BE then context is null and you have to use context_data instead. From testing this out, I found context was always null on a 200 response regardless of template BE using Django 4.2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As detailed in Django's documentation [0], when a non-standard template backend is used, the
context_dataattribute is populated instead ofcontextwhen the test API call is successful. I've seen this to be a populated attribute regardless of the backend template engine being used. Regardless, this near-hidden attribute is missing and should be included to help improve unit testing when validating that the response data contains the expected data.[0] https://docs.djangoproject.com/en/stable/topics/testing/tools/#django.test.Response.context
Related issues
None.