DictConfig/ListConfig.get/pop() should not fall back to default value on interpolation errors
#565
Assignees
Milestone
Comments
omry
pushed a commit
that referenced
this issue
Mar 3, 2021
* Interpolations are never considered to be missing anymore, even if they point to a missing node * When resolving an expression containing an interpolation pointing to a missing node, an `InterpolationToMissingValueError` exception is raised * When resolving an expression containing an interpolation pointing to a node that does not exist, an `InterpolationKeyError` exception is raised * `key in cfg` returns True whenever `key` is an interpolation, even if it cannot be resolved (including interpolations to missing nodes) * `get()` and `pop()` no longer return the default value in case of interpolation resolution failure (same thing for `OmegaConf.select()`) * If `throw_on_resolution_failure` is False, then resolving an interpolation resulting in a resolution failure always leads to the result being `None` (instead of potentially being an expression computed from `None`) Fixes #543 Fixes #561 Fixes #562 Fixes #565
odelalleau
added a commit
to odelalleau/omegaconf
that referenced
this issue
Mar 10, 2021
* Interpolations are never considered to be missing anymore, even if they point to a missing node * When resolving an expression containing an interpolation pointing to a missing node, an `InterpolationToMissingValueError` exception is raised * When resolving an expression containing an interpolation pointing to a node that does not exist, an `InterpolationKeyError` exception is raised * `key in cfg` returns True whenever `key` is an interpolation, even if it cannot be resolved (including interpolations to missing nodes) * `get()` and `pop()` no longer return the default value in case of interpolation resolution failure (same thing for `OmegaConf.select()`) * If `throw_on_resolution_failure` is False, then resolving an interpolation resulting in a resolution failure always leads to the result being `None` (instead of potentially being an expression computed from `None`) Fixes omry#543 Fixes omry#561 Fixes omry#562 Fixes omry#565
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
Currently, calling
cfg.get(key, default_value)orcfg.pop(key, default_value)wherecfgis either a DictConfig or a ListConfig will returndefault_valueifkeyis an interpolation whose resolution fails (e.g., to a non-existing node, or a non-existing custom resolver). This can be dangerous as it may hide errors.Describe the solution you'd like
If
keyexists and is an interpolation,get()andpop()should either return the resolved value (if possible), or raise an exception (if the interpolation can't be resolved).In addition,
OmegaConf.select()should be modified to be consistent with this new behavior, i.e., callingOmegaConf.select(cfg, key, default=val)should not return the default value ifkeyis an interpolation to a non-existing node.Additional context
Fixed in #545. Creating this issue to keep track of changes.
The text was updated successfully, but these errors were encountered: