Make sure cached easyconfigs don't get modifed#4818
Open
Flamefire wants to merge 8 commits intoeasybuilders:developfrom
Open
Make sure cached easyconfigs don't get modifed#4818Flamefire wants to merge 8 commits intoeasybuilders:developfrom
Flamefire wants to merge 8 commits intoeasybuilders:developfrom
Conversation
…tances" This reverts commit 3836140.
This reverts commit 5f04b7b.
The `__deepcopy__` needs to be very generic to avoid misleading results by not copying all (possibly changed) attributes. So leave that alone and use `ec.copy()` on the `'ec'` key directly in the cache code.
Contributor
Author
|
Rebased |
boegel
changed the title
boegel
requested changes
Sep 3, 2025
|
|
||
| def _copy_ec_dict(easyconfig): | ||
| """Copy an easyconfig dict as (initially) parsed""" | ||
| ec = easyconfig.pop('ec') # Don't copy this via deepcopy |
Member
There was a problem hiding this comment.
Comment should be clarified: why not
Contributor
Author
There was a problem hiding this comment.
Done: We need ec.copy
| """Copy an easyconfig dict as (initially) parsed""" | ||
| ec = easyconfig.pop('ec') # Don't copy this via deepcopy | ||
| try: | ||
| new_easyconfig = copy.deepcopy(easyconfig) # Copy the rest of the dict |
Member
There was a problem hiding this comment.
Can you clarify why this is in a try?
What if this fails? Then new_easyconfig will be undefined, and we'll get a nasty crash, no?
Contributor
Author
There was a problem hiding this comment.
This is a try-finally. So it will still propagate all errors. The only difference is that in all cases ec (removed above) is put back to the original easyconfig
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
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.
The type that is cached is a dictionary containing the EasyConfig in the
"ec"key. Hence we end up invokingdict.copynotec.copyThis results in not making independent copies and hence modifications affect all references even those gotten later
Revert 3836140 which introduced the issue
Our current
EasyConfig.copymethod effectively parses the EasyConfig text again invoking e.g. theparse_hookagain.I guess
__deepcopy__needs to be more smart than this to not also miss attributes set after the construction. Hence I left that out and just usedec.copy()as was likely intended by the above commit. It just needs to be done on the EasyConfig instance while the dict itself can be deep-copied if it doesn't contain the easyconfig.