Add custom encoder support to trigger_client_event() #349
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
adamchainz
approved these changes
Jul 9, 2023
src/django_htmx/http.py
Outdated
| @@ -129,6 +129,7 @@ def trigger_client_event( | |||
| params: dict[str, Any] | None = None, | |||
| *, | |||
| after: EventAfterType = "receive", | |||
| encoder: type[DjangoJSONEncoder] = DjangoJSONEncoder, | |||
There was a problem hiding this comment.
let's widen the type limit to json.JSONEncoder to give more flexibility
docs/http.rst
Outdated
|
|
||
| ``after`` selects which of the ``HX-Trigger`` headers to modify: | ||
|
|
||
| * ``"receive"``, the default, maps to ``HX-Trigger`` | ||
| * ``"settle"`` maps to ``HX-Trigger-After-Settle`` | ||
| * ``"swap"`` maps to ``HX-Trigger-After-Swap`` | ||
|
|
||
| ``encoder`` specifies the JSON encoder to be used in generating the JSON. By default uses |DjangoJSONEncoder|__ for its extended data type support. |
tests/test_http.py
Outdated
Comment on lines
241
to
268
| class BeanCounter: | ||
| def __init__(self, magic_bean_count: int): | ||
| self.magic_bean_count = magic_bean_count * 2 | ||
|
|
||
| class MyEncoder(DjangoJSONEncoder): | ||
| def default(self, o): | ||
| if isinstance(o, BeanCounter): | ||
| return {"magic_beans": o.magic_bean_count} | ||
|
|
||
| return super().default(o) | ||
|
|
||
| response = HttpResponse() | ||
| uuid_value = UUID("{12345678-1234-5678-1234-567812345678}") | ||
|
|
||
| trigger_client_event( | ||
| response, | ||
| "showMessage", | ||
| {"uuid": uuid_value, "beans": BeanCounter(1)}, | ||
| encoder=MyEncoder, | ||
| ) | ||
|
|
||
| assert response["HX-Trigger"] == ( | ||
| '{"showMessage": {"uuid": "12345678-1234-5678-1234-567812345678", ' | ||
| '"magic_beans": 2}}' | ||
| ) |
There was a problem hiding this comment.
This test can be shortened a bit, we don't need a UUID or the bean count to prove the encoder is used
adamchainz
changed the title
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.
I haven't deciphered how to set up a dev env for this project or run its tests locally, but I think this is implemented appropriately. Hoping the GH actions covers it and the test I wrote passes! Let me know if this is a desirable change (it is for my use case!) and if there's anything I can do to increase polish and/or test coverage.