Repository navigation
fix: keep nested None and passed empty lists in update payloads #1221
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
Open
dheerajitbhu
wants to merge
1
commit into
apify:master
Choose a base branch
from
dheerajitbhu:fix/clean-payload-nested-none
base: master
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
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 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
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -153,38 +153,28 @@ def _build_params(self, **kwargs: QueryParamValue) -> dict[str, QueryParamValue] | |||||||||||||
|
|
||||||||||||||
| @staticmethod | ||||||||||||||
| def _clean_json_payload(data: dict) -> dict: | ||||||||||||||
| """Remove None values and empty nested dicts from an API request payload. | ||||||||||||||
| """Remove unset top-level fields and empty nested dicts from an API request payload. | ||||||||||||||
|
|
||||||||||||||
| The Apify API ignores missing fields but may reject fields explicitly set to None. | ||||||||||||||
| Nested sub-models serialized by Pydantic may produce empty dicts when all their | ||||||||||||||
| fields are None - these are also removed. | ||||||||||||||
| A top-level `None` means the caller did not pass the argument, so the field is left out. `None` inside | ||||||||||||||
| a nested value the caller passed is kept and sent as `null`, so for example | ||||||||||||||
| `tagged_builds={'beta': None}` sends `{"taggedBuilds": {"beta": null}}` and removes the tag. | ||||||||||||||
|
Comment on lines
+158
to
+160
Contributor
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. Nit: the docstring can use the full 120-character line length.
Suggested change
✍️ Drafted by Claude Code |
||||||||||||||
|
|
||||||||||||||
| Uses an iterative stack-based approach, analogous to _build_params for query params. | ||||||||||||||
| Nested sub-models serialized by Pydantic with `exclude_none=True` produce empty dicts when all their | ||||||||||||||
| fields are unset - these are removed at every nesting level. | ||||||||||||||
| """ | ||||||||||||||
| result: dict = {} | ||||||||||||||
| stack: list[tuple[dict, dict]] = [(data, result)] | ||||||||||||||
|
|
||||||||||||||
| while stack: | ||||||||||||||
| source, target = stack.pop() | ||||||||||||||
| for key, val in source.items(): | ||||||||||||||
| if val is None: | ||||||||||||||
| continue | ||||||||||||||
|
|
||||||||||||||
| def _remove_empty(d: dict) -> dict: | ||||||||||||||
| result: dict = {} | ||||||||||||||
| for key, val in d.items(): | ||||||||||||||
| if isinstance(val, dict): | ||||||||||||||
| nested: dict = {} | ||||||||||||||
| target[key] = nested | ||||||||||||||
| stack.append((val, nested)) | ||||||||||||||
| cleaned = _remove_empty(val) | ||||||||||||||
| if cleaned: | ||||||||||||||
| result[key] = cleaned | ||||||||||||||
| else: | ||||||||||||||
| target[key] = val | ||||||||||||||
|
|
||||||||||||||
| # Remove dicts that became empty after None filtering | ||||||||||||||
| def _remove_empty(d: dict) -> None: | ||||||||||||||
| for key in [k for k, v in d.items() if isinstance(v, dict)]: | ||||||||||||||
| _remove_empty(d[key]) | ||||||||||||||
| if not d[key]: | ||||||||||||||
| del d[key] | ||||||||||||||
| result[key] = val | ||||||||||||||
| return result | ||||||||||||||
|
|
||||||||||||||
| _remove_empty(result) | ||||||||||||||
| return result | ||||||||||||||
| return _remove_empty({key: val for key, val in data.items() if val is not None}) | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| @docs_group('Resource clients') | ||||||||||||||
|
|
||||||||||||||
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
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
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
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
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
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
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.
Question: a nested
Nonethe caller passes is kept now, but a nested{}they pass is still removed, sotagged_builds={'beta': {}}is dropped. Is that intended? The JS client sends both as given.✍️ Drafted by Claude Code