omry / omegaconf
100%
master: 100%

LAST BUILD BRANCH: main
DEFAULT BRANCH: master
Repo Added
Files 20
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 pr1279
branch: pr1279
CHANGE BRANCH
x

coverage: 100.0%. Remained the same
7f526e11-2fdf-410e-ad0e-65c6797aa443

Pull #1279

circleci

omry 
Allow backslash-escaping of special characters in key paths

Keys in YAML can legally contain dots, brackets, and equals signs, but there
was previously no way to target them via OmegaConf.update(), OmegaConf.select(),
OmegaConf.from_dotlist(), or OmegaConf.from_cli(). All of those converge on
split_key() to parse the key path, and the parser had no concept of escaping.

This change adds backslash escaping so those keys are reachable:

    cfg = OmegaConf.create({"a.b": 42})
    OmegaConf.select(cfg, r"a\.b")    # 42
    OmegaConf.update(cfg, r"a\.b", 1)

    cfg = OmegaConf.from_dotlist([r"a\.b\=c=42"])
    assert cfg["a.b=c"] == 42

Escape rules (backslash is only special before . [ ] =):
    \.  →  literal dot in key
    \[  →  literal [ in key
    \]  →  literal ] in key
    \=  →  literal = in key (most relevant for dotlist / CLI keys)
    \x  →  \x unchanged (backslash passes through before any other character)

Breaking change: a backslash immediately before one of the delimiter characters
(. [ ] =) now escapes that delimiter instead of being treated as a literal
backslash followed by an active delimiter. Concretely, a key path like r"a\.b"
previously resolved to the key "a\" nested under the root followed by key "b";
it now resolves to the single key "a.b". Code that relied on the old behavior
for such paths will need to be updated.

Note for CLI users: shells consume single backslashes, so quote the argument
or double-escape: 'a\.b=1' or a\\.b=1.

Closes #1230.

---

Implementation

split_key() previously used two compiled regexes applied sequentially (dot-split,
then bracket-split). With escaping in play that approach breaks — a delimiter
character inside a key would be indistinguishable from a real delimiter — so the
regexes are replaced with a small character-by-character parser (dot mode /
bracket mode) that applies escape rules in both modes.

A fast path checks for a backslash before entering the parser, so key paths
without escaping ne... (continued)
Pull Request #1279: Allow backslash-escaping of special characters in key paths

64 of 64 new or added lines in 2 files covered. (100.0%)

3563 of 3563 relevant lines covered (100.0%)

1.0 hits per line

Relevant lines Covered
3563 RELEVANT LINES 3563 COVERED LINES
1.0 HITS PER LINE
Source Files on pr1279

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
7f526e11... pr1279 Allow backslash-escaping of special characters in key paths Keys in YAML can legally contain dots, brackets, and equals signs, but there was previously no way to target them via OmegaConf.update(), OmegaConf.select(), OmegaConf.from_dotlist(), or... Pull #1279 omry circleci
100.0
See All Builds (2724)