omry / omegaconf
100%
master: 100%

LAST BUILD BRANCH: main
DEFAULT BRANCH: master
Repo Added
Files 19
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH main
branch: SELECT
CHANGE BRANCH
x

coverage: 100.0%. Remained the same
07bca34b-cfd3-4349-a256-b0f3299ac536

push

circleci

omry 
Fix unsafe_merge crash with Union types (Issue #1087)

## Description
Fixes #1087
Supercedes #1088

This PR fixes an `AssertionError` crash that occurs when `OmegaConf.unsafe_merge` is used to merge configurations containing union types.

### Root Cause Analysis
During `unsafe_merge`, OmegaConf skips deepcopying of nodes (`no_deepcopy_set_nodes = True`). However, to prevent circular references, it still performs a safety check during `_set_item_impl` to see if the node being inserted belongs to the *same root config*:
```python
if self._get_root() is value._get_root():
    do_deepcopy = True
```

When a structured config is expanded and it contains a Union type, OmegaConf synthesizes a detached `UnionNode(MISSING)` and attempts to set it. Because `UnionNode` inherits from `Box`, `isinstance(value, Box)` is `True`, and the code executes `value._get_root()`.

Inside `Node._get_root()`, if a node has no parent, it asserts that it must be a `Container`:
```python
def _get_root(self) -> "Container":
    root: Optional[Box] = self._get_parent()
    if root is None:
        assert isinstance(self, Container)  # <--- CRASH
```
Because `UnionNode` is a `Box` but *not* a `Container`, the assertion fails and the program crashes. This bug is completely specific to `unsafe_merge` combined with `UnionNode`s, as other nodes are either not `Box`es (like `IntegerNode`) or are actually `Container`s (like `DictConfig`).

### The Fix
We safely bypass calling `value._get_root()` on detached nodes during the same-config check in `_set_item_impl`. By acknowledging that a detached node (where `_get_parent() is None`) is conceptually its own root, we use `value` directly in the identity check, completely avoiding the problematic assertion in `base.py`.

## Verification
- Added a parameterized test `test_merge_with_nested_structured_config_and_union_type` that ensures both `merge` and `unsafe_merge` evaluate correctly without crashing.
- Full test suite passes with 0 regressions.

2 of 2 new or added lines in 1 file covered. (100.0%)

3662 of 3662 relevant lines covered (100.0%)

1.0 hits per line

Relevant lines Covered
3662 RELEVANT LINES 3662 COVERED LINES
1.0 HITS PER LINE
Source Files on master

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
07bca34b... main Fix unsafe_merge crash with Union types (Issue #1087) ## Description Fixes #1087 Supercedes #1088 This PR fixes an `AssertionError` crash that occurs when `OmegaConf.unsafe_merge` is used to merge configurations containing union types. ### Root... push omry circleci
100.0
85a87a38... main Fix OmegaConf.resolve discrepancy on interpolation to missing OmegaConf.resolve() previously caught InterpolationToMissingValueError and silently overwrote the node with MISSING. This caused is_missing(cfg, "a") to flip False -> True across resol... push omry circleci
100.0
cd8a2be0... main README: point Backlog link to live Pages site push omry circleci
100.0
2979e2a6... main backlog-tool: extract from skill into standalone-installable subproject Move .claude/skills/update-backlog/ to subprojects/backlog-tool/, restructured as a pip-installable Python package with a 'backlog-tool' console script. CLI subcommands: * u... push omry circleci
100.0
ed95a1b4... sapling-pr-archive-omry Merge 9f7fc5001 into sapling-pr-archive-omry push web-flow circleci
100.0
97e08fa5... pr1289 Fix OmegaConf.resolve discrepancy on interpolation to missing OmegaConf.resolve() previously caught InterpolationToMissingValueError and silently overwrote the node with MISSING. This caused is_missing(cfg, "a") to flip False -> True across resol... Pull #1289 omry circleci
100.0
0adfbf34... main Update documentation version in README Updated documentation badge version from 2.1_branch to 2.3_branch. push web-flow circleci
100.0
5dffcbbf... main Fix backlog workflow push retries push omry circleci
100.0
71f692d2... main updated organization of type adapter design docs push omry circleci
100.0
bc48b623... main Refactor type adapter design docs push omry circleci
100.0
See All Builds (2632)