Skip to main content

OmegaConf 2.4.0 is released

· 2 min read
Omry Yadan
Omry Yadan

OmegaConf 2.4.0 is now available on PyPI. It is the first feature release since 2.3.0 in 2022 and requires Python 3.10 or newer.

This release adds richer structured config typing, experimental tuple support, and improvements to interpolation, resolvers, merging, and validation.

Highlights​

  • Structured configs support Literal annotations, unions of typed containers, and unions of structured config types.
  • Experimental tuple support introduces immutable TupleConfig values.
  • Custom resolvers can validate arguments and return values against their annotations, with advisory warnings by default.
  • DictConfig supports | and |= for merging, and key paths can escape literal dots, brackets, and equals signs.
  • YAML loading and dumping use PyYAML's C implementations when available.

See the full release notes for all changes and fixes.

Upgrading​

Review the 2.4 upgrade guide before upgrading. Alongside the Python version requirement, native tuples become immutable TupleConfig values, OmegaConf.create(None) returns None, and some implicit conversions during assignment now warn.

python -m pip install --upgrade 'omegaconf>=2.4,<2.5'

The stable documentation covers 2.4. Documentation for 2.3 remains available for projects using the previous release, and Next follows development on main.

The optional omegaconf-pydevd debugger plugin is also available at version 2.4.0.