OmegaConf 2.2.1 release

omry · May 17, 2022 · fc51948 · fc51948
1 parent 0bac52d
commit fc51948
Show file tree

Hide file tree

Showing 20 changed files with 34 additions and 19 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,36 @@
+## 2.2.1 (2022-05-17)
+OmegaConf 2.2 is a major release. The most significant area of improvement in
+2.2 is support for more flexible type hints in structured configs. In addition,
+OmegaConf now natively supports two new primitive types, `bytes` and `pathlib.Path`.
+
+### Features
+
+- Support unions of primitive types in structured config type hints (`typing.Union`) ([#144](https://github.com/omry/omegaconf/issues/144))
+- Support nested container type hints in structured configs, e.g. dict-of-dict and list-of-list ([#427](https://github.com/omry/omegaconf/issues/427))
+- Improve support for optional element types in structured config container type hints (`typing.Optional`) ([#460](https://github.com/omry/omegaconf/issues/460))
+- Add support for `bytes`-typed values ([#844](https://github.com/omry/omegaconf/issues/844))
+- Add support for `pathlib.Path`-typed values ([#97](https://github.com/omry/omegaconf/issues/97))
+- `ListConfig` now implements slice assignment ([#736](https://github.com/omry/omegaconf/issues/736))
+- Enable adding a `ListConfig` to a `list` via the `ListConfig.__radd__` dunder method ([#849](https://github.com/omry/omegaconf/issues/849))
+- Add `OmegaConf.missing_keys()`, a method that returns the missing keys in a config object ([#720](https://github.com/omry/omegaconf/issues/720))
+- Add `OmegaConf.clear_resolver()`, a method to remove interpolation resolvers by name ([#769](https://github.com/omry/omegaconf/issues/769))
+- Enable the use of a pipe symbol `|` in unquoted strings in OmegaConf interpolations ([#799](https://github.com/omry/omegaconf/issues/799))
+
+### Bug Fixes
+
+- `OmegaConf.to_object` now works properly with structured configs that have `init=False` fields ([#789](https://github.com/omry/omegaconf/issues/789))
+- Fix bugs related to creation of structured configs from dataclasses having fields with a default_factory ([#831](https://github.com/omry/omegaconf/issues/831))
+
+### API changes and deprecations
+
+- Removed support for `OmegaConf.is_none(cfg, "key")`.  Please use `cfg.key is None` instead. ([#547](https://github.com/omry/omegaconf/issues/547))
+- Removed support for `${env}` interpolations.  `${oc.env}` should be used instead. ([#573](https://github.com/omry/omegaconf/issues/573))
+- Removed `OmegaConf.get_resolver()`.  Please use `OmegaConf.has_resolver()` instead. ([#608](https://github.com/omry/omegaconf/issues/608))
+- Removed support for `OmegaConf.is_optional()`. ([#698](https://github.com/omry/omegaconf/issues/698))
+- Improved error message when assigning an invalid value to int or float config nodes ([#743](https://github.com/omry/omegaconf/issues/743))
+- To conform with the `MutableMapping` API, the `DictConfig.items` method now returns an object of type `ItemsView`, and `DictConfig.keys` will now always return a `KeysView` ([#848](https://github.com/omry/omegaconf/issues/848))
+
+
 ## 2.1.1 (2021-08-17)
 ### Features
 

diff --git a/news/144.feature b/news/144.feature
diff --git a/news/427.feature b/news/427.feature
diff --git a/news/460.feature b/news/460.feature
diff --git a/news/547.api_change b/news/547.api_change
diff --git a/news/573.api_change b/news/573.api_change
diff --git a/news/608.api_change b/news/608.api_change
diff --git a/news/698.api_change b/news/698.api_change
diff --git a/news/720.feature b/news/720.feature
diff --git a/news/736.feature b/news/736.feature
diff --git a/news/743.api_change b/news/743.api_change
diff --git a/news/769.feature b/news/769.feature
diff --git a/news/789.bugfix b/news/789.bugfix
diff --git a/news/799.feature b/news/799.feature
diff --git a/news/831.bugfix b/news/831.bugfix
diff --git a/news/844.feature b/news/844.feature
diff --git a/news/848.api_change b/news/848.api_change
diff --git a/news/849.feature b/news/849.feature
diff --git a/news/97.feature b/news/97.feature
diff --git a/omegaconf/version.py b/omegaconf/version.py
@@ -1,6 +1,6 @@
 import sys  # pragma: no cover
 
-__version__ = "2.2.0.dev6"
+__version__ = "2.2.1"
 
 msg = """OmegaConf 2.0 and above is compatible with Python 3.6 and newer.
 You have the following options: