Merge branch 'release/2.7.3'

Author: glentner

docs/blog/20231012_2_7_3_release.rst

@@ -0,0 +1,35 @@
+.. _20231012_2_7_3_release:
+
+Release Notes (v2.7.3)
+======================
+
+`October 12, 2023`
+
+The v2.7.3 release fixes a bug in how ``_env`` and ``_eval`` get expanded
+(`Issue 21 <https://github.com/glentner/CmdKit/issues/21>`_)
+
+-----
+
+
+The expected behavior is something like the following:
+
+.. code-block:: python
+
+    cfg = Configuration(default={'database': {'user': 'bob', 'password_eval': 'echo secret'}})
+    assert cfg.database.password == 'secret'
+
+The expansion does happen for top-level parameters, but not ones nested within sections (or sub-sections).
+You instead get an ``AttributeError`` as you might expect from a normal dictionary.
+
+With the 2.7.x release of cmdkit the ``Namespace`` (and underlying ``NSCoreMixin`` along with ``Environ``) were
+migrated to their own separate ``namespace`` module to allow for it to be used in the new ``platform`` module
+without created a circular dependency with the original ``config`` module.
+
+The implementation of this expansion functionality was pulled out of ``NSCoreMixin`` and implemented
+instead directly in the ``Configuration`` class. This might make sense conceptional, as it's the
+configuration that needs this behavior. However, implementing it there destroys the recursive
+nature of the structure. As soon as you access a section of the ``Configuration`` instead you get
+a ``Namespace`` view, not another ``Configuration``.
+
+The expansion behavior was reverted back to its original home under ``NSCoreMixin``.
+All ``Namespace`` instances allow this sort of expansion, as in prior releases.

docs/blog/index.rst

@@ -7,6 +7,16 @@ A place for announcements, release notes, thoughts and ideas for the project.
 
 -----
 
+:ref:`Release Notes (v2.7.3) <20231012_2_7_3_release>`
+------------------------------------------------------
+
+`October 12, 2023`
+
+The v2.7.3 release fixes a bug in how ``_env`` and ``_eval`` get expanded
+(`Issue 21 <https://github.com/glentner/CmdKit/issues/21>`_)
+
+-----
+
 :ref:`Release Notes (v2.7.1) <20230927_2_7_1_release>`
 ------------------------------------------------------
 
@@ -26,5 +36,6 @@ The v2.7.1 release includes major new features along with numerous fixes and imp
     :hidden:
     :maxdepth: 1
 
+    20231012_2_7_3_release
     20230927_2_7_1_release
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cmdkit"
-version = "2.7.2"
+version = "2.7.3"
 description = "A command-line utility toolkit for Python."
 readme = "README.rst"
 license = "Apache-2.0"

src/cmdkit/__init__.py

@@ -6,6 +6,7 @@
 
 # standard libs
 from logging import NullHandler
+from importlib.metadata import version as get_version
 
 # internal libs
 from cmdkit.cli import Interface, ArgumentError
@@ -26,7 +27,7 @@
 ]
 
 # package metadata
-__version__   = '2.7.2'
+__version__ = get_version('cmdkit')
 
 # null-handler for library interface
 Logger.with_name(__name__).addHandler(NullHandler())

src/cmdkit/config.py

@@ -13,9 +13,6 @@
 from typing import Tuple, List, Dict, TypeVar, Callable, Union, Any
 
 # standard libs
-import os
-import functools
-import subprocess
 from collections import Counter
 
 # internal libs
@@ -239,43 +236,6 @@ def __setattr__(self, name: str, value: Any) -> None:
         else:
             super().__setattr__(name, value)
 
