Skip to content

OmegaConf 2.0.0
Compare
Choose a tag to compare
@omry omry released this 04 May 17:49
· 109 commits to 2.0_branch since this release
v2.0.0
c78641e

2.0.0 (2020-05-04)

OmegaConf 2.0 is a major release introducing substantial new features, and introducing some incompatible changes.
The biggest new feature is Structured Configs, which extends OmegaConf into an schema validation system
as well as a configuration system.
With Structured Configs you can create OmegaConf objects from standard dataclasses or attr classes (or objects).
OmegaConf will retain the type information from the source object/class and validate that config mutations are legal.

This is the biggest OmegaConf release ever, the number of unit tests more than trippled (485 to 1571).

Features

  • Add support for initializing OmegaConf from typed objects and classes (#87)
  • DictConfig and ListConfig now implements typing.MutableMapping and typing.MutableSequence. (#114)
  • Enums can now be used as values and keys (#87),(#137)
  • Standardize exception messages (#186)
  • In struct mode, exceptions raised on invalid access are now consistent with Python (#138),(#94)
    • KeyError is raised when using dictionary access style for a missing key: cfg["foo"]
    • AttributeError is raised when using attribute access style for a missing attribute: cfg.foo
  • Structured configs can now inherit from Dict, making them open to arbitrary fields (#134)
  • Container.pretty() now preserves insertion order by default. override with sort_keys=True (#161)
  • Merge into node interpolation is now by value (copying target node) (#184)
  • Add OmegaConf.{is_config, is_list, is_dict} to test if an Object is an OmegaConf object, and if it's a list or a dict (#101)
  • Add OmegaConf.is_missing(cfg, key) to test if a key is missing ('???') in a config (#102)
  • OmegaConf.is_interpolation queries if a node is an interpolation (#239)
  • OmegaConf.is_missing queries if a node is missing (has the value '???') (#239)
  • OmegaConf.is_optional queries if a node in the config is optional (can take None) (#239)
  • OmegaConf.is_none queries if a node represents None (#239)
  • OmegaConf now passes strict mypy tests (#105)
  • Add isort to ensure imports are kept sorted (#107)

Bug Fixes

  • Disable automatic conversion of date strings in yaml decoding (#95)
  • Fixed pretty to handle strings with unicode characters correctly (#111)
  • Fix eq fails if object contains unresolveable values (#124)
  • Correctly throw MissingMandatoryValue on indirect access of missing value (#99)
  • DictConfig pop now returns the underlying value and not ValueNode (#127)
  • OmegaConf.select(key) now returns the root node when key is "" (#135)
  • Add support for loading/saving config files by using pathlib.Path objects (#159)
  • Fix AttributeError when accessing config in struct-mode with get() while providing None as default (#174)

Deprecations and Removals

  • Renamed omegaconf.Config to omegaconf.Container (#103)
  • Dropped support Python 2.7 and 3.5 (#88)
  • cfg.select(key) deprecated in favor of OmegaConf.select(cfg, key) (#116)
  • cfg.update(key, value) deprecated in favor of OmegaConf.update(cfg, key, value) (#116)
  • Container.pretty() behavior change: sorted keys -> unsorted keys by default. override with sort_keys=True. (#161)
  • cfg.to_container() is removed, deprecated since 1.4.0. Use OmegaConf.to_container() (#188)
  • cfg.save() is removed, deprecated since 1.4.0, use OmegaConf.save() (#188)
  • DictConfig item deletion now throws ConfigTypeError if the config is in struct mode (#225)
  • DictConfig.pop() now throws ConfigTypeError if the config is in struct mode (#225)
Assets 2
Loading