-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
benedict: monkeypatch, performance improvements, bugfixes #6706
Merged
Merged
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 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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
""" | ||
Rollbacks monkeypatching of `json.encoder` by benedict. | ||
|
||
It monkeypatches json to use Python-based encoder instead of C-based | ||
during import. | ||
|
||
We rollback that monkeypatch by keeping reference to that C-based | ||
encoder and reinstate them after importing benedict. | ||
See: https://github.com/iterative/dvc/issues/6423 | ||
https://github.com/fabiocaccamo/python-benedict/issues/62 | ||
and the source of truth: | ||
https://github.com/fabiocaccamo/python-benedict/blob/c98c471065/benedict/dicts/__init__.py#L282-L285 | ||
""" | ||
from json import encoder | ||
|
||
try: | ||
c_make_encoder = encoder.c_make_encoder # type: ignore[attr-defined] | ||
except AttributeError: | ||
c_make_encoder = None | ||
|
||
|
||
from benedict import benedict # noqa: E402 | ||
|
||
encoder.c_make_encoder = c_make_encoder # type: ignore[attr-defined] | ||
# Please import benedict from here lazily | ||
__all__ = ["benedict"] |
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
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 |
---|---|---|
@@ -1,4 +1,7 @@ | ||
# pylint: disable=unidiomatic-typecheck | ||
import json | ||
from json import encoder | ||
|
||
import pytest | ||
from mock import create_autospec | ||
|
||
|
@@ -8,6 +11,7 @@ | |
merge_params, | ||
validate, | ||
) | ||
from dvc.utils.serialize import dumps_yaml | ||
|
||
|
||
class MyDict(dict): | ||
|
@@ -143,6 +147,12 @@ def none_filter(result): | |
assert result == [1, 2] | ||
|
||
|
||
def is_serializable(d): | ||
json.dumps(d) | ||
dumps_yaml(d) | ||
return True | ||
|
||
|
||
@pytest.mark.parametrize( | ||
"changes, expected", | ||
[ | ||
|
@@ -195,6 +205,8 @@ def test_merge_params(changes, expected): | |
merged = merge_params(params, changes) | ||
assert merged == expected == params | ||
assert params is merged # references should be preserved | ||
assert encoder.c_make_encoder | ||
assert is_serializable(params) | ||
|
||
|
||
@pytest.mark.parametrize( | ||
|
@@ -203,10 +215,20 @@ def test_merge_params(changes, expected): | |
[{"foo": "baz"}, {"foo": "baz"}], | ||
[{"foo": "baz", "goo": "bar"}, {"foo": "baz", "goo": "bar"}], | ||
[{"foo[1]": ["baz", "goo"]}, {"foo": [None, ["baz", "goo"]]}], | ||
[{"foo.bar": "baz"}, {"foo": {"bar": "baz"}}], | ||
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. Testing for scenario mentioned in #6476, coupled with |
||
], | ||
) | ||
def test_merge_params_on_empty_src(changes, expected): | ||
params = {} | ||
merged = merge_params(params, changes) | ||
assert merged == expected == params | ||
assert params is merged # references should be preserved | ||
assert encoder.c_make_encoder | ||
assert is_serializable(params) | ||
|
||
|
||
def test_benedict_rollback_its_monkeypatch(): | ||
from dvc.utils._benedict import benedict | ||
|
||
assert benedict({"foo": "foo"}) == {"foo": "foo"} | ||
assert encoder.c_make_encoder | ||
Comment on lines
+230
to
+234
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. Test for the monkeypatch that we rollback. |
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.
This
else
was for a bug in thebenedict
, and it has been fixed. To resolve this bug, that monkeypatch I mentioned was introduced 😢. We no longer need thiselse
block, and tests should cover this if it breaks again in the future.