diff --git a/NEWS.md b/NEWS.md index 5cce10b60..ee6bc23be 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,47 @@ +## 2.0.1 (2020-09-01) +This is mostly a bugfix release. +The notable change is the config.pretty() is now deprecated in favor of OmegaConf.to_yaml(). + +### Bug Fixes + +- Fixes merging of dict into a Dict[str, str] ([#246](https://github.com/omry/omegaconf/issues/246)) +- Fix DictConfig created from another DictConfig drops node types ([#252](https://github.com/omry/omegaconf/issues/252)) +- Relax save and load APIs to accept IO[Any] ([#253](https://github.com/omry/omegaconf/issues/253)) +- Report errors when loading YAML files with duplicate keys ([#257](https://github.com/omry/omegaconf/issues/257)) +- Fix a bug initializing config with field typed as Any with Structured Config object ([#260](https://github.com/omry/omegaconf/issues/260)) +- Merging into a MISSING Structured config node expands the node first to ensure the result is legal ([#269](https://github.com/omry/omegaconf/issues/269)) +- Fix merging into a config with a read only node if merge is not mutating that node ([#271](https://github.com/omry/omegaconf/issues/271)) +- Fix OmegaConf.to_container() failing in some cases when the config is read-only ([#275](https://github.com/omry/omegaconf/issues/275)) +- Optional[Tuple] types are now supported as type annotation in Structured Configs. ([#279](https://github.com/omry/omegaconf/issues/279)) +- Support indirect interpolation ([#283](https://github.com/omry/omegaconf/issues/283)) +- OmegaConf.save() can now save dataclass and attr classes and instances ([#287](https://github.com/omry/omegaconf/issues/287)) +- OmegaConf.create() doesn't modify yaml.loader.SafeLoader ([#289](https://github.com/omry/omegaconf/issues/289)) +- Fix merging a sublcass Structured Config that adds a field ([#291](https://github.com/omry/omegaconf/issues/291)) +- strings containing valid ints and floats represented are converted to quoted strings instead of the primitives in pretty() ([#296](https://github.com/omry/omegaconf/issues/296)) +- Loading an empty YAML file now returns an empty DictConfig ([#297](https://github.com/omry/omegaconf/issues/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](https://github.com/omry/omegaconf/issues/300)) +- merge_with() now copied flags (readonly, struct) into target config ([#301](https://github.com/omry/omegaconf/issues/301)) +- Fix DictConfig setdefault method to behave as it should ([#304](https://github.com/omry/omegaconf/issues/304)) +- Merging a missing list onto an existing one makes the target missing ([#306](https://github.com/omry/omegaconf/issues/306)) +- Fix error when merging a structured config into a field with None value ([#310](https://github.com/omry/omegaconf/issues/310)) +- Fix a bug that allowed the assignment of containers onto fields annotated as primitive types ([#324](https://github.com/omry/omegaconf/issues/324)) +- Merging a List of a structured with a different type now raises an error. ([#327](https://github.com/omry/omegaconf/issues/327)) +- Remove dot-keys usage warning ([#332](https://github.com/omry/omegaconf/issues/332)) +- Fix merging into an Optional[List[Any]] = None ([#336](https://github.com/omry/omegaconf/issues/336)) +- Fix to properly merge list of dicts into a list of dataclasses ([#348](https://github.com/omry/omegaconf/issues/348)) +- OmegaConf.to_yaml() now properly support Structured Configs ([#350](https://github.com/omry/omegaconf/issues/350)) + +### Deprecations and Removals + +- cfg.pretty() is deprecated in favor of OmegaConf.to_yaml(config). ([#263](https://github.com/omry/omegaconf/issues/263)) + +### Improved Documentation + +- Document serialization APIs ([#278](https://github.com/omry/omegaconf/issues/278)) +- Document OmegaConf.is_interpolation and OmegaConf.is_none ([#286](https://github.com/omry/omegaconf/issues/286)) +- Document OmegaConf.get_type() ([#343](https://github.com/omry/omegaconf/issues/343)) + + ## 2.0.0 (2020-05-04) OmegaConf 2.0 is a major release introducing substantial new ### Features, and introducing some incompatible changes. diff --git a/news/246.bugfix b/news/246.bugfix deleted file mode 100644 index 0f57fd0ff..000000000 --- a/news/246.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fixes merging of dict into a Dict[str, str] \ No newline at end of file diff --git a/news/252.bugfix b/news/252.bugfix deleted file mode 100644 index 3aade2110..000000000 --- a/news/252.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix DictConfig created from another DictConfig drops node types diff --git a/news/253.bugfix b/news/253.bugfix deleted file mode 100644 index 468dd09fd..000000000 --- a/news/253.bugfix +++ /dev/null @@ -1 +0,0 @@ -Relax save and load APIs to accept IO[Any] diff --git a/news/257.bugfix b/news/257.bugfix deleted file mode 100644 index 0657d4af9..000000000 --- a/news/257.bugfix +++ /dev/null @@ -1 +0,0 @@ -Report errors when loading YAML files with duplicate keys diff --git a/news/260.bugfix b/news/260.bugfix deleted file mode 100644 index 0c2e6daff..000000000 --- a/news/260.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix a bug initializing config with field typed as Any with Structured Config object diff --git a/news/263.removal b/news/263.removal deleted file mode 100644 index c8112d528..000000000 --- a/news/263.removal +++ /dev/null @@ -1 +0,0 @@ -cfg.pretty() is deprecated in favor of OmegaConf.to_yaml(config). diff --git a/news/269.bugfix b/news/269.bugfix deleted file mode 100644 index 6f49937f0..000000000 --- a/news/269.bugfix +++ /dev/null @@ -1 +0,0 @@ -Merging into a MISSING Structured config node expands the node first to ensure the result is legal diff --git a/news/271.bugfix b/news/271.bugfix deleted file mode 100644 index a84869169..000000000 --- a/news/271.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix merging into a config with a read only node if merge is not mutating that node diff --git a/news/275.bugfix b/news/275.bugfix deleted file mode 100644 index ab0cbb289..000000000 --- a/news/275.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix OmegaConf.to_container() failing in some cases when the config is read-only diff --git a/news/278.docs b/news/278.docs deleted file mode 100644 index 2923d0bed..000000000 --- a/news/278.docs +++ /dev/null @@ -1 +0,0 @@ -Document serialization APIs diff --git a/news/279.bugfix b/news/279.bugfix deleted file mode 100644 index bfafe5b3c..000000000 --- a/news/279.bugfix +++ /dev/null @@ -1 +0,0 @@ -Optional[Tuple] types are now supported as type annotation in Structured Configs. diff --git a/news/283.bugfix b/news/283.bugfix deleted file mode 100644 index 8242b85a3..000000000 --- a/news/283.bugfix +++ /dev/null @@ -1 +0,0 @@ -Support indirect interpolation diff --git a/news/286.docs b/news/286.docs deleted file mode 100644 index da63558cd..000000000 --- a/news/286.docs +++ /dev/null @@ -1 +0,0 @@ -Document OmegaConf.is_interpolation and OmegaConf.is_none diff --git a/news/287.bugfix b/news/287.bugfix deleted file mode 100644 index 2af07acfd..000000000 --- a/news/287.bugfix +++ /dev/null @@ -1 +0,0 @@ -OmegaConf.save() can now save dataclass and attr classes and instances diff --git a/news/289.bugfix b/news/289.bugfix deleted file mode 100644 index ace7ac1d3..000000000 --- a/news/289.bugfix +++ /dev/null @@ -1 +0,0 @@ -OmegaConf.create() doesn't modify yaml.loader.SafeLoader diff --git a/news/291.bugfix b/news/291.bugfix deleted file mode 100644 index 636d2ef39..000000000 --- a/news/291.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix merging a sublcass Structured Config that adds a field diff --git a/news/296.bugfix b/news/296.bugfix deleted file mode 100644 index 2f59be01d..000000000 --- a/news/296.bugfix +++ /dev/null @@ -1 +0,0 @@ -strings containing valid ints and floats represented are converted to quoted strings instead of the primitives in pretty() diff --git a/news/297.bugfix b/news/297.bugfix deleted file mode 100644 index b8f3cf7e7..000000000 --- a/news/297.bugfix +++ /dev/null @@ -1 +0,0 @@ -Loading an empty YAML file now returns an empty DictConfig \ No newline at end of file diff --git a/news/300.bugfix b/news/300.bugfix deleted file mode 100644 index 9f565ca62..000000000 --- a/news/300.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix bug that allowed an annotated List and Dict field in a Structured Config to be assigned a value of a different type. diff --git a/news/301.bugfix b/news/301.bugfix deleted file mode 100644 index ddc6ddd8d..000000000 --- a/news/301.bugfix +++ /dev/null @@ -1 +0,0 @@ -merge_with() now copied flags (readonly, struct) into target config diff --git a/news/304.bugfix b/news/304.bugfix deleted file mode 100644 index 2dfb3fc04..000000000 --- a/news/304.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix DictConfig setdefault method to behave as it should diff --git a/news/306.bugfix b/news/306.bugfix deleted file mode 100644 index 158fb73cf..000000000 --- a/news/306.bugfix +++ /dev/null @@ -1 +0,0 @@ -Merging a missing list onto an existing one makes the target missing diff --git a/news/310.bugfix b/news/310.bugfix deleted file mode 100644 index 009e36654..000000000 --- a/news/310.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix error when merging a structured config into a field with None value diff --git a/news/324.bugfix b/news/324.bugfix deleted file mode 100644 index ae468813f..000000000 --- a/news/324.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix a bug that allowed the assignment of containers onto fields annotated as primitive types diff --git a/news/327.bugfix b/news/327.bugfix deleted file mode 100644 index f06e65bf9..000000000 --- a/news/327.bugfix +++ /dev/null @@ -1 +0,0 @@ -Merging a List of a structured with a different type now raises an error. diff --git a/news/332.bugfix b/news/332.bugfix deleted file mode 100644 index 64f414a3e..000000000 --- a/news/332.bugfix +++ /dev/null @@ -1 +0,0 @@ -Remove dot-keys usage warning diff --git a/news/336.bugfix b/news/336.bugfix deleted file mode 100644 index 0f2dc20b0..000000000 --- a/news/336.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix merging into an Optional[List[Any]] = None diff --git a/news/343.docs b/news/343.docs deleted file mode 100644 index 2efad605f..000000000 --- a/news/343.docs +++ /dev/null @@ -1 +0,0 @@ -Document OmegaConf.get_type() diff --git a/news/348.bugfix b/news/348.bugfix deleted file mode 100644 index ca6b4a32b..000000000 --- a/news/348.bugfix +++ /dev/null @@ -1 +0,0 @@ -Fix to properly merge list of dicts into a list of dataclasses diff --git a/news/350.bugfix b/news/350.bugfix deleted file mode 100644 index c105b64cf..000000000 --- a/news/350.bugfix +++ /dev/null @@ -1 +0,0 @@ -OmegaConf.to_yaml() now properly support Structured Configs