Skip to content

Fix RuntimeError: OrderedDict mutated during iteration in _fixup_self_references #348

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.

Sign up for GitHub

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
haobibo wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix RuntimeError: OrderedDict mutated during iteration in _fixup_self_references #348

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a950110
Refactor _fixup_self_references method for clarity
haobibo Jun 23, 2026
857a1f9
Update config_parser.py
haobibo Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions pyhocon/config_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,17 +467,18 @@ def _resolve_variable(cls, config, substitution):
@classmethod
def _fixup_self_references(cls, config, accept_unresolved=False):
if isinstance(config, ConfigTree) and config.root:
for key in config: # Traverse history of element
history = config.history[key]
for key in list(config.keys()): # Use list to avoid mutation error during iteration
history = config.history.get(key)
if not history:
continue
previous_item = history[0]
for current_item in history[1:]:
for substitution in cls._find_substitutions(current_item):
prop_path = ConfigTree.parse_key(substitution.variable)
if len(prop_path) > 1 and config.get(substitution.variable, None) is not None:
continue # If value is present in latest version, don't do anything
continue
if prop_path[0] == key:
if isinstance(previous_item, ConfigValues) and not accept_unresolved:
# We hit a dead end, we cannot evaluate
raise ConfigSubstitutionException(
"Property {variable} cannot be substituted. Check for cycles.".format(
variable=substitution.variable
Expand All @@ -493,13 +494,13 @@ def _fixup_self_references(cls, config, accept_unresolved=False):
for substitution in cls._find_substitutions(previous_item):
prop_path = ConfigTree.parse_key(substitution.variable)
if len(prop_path) > 1 and config.get(substitution.variable, None) is not None:
continue # If value is present in latest version, don't do anything
continue
if prop_path[0] == key:
value = os.environ.get(key)
if value is not None:
cls._do_substitute(substitution, value)
continue
if substitution.optional: # special case, when self optional referencing without existing
if substitution.optional:
cls._do_substitute(substitution, None)

# traverse config to find all the substitutions
Expand Down