Prevent SimulationApp overrides from mutating launcher defaults - #770
Open
sylvesterkaczmarek wants to merge 3 commits into
Open
Prevent SimulationApp overrides from mutating launcher defaults#770sylvesterkaczmarek wants to merge 3 commits into
sylvesterkaczmarek wants to merge 3 commits into
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
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.
Description
Prevent per-instance
SimulationApplaunch configuration from mutating the class-levelDEFAULT_LAUNCHER_CONFIG.SimulationApp.__init__()currently assigns the mutable class dictionary directly and then mutatesself.configwithupdate()andpop(). Because both names reference the same dictionary, overrides from one instance are written back into the class defaults and can leak into later instances.Initialize the instance from a shallow copy instead:
The current initialization path replaces configuration values rather than mutating nested values in place, so a shallow copy is sufficient.
Validation
simulation_app.pypy_compileThis repository bug was found while reviewing
SimulationApp; the connected GitHub integration cannot open a new upstream issue, so the root cause is documented here.