-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Remove context None
guard exception
#30
Open
tbrlpld
wants to merge
4
commits into
main
Choose a base branch
from
remove-context-none-guard
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -156,17 +156,24 @@ def test_render_html_when_get_context_data_returns_None(self) -> None: | |||||
""" | ||||||
Test `render_html` method when `get_context_data` returns `None`. | ||||||
|
||||||
The `render_html` method raises a `TypeError` when `None` is returned from | ||||||
`get_context_method`. This behavior was present when the class was extracted | ||||||
from Wagtail. It is not totally clear why this specific check is needed. By | ||||||
default, the `get_context_data` method provides and empty dict. If an override | ||||||
wanted to `get_context_data` return `None`, it should be expected that no | ||||||
context data is available during rendering. The underlying `template.render` | ||||||
method does not seem to be ok with `None` as the provided context. | ||||||
Originally, the `render_html` method explicitly raised a `TypeError` when | ||||||
`None` was returned from `get_context_method`. | ||||||
|
||||||
I was not able to find out why this check was put in place. The components usage | ||||||
in Wagtail does not reveal any issues when the error is removed. Also, the | ||||||
following template rendering works just fine with the context being `None`. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
It seems therefore safe to assume that this was a left-over without much current | ||||||
need. | ||||||
|
||||||
This test is in place to prove that a component can behave as expected when the | ||||||
`get_context_data` method returns `None`. | ||||||
""" | ||||||
|
||||||
# ----------------------------------------------------------------------------- | ||||||
class ExampleComponent(Component): | ||||||
template_name = self.example_template_name | ||||||
|
||||||
def get_context_data( | ||||||
self, | ||||||
parent_context: "Optional[RenderContext]" = None, | ||||||
|
@@ -175,9 +182,11 @@ def get_context_data( | |||||
return None | ||||||
|
||||||
# ----------------------------------------------------------------------------- | ||||||
self.set_example_template_content("Hello") | ||||||
|
||||||
result = ExampleComponent().render_html() | ||||||
|
||||||
with self.assertRaises(TypeError): | ||||||
ExampleComponent().render_html() | ||||||
self.assertEqual(result, "Hello") | ||||||
|
||||||
def test_media_defined_through_nested_class(self) -> None: | ||||||
""" | ||||||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.