DSL: preserve the skip_empty setting in to_dict() recursive serializations #3041
+59 −25
Conversation
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
miguelgrinberg force-pushed the reproduce-issue-1577 branch from 52d6cce to 74c1dde Compare 
| @pquentin added a 2nd commit with a small adjustment to your attempt that does reproduce the issue. The 3rd commit contains the fix, which involves the plumbing to pass |
miguelgrinberg force-pushed the reproduce-issue-1577 branch 3 times, most recently from 477b784 to 6c4f43d Compare miguelgrinberg force-pushed the reproduce-issue-1577 branch from 6c4f43d to 575927c Compare miguelgrinberg changed the title miguelgrinberg changed the title skip_empty setting in to_dict() recursive serializations 
pquentin commented Aug 19, 2025
Comment on lines +125 to +131
| def _safe_serialize(self, data: Any, skip_empty: bool) -> Any: | ||
| try: | ||
| return self._serialize(data, skip_empty) | ||
| except TypeError: | ||
| # older method signature, without skip_empty | ||
| return self._serialize(data) # type: ignore[call-arg] | ||
| |
There was a problem hiding this comment.
Why do we need this? Is this for third-party libraries that want to subclass Field?
There was a problem hiding this comment.
This is needed for people who created their own custom fields and use the old signature in their _serialize() methods.
miguelgrinberg approved these changes Aug 20, 2025
miguelgrinberg added a commit that referenced this pull request Aug 20, 2025
…lizations (#3041) (#3047) * Try reproducing DSL issue 1577 * better attempt to reproduce * preserve skip_empty setting in recursive serializations --------- (cherry picked from commit 4761d56) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com>
miguelgrinberg added a commit that referenced this pull request Aug 20, 2025
…lizations (#3041) (#3046) * Try reproducing DSL issue 1577 * better attempt to reproduce * preserve skip_empty setting in recursive serializations --------- (cherry picked from commit 4761d56) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com>
miguelgrinberg added a commit that referenced this pull request Aug 20, 2025
…lizations (#3041) (#3044) * Try reproducing DSL issue 1577 * better attempt to reproduce * preserve skip_empty setting in recursive serializations --------- (cherry picked from commit 4761d56) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com>
miguelgrinberg added a commit that referenced this pull request Aug 20, 2025
…lizations (#3041) (#3045) * Try reproducing DSL issue 1577 * better attempt to reproduce * preserve skip_empty setting in recursive serializations --------- (cherry picked from commit 4761d56) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> Co-authored-by: Miguel Grinberg <miguel.grinberg@gmail.com>
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.
I wanted to fix elastic/elasticsearch-dsl-py#1577, but realized I wasn't able to reproduce it.