- Fix bug where DictConfig's shallow copy didn't work properly in some cases. (#450)
- Fix bug where interpolations were unnecessarily resolved during merge (#431)
- Fix a bug merging into a field annotated as Optional[List[int]] = None (#428)
- Automatic expansion of nested dataclasses without a default value is deprecated (#412)
- OmegaConf.update() now takes a merge flag to indicate merge or set for config values (#363)
- Fix cfg.pretty() deprecation warning (#358)
- Properly crash when accessing
${foo.bar}iffoois a value node (instead of silently returning${foo}) (#364)
- OmegaConf.update() now warns if the merge flag is not specified (#367)
This is mostly a bugfix release. The notable change is the config.pretty() is now deprecated in favor of OmegaConf.to_yaml().
- Fixes merging of dict into a Dict[str, str] (#246)
- Fix DictConfig created from another DictConfig drops node types (#252)
- Relax save and load APIs to accept IO[Any] (#253)
- Report errors when loading YAML files with duplicate keys (#257)
- Fix a bug initializing config with field typed as Any with Structured Config object (#260)
- Merging into a MISSING Structured config node expands the node first to ensure the result is legal (#269)
- Fix merging into a config with a read only node if merge is not mutating that node (#271)
- Fix OmegaConf.to_container() failing in some cases when the config is read-only (#275)
- Optional[Tuple] types are now supported as type annotation in Structured Configs. (#279)
- Support indirect interpolation (#283)
- OmegaConf.save() can now save dataclass and attr classes and instances (#287)
- OmegaConf.create() doesn't modify yaml.loader.SafeLoader (#289)
- Fix merging a sublcass Structured Config that adds a field (#291)
- strings containing valid ints and floats represented are converted to quoted strings instead of the primitives in pretty() (#296)
- Loading an empty YAML file now returns an empty DictConfig (#297)
- Fix bug that allowed an annotated List and Dict field in a Structured Config to be assigned a value of a different type. (#300)
- merge_with() now copied flags (readonly, struct) into target config (#301)
- Fix DictConfig setdefault method to behave as it should (#304)
- Merging a missing list onto an existing one makes the target missing (#306)
- Fix error when merging a structured config into a field with None value (#310)
- Fix a bug that allowed the assignment of containers onto fields annotated as primitive types (#324)
- Merging a List of a structured with a different type now raises an error. (#327)
- Remove dot-keys usage warning (#332)
- Fix merging into an Optional[List[Any]] = None (#336)
- Fix to properly merge list of dicts into a list of dataclasses (#348)
- OmegaConf.to_yaml() now properly support Structured Configs (#350)
- cfg.pretty() is deprecated in favor of OmegaConf.to_yaml(config). (#263)
- Document serialization APIs (#278)
- Document OmegaConf.is_interpolation and OmegaConf.is_none (#286)
- Document OmegaConf.get_type() (#343)
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).
- 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)
- 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)
- 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)
- ListConfig now implements + operator (Allowing concatenation with other ListConfigs) (#36)
- OmegaConf.save() now takes a resolve flag (defaults False) (#37)
- Add OmegaConf.masked_copy(keys) function that returns a copy of a config with a subset of the keys (#42)
- Improve built-in env resolver to return properly typed values ("1" -> int, "1.0" -> float etc) (#44)
- Resolvers can now accept a list of zero or more arguments, for example: "${foo:a,b,..,n}" (#46)
- Change semantics of contains check ('x' in conf): Missing mandatory values ('???') are now considered not included and contains test returns false for them (#49)
- Allow assignment of a tuple value into a Config (#74)
- Read-only list can no longer be replaced with command line override (#39)
- Fix an error when expanding an empty dictionary in PyCharm debugger (#40)
- Fix a bug in open_dict causing improper restoration of struct flag in some cases (#47)
- Fix a bug preventing dotlist values from containing '=' (foo=bar=10 -> key: foo, value: bar=10) (#56)
- Config.merge_with_dotlist() now throws if input is not a list or tuple of strings (#72)
- Add copy method for DictConfig and improve shallow copy support (#82)
- Deprecated Config.to_container() in favor of OmegaConf.to_container() (##41)
- Deprecated config.save(file) in favor of OmegaConf.save(config, file) (#66)
- Remove OmegaConf.{empty(), from_string(), from_dict(), from_list()}. Use OmegaConf.create() (deprecated since 1.1.5) (#67)
- Remove Config.merge_from(). Use Config.merge_with() (deprecated since 1.1.0) (#67)
- Remove OmegaConf.from_filename() and OmegaConf.from_file(). Use OmegaConf.load() (deprecated since 1.1.5) (#67)