omegaconf 2.3.0.dev1__tar.gz → 2.3.1__tar.gz

{omegaconf-2.3.0.dev1/omegaconf.egg-info → omegaconf-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: omegaconf
-Version: 2.3.0.dev1
+Version: 2.3.1
 Summary: A flexible configuration library
 Home-page: https://github.com/omry/omegaconf
 Author: Omry Yadan
@@ -11,11 +11,26 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: antlr4-python3-runtime==4.9.*
+Requires-Dist: PyYAML>=5.1.0
+Requires-Dist: dataclasses; python_version == "3.6"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # OmegaConf
 |  | Description |
@@ -30,16 +45,26 @@ providing a consistent API regardless of how the configuration was created.
 
 ## Releases
 
-### Stable (2.2)
-OmegaConf 2.2 is the current stable version.
-* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.2.1)
-* [Documentation](https://omegaconf.readthedocs.io/en/2.2_branch/)
-* [Source code](https://github.com/omry/omegaconf/tree/2.2_branch)
+### Stable (2.3)
+OmegaConf 2.3 is the current stable version.
+* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.3.0)
+* [Documentation](https://omegaconf.readthedocs.io/en/2.3_branch/)
+* [Source code](https://github.com/omry/omegaconf/tree/2.3_branch)
 
 Install with `pip install --upgrade omegaconf`
 
+### Previous release (2.2)
+
+* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)
+* [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)
+* [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)
+* [Source code](https://github.com/omry/omegaconf/tree/2.1_branch)
+
+Install with `pip install omegaconf==2.1`
+
+
 ### Previous release (2.1)
-OmegaConf 2.1 is the current stable version.
+
 * [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)
 * [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)
 * [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/README.md

@@ -11,16 +11,26 @@ providing a consistent API regardless of how the configuration was created.
 
 ## Releases
 
-### Stable (2.2)
-OmegaConf 2.2 is the current stable version.
-* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.2.1)
-* [Documentation](https://omegaconf.readthedocs.io/en/2.2_branch/)
-* [Source code](https://github.com/omry/omegaconf/tree/2.2_branch)
+### Stable (2.3)
+OmegaConf 2.3 is the current stable version.
+* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.3.0)
+* [Documentation](https://omegaconf.readthedocs.io/en/2.3_branch/)
+* [Source code](https://github.com/omry/omegaconf/tree/2.3_branch)
 
 Install with `pip install --upgrade omegaconf`
 
+### Previous release (2.2)
+
+* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)
+* [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)
+* [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)
+* [Source code](https://github.com/omry/omegaconf/tree/2.1_branch)
+
+Install with `pip install omegaconf==2.1`
+
+
 ### Previous release (2.1)
-OmegaConf 2.1 is the current stable version.
+
 * [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)
 * [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)
 * [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/_utils.py

@@ -392,7 +392,7 @@ def get_dataclass_data(
         is_optional, type_ = _resolve_optional(resolved_hints[field.name])
         type_ = _resolve_forward(type_, obj.__module__)
         has_default = field.default != dataclasses.MISSING
-        has_default_factory = field.default_factory != dataclasses.MISSING  # type: ignore
+        has_default_factory = field.default_factory != dataclasses.MISSING
 
         if not is_type:
             value = getattr(obj, name)

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/dictconfig.py

@@ -459,7 +459,7 @@ class DictConfig(BaseContainer, MutableMapping[Any, Any]):
         validate_key: bool = True,
         throw_on_missing_value: bool = False,
         throw_on_missing_key: bool = False,
-    ) -> Union[Optional[Node], List[Optional[Node]]]:
+    ) -> Optional[Node]:
         try:
             key = self._validate_and_normalize_key(key)
         except KeyValidationError:

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/grammar/gen/OmegaConfGrammarLexer.py

@@ -1,4 +1,4 @@
-# Generated from /home/rig1/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarLexer.g4 by ANTLR 4.9.3
+# Generated from /home/omry/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarLexer.g4 by ANTLR 4.9.3
 from antlr4 import *
 from io import StringIO
 import sys

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/grammar/gen/OmegaConfGrammarParser.py

@@ -1,4 +1,4 @@
-# Generated from /home/rig1/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarParser.g4 by ANTLR 4.9.3
+# Generated from /home/omry/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarParser.g4 by ANTLR 4.9.3
 # encoding: utf-8
 from antlr4 import *
 from io import StringIO

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/grammar/gen/OmegaConfGrammarParserListener.py

@@ -1,4 +1,4 @@
-# Generated from /home/rig1/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarParser.g4 by ANTLR 4.9.3
+# Generated from /home/omry/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarParser.g4 by ANTLR 4.9.3
 from antlr4 import *
 if __name__ is not None and "." in __name__:
     from .OmegaConfGrammarParser import OmegaConfGrammarParser

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/grammar/gen/OmegaConfGrammarParserVisitor.py

@@ -1,4 +1,4 @@
-# Generated from /home/rig1/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarParser.g4 by ANTLR 4.9.3
+# Generated from /home/omry/dev/omegaconf/omegaconf/grammar/OmegaConfGrammarParser.g4 by ANTLR 4.9.3
 from antlr4 import *
 if __name__ is not None and "." in __name__:
     from .OmegaConfGrammarParser import OmegaConfGrammarParser

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/omegaconf.py

@@ -80,18 +80,20 @@ Resolver = Callable[..., Any]
 
 def II(interpolation: str) -> Any:
     """
-    Equivalent to ${interpolation}
+    Equivalent to ``${interpolation}``
+
     :param interpolation:
-    :return: input ${node} with type Any
+    :return: input ``${node}`` with type Any
     """
     return "${" + interpolation + "}"
 
 
 def SI(interpolation: str) -> Any:
     """
-    Use this for String interpolation, for example "http://${host}:${port}"
+    Use this for String interpolation, for example ``"http://${host}:${port}"``
+
     :param interpolation: interpolation string
-    :return: input interpolation with type Any
+    :return: input interpolation with type ``Any``
     """
     return interpolation
 
@@ -209,6 +211,7 @@ class OmegaConf:
     ) -> None:
         """
         Save as configuration object to a file
+
         :param config: omegaconf.Config object (DictConfig or ListConfig).
         :param f: filename or file object
         :param resolve: True to save a resolved config (defaults to False)
@@ -236,8 +239,9 @@ class OmegaConf:
     def from_dotlist(dotlist: List[str]) -> DictConfig:
         """
         Creates config from the content sys.argv or from the specified args list of not None
-        :param dotlist:
-        :return:
+
+        :param dotlist: A list of dotlist-style strings, e.g. ``["foo.bar=1", "baz=qux"]``.
+        :return: A ``DictConfig`` object created from the dotlist.
         """
         conf = OmegaConf.create()
         conf.merge_with_dotlist(dotlist)
@@ -256,6 +260,7 @@ class OmegaConf:
     ) -> Union[ListConfig, DictConfig]:
         """
         Merge a list of previously created configs into a single one
+
         :param configs: Input configs
         :return: the merged config object.
         """
@@ -288,6 +293,7 @@ class OmegaConf:
         Merge a list of previously created configs into a single one
         This is much faster than OmegaConf.merge() as the input configs are not copied.
         However, the input configs must not be used after this operation as will become inconsistent.
+
         :param configs: Input configs
         :return: the merged config object.
         """
@@ -377,16 +383,16 @@ class OmegaConf:
         :param name: Name of the resolver.
         :param resolver: Callable whose arguments are provided in the interpolation,
             e.g., with ${foo:x,0,${y.z}} these arguments are respectively "x" (str),
-            0 (int) and the value of `y.z`.
-        :param replace: If set to `False` (default), then a `ValueError` is raised if
+            0 (int) and the value of ``y.z``.
+        :param replace: If set to ``False`` (default), then a ``ValueError`` is raised if
             an existing resolver has already been registered with the same name.
-            If set to `True`, then the new resolver replaces the previous one.
+            If set to ``True``, then the new resolver replaces the previous one.
             NOTE: The cache on existing config objects is not affected, use
-            `OmegaConf.clear_cache(cfg)` to clear it.
+            ``OmegaConf.clear_cache(cfg)`` to clear it.
         :param use_cache: Whether the resolver's outputs should be cached. The cache is
             based only on the string literals representing the resolver arguments, e.g.,
             ${foo:${bar}} will always return the same value regardless of the value of
-            `bar` if the cache is enabled for `foo`.
+            ``bar`` if the cache is enabled for ``foo``.
         """
         if not callable(resolver):
             raise TypeError("resolver must be callable")
@@ -452,6 +458,9 @@ class OmegaConf:
     # noinspection PyProtectedMember
     @staticmethod
     def clear_resolvers() -> None:
+        """
+        Clear(remove) all OmegaConf resolvers, then re-register OmegaConf's default resolvers.
+        """
         BaseContainer._resolvers = {}
         register_default_resolvers()
 
@@ -515,9 +524,10 @@ class OmegaConf:
     def masked_copy(conf: DictConfig, keys: Union[str, List[str]]) -> DictConfig:
         """
         Create a masked copy of of this config that contains a subset of the keys
+
         :param conf: DictConfig object
         :param keys: keys to preserve in the copy
-        :return:
+        :return: The masked ``DictConfig`` object.
         """
         from .dictconfig import DictConfig
 
@@ -540,17 +550,19 @@ class OmegaConf:
     ) -> Union[Dict[DictKeyType, Any], List[Any], None, str, Any]:
         """
         Resursively converts an OmegaConf config to a primitive container (dict or list).
+
         :param cfg: the config to convert
         :param resolve: True to resolve all values
         :param throw_on_missing: When True, raise MissingMandatoryValue if any missing values are present.
             When False (the default), replace missing values with the string "???" in the output container.
         :param enum_to_str: True to convert Enum keys and values to strings
         :param structured_config_mode: Specify how Structured Configs (DictConfigs backed by a dataclass) are handled.
-            By default (`structured_config_mode=SCMode.DICT`) structured configs are converted to plain dicts.
-            If `structured_config_mode=SCMode.DICT_CONFIG`, structured config nodes will remain as DictConfig.
-            If `structured_config_mode=SCMode.INSTANTIATE`, this function will instantiate structured configs
-               (DictConfigs backed by a dataclass), by creating an instance of the underlying dataclass.
-               See also OmegaConf.to_object.
+            - By default (``structured_config_mode=SCMode.DICT``) structured configs are converted to plain dicts.
+            - If ``structured_config_mode=SCMode.DICT_CONFIG``, structured config nodes will remain as DictConfig.
+            - If ``structured_config_mode=SCMode.INSTANTIATE``, this function will instantiate structured configs
+              (DictConfigs backed by a dataclass), by creating an instance of the underlying dataclass.
+
+          See also OmegaConf.to_object.
         :return: A dict or a list representing this config as a primitive container.
         """
         if not OmegaConf.is_config(cfg):
@@ -737,9 +749,10 @@ class OmegaConf:
     def to_yaml(cfg: Any, *, resolve: bool = False, sort_keys: bool = False) -> str:
         """
         returns a yaml dump of this config object.
+
         :param cfg: Config object, Structured Config type or instance
         :param resolve: if True, will return a string with the interpolations resolved, otherwise
-        interpolations are preserved
+            interpolations are preserved
         :param sort_keys: If True, will print dict keys in sorted order. default False.
         :return: A string containing the yaml representation.
         """
@@ -757,6 +770,7 @@ class OmegaConf:
     def resolve(cfg: Container) -> None:
         """
         Resolves all interpolations in the given config object in-place.
+
         :param cfg: An OmegaConf container (DictConfig, ListConfig)
                     Raises a ValueError if the input object is not an OmegaConf container.
         """
@@ -774,8 +788,9 @@ class OmegaConf:
     def missing_keys(cfg: Any) -> Set[str]:
         """
         Returns a set of missing keys in a dotlist style.
-        :param cfg: An `OmegaConf.Container`,
-                    or a convertible object via `OmegaConf.create` (dict, list, ...).
+
+        :param cfg: An ``OmegaConf.Container``,
+                    or a convertible object via ``OmegaConf.create`` (dict, list, ...).
         :return: set of strings of the missing keys.
         :raises ValueError: On input not representing a config.
         """

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf/version.py

@@ -1,6 +1,6 @@
 import sys  # pragma: no cover
 
-__version__ = "2.3.0.dev1"
+__version__ = "2.3.1"
 
 msg = """OmegaConf 2.0 and above is compatible with Python 3.6 and newer.
 You have the following options:

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1/omegaconf.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: omegaconf
-Version: 2.3.0.dev1
+Version: 2.3.1
 Summary: A flexible configuration library
 Home-page: https://github.com/omry/omegaconf
 Author: Omry Yadan
@@ -11,11 +11,26 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: antlr4-python3-runtime==4.9.*
+Requires-Dist: PyYAML>=5.1.0
+Requires-Dist: dataclasses; python_version == "3.6"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # OmegaConf
 |  | Description |
@@ -30,16 +45,26 @@ providing a consistent API regardless of how the configuration was created.
 
 ## Releases
 
-### Stable (2.2)
-OmegaConf 2.2 is the current stable version.
-* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.2.1)
-* [Documentation](https://omegaconf.readthedocs.io/en/2.2_branch/)
-* [Source code](https://github.com/omry/omegaconf/tree/2.2_branch)
+### Stable (2.3)
+OmegaConf 2.3 is the current stable version.
+* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.3.0)
+* [Documentation](https://omegaconf.readthedocs.io/en/2.3_branch/)
+* [Source code](https://github.com/omry/omegaconf/tree/2.3_branch)
 
 Install with `pip install --upgrade omegaconf`
 
+### Previous release (2.2)
+
+* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)
+* [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)
+* [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)
+* [Source code](https://github.com/omry/omegaconf/tree/2.1_branch)
+
+Install with `pip install omegaconf==2.1`
+
+
 ### Previous release (2.1)
-OmegaConf 2.1 is the current stable version.
+
 * [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)
 * [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)
 * [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/omegaconf.egg-info/SOURCES.txt

@@ -44,7 +44,6 @@ pydevd_plugins/extensions/pydevd_plugin_omegaconf.py
 requirements/base.txt
 tests/__init__.py
 tests/conftest.py
-tests/test_base.py
 tests/test_base_config.py
 tests/test_basic_ops_dict.py
 tests/test_basic_ops_list.py
@@ -92,4 +91,5 @@ tests/structured_conf/test_structured_basic.py
 tests/structured_conf/test_structured_config.py
 tests/structured_conf/data/__init__.py
 tests/structured_conf/data/attr_classes.py
-tests/structured_conf/data/dataclasses.py
+tests/structured_conf/data/dataclasses.py
+tests/structured_conf/data/dataclasses_pre_311.py

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/pyproject.toml

@@ -14,6 +14,7 @@ exclude = '''
 
 [tool.pytest.ini_options]
 addopts = "--import-mode=append -Werror"
+pythonpath = ["."]
 
 [tool.towncrier]
     package = "omegaconf"

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/setup.cfg

@@ -2,7 +2,7 @@
 test = pytest
 
 [mypy]
-python_version = 3.6
+python_version = 3.7
 mypy_path = .stubs
 exclude = build/
 

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/setup.py

@@ -10,7 +10,6 @@ OmegaConf setup
 """
 import pathlib
 
-import pkg_resources
 import setuptools
 
 from build_helpers.build_helpers import (
@@ -24,8 +23,9 @@ from build_helpers.build_helpers import (
 
 with pathlib.Path("requirements/base.txt").open() as requirements_txt:
     install_requires = [
-        str(requirement)
-        for requirement in pkg_resources.parse_requirements(requirements_txt)
+        line.split("#")[0].strip()
+        for line in requirements_txt
+        if line.split("#")[0].strip()
     ]
 
 
@@ -64,6 +64,7 @@ with open("README.md", "r") as fh:
             "Programming Language :: Python :: 3.8",
             "Programming Language :: Python :: 3.9",
             "Programming Language :: Python :: 3.10",
+            "Programming Language :: Python :: 3.11",
             "License :: OSI Approved :: BSD License",
             "Operating System :: OS Independent",
         ],

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/tests/__init__.py

@@ -108,7 +108,7 @@ class ConcretePlugin(Plugin):
     class FoobarParams:
         foo: int = 10
 
-    params: FoobarParams = FoobarParams()
+    params: FoobarParams = field(default_factory=FoobarParams)
 
 
 @dataclass
@@ -117,7 +117,7 @@ class NestedInterpolationToMissing:
     class BazParams:
         baz: str = "${..name}"
 
-    subcfg: BazParams = BazParams()
+    subcfg: BazParams = field(default_factory=BazParams)
     name: str = MISSING
 
 

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/tests/examples/dataclass_postponed_annotations.py

@@ -1,6 +1,6 @@
 # `from __future__` has to be the very first thing in a module
 # otherwise a syntax error is raised
-from __future__ import annotations  # type: ignore # noqa  # Python 3.6 linters complain
+from __future__ import annotations  # noqa  # Python 3.6 linters complain
 
 from dataclasses import dataclass, fields
 from enum import Enum

{omegaconf-2.3.0.dev1 → omegaconf-2.3.1}/tests/examples/test_dataclass_example.py

@@ -161,7 +161,9 @@ class Group:
     admin: User = User  # type: ignore
 
     # You can also specify different defaults for nested classes
-    manager: User = User(name="manager", height=Height.TALL)
+    manager: User = field(
+        default_factory=lambda: User(name="manager", height=Height.TALL)
+    )
 
 
 def test_nesting() -> None:
@@ -343,7 +345,7 @@ def test_merge() -> None:
     @dataclass
     class Config:
         num: int = 10
-        user: User = User(name=MISSING, height=MISSING)
+        user: User = field(default_factory=lambda: User(name=MISSING, height=MISSING))
         domains: Dict[str, Domain] = field(default_factory=dict)
 
     yaml = """
@@ -385,8 +387,8 @@ def test_merge_example() -> None:
 
     @dataclass
     class MyConfig:
-        server: Server = Server()
-        log: Log = Log()
+        server: Server = field(default_factory=Server)
+        log: Log = field(default_factory=Log)
         users: List[str] = field(default_factory=list)
         numbers: List[int] = field(default_factory=list)