-    def __getattr__(self, item: str) -> Any:
-        """
-        Alias for index notation.
-        Transparently expand `_env` and `_eval` variants.
-        """
-        variants = [f'{item}_env', f'{item}_eval']
-        if item in self:
-            return self[item]
-        for variant in variants:
-            if variant in self:
-                return self.__expand_attr(item)
-        else:
-            raise AttributeError(f'missing \'{item}\'')
-
-    def __expand_attr(self, item: str) -> str:
-        """Interpolate values if `_env` or `_eval` present."""
-
-        getters = {f'{item}': (lambda: self[item]),
-                   f'{item}_env': functools.partial(self.__expand_attr_env, item),
-                   f'{item}_eval': functools.partial(self.__expand_attr_eval, item)}
-
-        items = [key for key in self if key in getters]
-        if len(items) == 0:
-            raise ConfigurationError(f'\'{item}\' not found')
-        elif len(items) == 1:
-            return getters[items[0]]()
-        else:
-            raise ConfigurationError(f'\'{item}\' has more than one variant')
-
-    def __expand_attr_env(self, item: str) -> str:
-        """Expand `item` as an environment variable."""
-        return os.getenv(str(self[f'{item}_env']), None)
-
-    def __expand_attr_eval(self, item: str) -> str:
-        """Expand `item` as a shell expression."""
-        return subprocess.check_output(str(self[f'{item}_eval']), shell=True).decode().strip()
-
     def update(self, *args, **kwargs) -> None:
         """
         Update current namespace directly.

src/cmdkit/namespace.py

@@ -1,16 +1,17 @@
 # SPDX-FileCopyrightText: 2022 CmdKit Developers
 # SPDX-License-Identifier: Apache-2.0
 
-"""
-Namespace implementation.
-"""
+"""Namespace implementation."""
+
 
 # type annotations
 from __future__ import annotations
 from typing import Union, Mapping, Iterable, Any, Dict, Optional, IO, List, Tuple, Callable, TypeVar, NamedTuple
 
 # standard libs
 import os
+import functools
+import subprocess
 from collections import Counter
 from functools import reduce
 
@@ -76,11 +77,29 @@ def update(self, *args, **kwargs) -> None:
         self.__depth_first_update(self, dict(*args, **kwargs))
 
     def __getattr__(self, item: str) -> Any:
-        """Alias for index notation."""
-        if item in self:
-            return self[item]
+        """
+        Alias for index notation.
+        Transparently expand `_env` and `_eval` variants.
+        """
+        getters = {f'{item}': (lambda: self[item]),
+                   f'{item}_env': functools.partial(self.__expand_attr_env, item),
+                   f'{item}_eval': functools.partial(self.__expand_attr_eval, item)}
+
+        items = [key for key in getters if key in self]
+        if len(items) == 0:
+            raise AttributeError(f'\'{item}\' not found')
+        elif len(items) == 1:
+            return getters[items[0]]()
         else:
-            raise AttributeError(f'missing \'{item}\'')
+            raise AttributeError(f'\'{item}\' has more than one variant')
+
+    def __expand_attr_env(self, item: str) -> str:
+        """Expand `item` as an environment variable."""
+        return os.getenv(str(self[f'{item}_env']), None)
+
+    def __expand_attr_eval(self, item: str) -> str:
+        """Expand `item` as a shell expression."""
+        return subprocess.check_output(str(self[f'{item}_eval']), shell=True).decode().strip()
 
     def __repr__(self) -> str:
         """Convert to string representation."""

tests/test_config.py

@@ -264,6 +264,37 @@ def test_attribute(self) -> None:
         assert 'foo' == ns['b'] == ns.b
         assert 3.14 == ns['c']['x'] == ns.c.x
 
+    def test_attribute_missing(self) -> None:
+        """Test raises AttributeError if item is missing."""
+        ns = Namespace({'a': 1, 'b': 'foo', 'c': {'x': 3.14}})
+        with pytest.raises(AttributeError) as exc_info:
+            assert ns.d == 42
+        exc_info.match('\'d\' not found')
+
+    def test_attribute_expand_env(self) -> None:
+        """Test transparent environment variable expansion."""
+        os.environ['CMDKIT_TEST_A'] = 'foo-bar'
+        ns = Namespace({'test_env': 'CMDKIT_TEST_A'})
+        assert ns.get('test') is None
+        assert ns.get('test_env') == 'CMDKIT_TEST_A'
+        assert ns.test_env == 'CMDKIT_TEST_A'
+        assert ns.test == 'foo-bar'
+
+    def test_attribute_expand_eval(self) -> None:
+        """Test transparent shell expression expansion."""
+        ns = Namespace({'test_eval': 'echo foo-bar'})
+        assert ns.get('test') is None
+        assert ns.get('test_eval') == 'echo foo-bar'
+        assert ns.test_eval == 'echo foo-bar'
+        assert ns.test == 'foo-bar'
+
+    def test_attribute_expand_multiple_variants(self) -> None:
+        """Test failure to expand because item has multiple variants."""
+        ns = Namespace({'a': 1, 'test': 'foo', 'test_eval': 'echo bar'})
+        with pytest.raises(AttributeError) as exc_info:
+            assert ns.test == 'foo'
+        assert exc_info.match('\'test\' has more than one variant')
+
     def test_duplicates(self) -> None:
         """Namespace can find duplicate leaves in the tree."""
         ns = Namespace({'a': {'x': 1, 'y': 2}, 'b': {'x': 3, 'z': 4}})
@@ -463,20 +494,41 @@ def test_blending(self) -> None:
         assert cfg['a']['z'] == 4
         assert cfg['b']['z'] == 3
 
+    def test_attribute_missing(self) -> None:
+        """Test raises AttributeError if item is missing"""
+        cfg = Configuration(a=Namespace({'a': 1, 'b': 'foo', 'c': {'x': 3.14}}))
+        with pytest.raises(AttributeError) as exc_info:
+            assert cfg.d == 42
+        exc_info.match('\'d\' not found')
+
     def test_attribute_expand_env(self) -> None:
         """Test transparent environment variable expansion."""
         os.environ['CMDKIT_TEST_A'] = 'foo-bar'
-        ns = Configuration(a=Namespace({'test_env': 'CMDKIT_TEST_A'}))
-        assert ns.get('test') is None
-        assert ns.get('test_env') == 'CMDKIT_TEST_A'
-        assert ns.test == 'foo-bar'
+        cfg = Configuration(a=Namespace({'nested': {'test_env': 'CMDKIT_TEST_A'}}))
+        assert cfg.nested.get('test') is None
+        assert cfg.nested.get('test_env') == 'CMDKIT_TEST_A'
+        assert cfg.nested.test_env == 'CMDKIT_TEST_A'
+        assert cfg.nested.test == 'foo-bar'
 
     def test_attribute_expand_eval(self) -> None:
         """Test transparent shell expression expansion."""
-        ns = Configuration(a=Namespace({'test_eval': 'echo foo-bar'}))
-        assert ns.get('test') is None
-        assert ns.get('test_eval') == 'echo foo-bar'
-        assert ns.test == 'foo-bar'
+        cfg = Configuration(a=Namespace({'nested': {'test_eval': 'echo foo-bar'}}))
+        assert cfg.nested.get('test') is None
+        assert cfg.nested.get('test_eval') == 'echo foo-bar'
+        assert cfg.nested.test_eval == 'echo foo-bar'
+        assert cfg.nested.test == 'foo-bar'
+
+    def test_attribute_expand_multiple_variants(self) -> None:
+        """Test failure to expand because multiple variants found."""
+        cfg = Configuration(a=Namespace({'nested': {'test': 'foo', 'a': 1}}),
+                            b=Namespace({'nested': {'test_eval': 'echo bar', 'b': 2}}),
+                            c=Namespace({'other': {'secret_eval': 'echo baz'}}))
+        with pytest.raises(AttributeError) as exc_info:
+            assert cfg.nested.a == 1
+            assert cfg.nested.b == 2
+            assert cfg.other.secret == 'baz'
+            assert cfg.nested.test == 'foo'
+        assert exc_info.match('\'test\' has more than one variant')
 
     def test_from_local(self) -> None:
         """Test Configuration.from_local factory method."""