Merged main

Author: tr11

.github/workflows/run_tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8, 3.9, "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Install dependencies
+        run: poetry install -v -E toml -E yaml -E azure -E aws -E gcp
+
+      - name: Run pytest
+        run: poetry run pytest --cov=./ --cov-report=xml
+
+      - name: Coverage report
+        uses: codecov/codecov-action@v1

.travis.yml

@@ -6,26 +6,42 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- Allow to pass a `ignore_missing_paths` parameter to each config method
+
+## [0.9.0] - 2023-08-04
+
+### Added
+
 - Added the `section_prefix` parameter that filters sections by prefix in INI/toml files
 - Allow the `ignore_missing_paths` parameter to be specified individually on Configuration Sets
 
+### Fixed
+
+- Errors when passing objects implementing `Mapping` instead of `dict`
+- Comparison to objects that are not a `Mapping`  
+
+### Changed
+
+- Replaced TravisCI with GitHub Actions
+
+
 ## [0.8.3] - 2021-10-11
 
 ### Fixed
 
-- configurations from ini file won't be converted to lower case if `lowercase_keys = False`
+- Configurations from ini file won't be converted to lower case if `lowercase_keys = False`
 
 ## [0.8.2] - 2021-01-30
 
 ### Fixed
 
-- the behavior of merging sets was incorrect since version 0.8.0
+- The behavior of merging sets was incorrect since version 0.8.0
 
 ## [0.8.0] - 2020-08-01
 
 ### Changed
 
-- the behavior of the dict-like methods `keys`, `items`, and `values` now give only the first level configuration keys instead of the old behavior of returning all the nested keys. To achieve the same behavior as before, use the `dotter_iter` context manager:
+- The behavior of the dict-like methods `keys`, `items`, and `values` now give only the first level configuration keys instead of the old behavior of returning all the nested keys. To achieve the same behavior as before, use the `dotter_iter` context manager:
 
 ```python
 cfg.keys()  # returns only the top level keys
@@ -36,7 +52,7 @@ with cfg.dotted_iter():
 
 ### Fixed
 
-- configuration objects are now immutable
+- Configuration objects are now immutable
 
 ### Added
 
@@ -48,7 +64,7 @@ with cfg.dotted_iter():
 
 ### Fixed
 
-- installation with `poetry` because of changes to pytest-black
+- Installation with `poetry` because of changes to pytest-black
 
 ## [0.7.0] - 2020-05-06
 
@@ -116,8 +132,9 @@ with cfg.dotted_iter():
 
 - Initial version
 
-[unreleased]: https://github.com/tr11/python-configuration/compare/0.8.3...HEAD
-[0.8.2]: https://github.com/tr11/python-configuration/compare/0.8.2...0.8.3
+[unreleased]: https://github.com/tr11/python-configuration/compare/0.9.0...HEAD
+[0.9.0]: https://github.com/tr11/python-configuration/compare/0.8.3...0.9.0
+[0.8.3]: https://github.com/tr11/python-configuration/compare/0.8.2...0.8.3
 [0.8.2]: https://github.com/tr11/python-configuration/compare/0.8.0...0.8.2
 [0.8.0]: https://github.com/tr11/python-configuration/compare/0.7.1...0.8.0
 [0.7.1]: https://github.com/tr11/python-configuration/compare/0.7.0...0.7.1

CHANGELOG.md

@@ -5,8 +5,8 @@
 ![python](https://img.shields.io/pypi/pyversions/python-configuration)
 ![wheel](https://img.shields.io/pypi/wheel/python-configuration)
 ![license](https://img.shields.io/pypi/l/python-configuration)
-[![build](https://img.shields.io/travis/tr11/python-configuration)](https://travis-ci.org/tr11/python-configuration)
-[![codecov](https://codecov.io/gh/tr11/python-configuration/branch/master/graph/badge.svg)](https://codecov.io/gh/tr11/python-configuration)
+[![tests](https://github.com/tr11/python-configuration/actions/workflows/run_tests.yml/badge.svg)](https://github.com/tr11/python-configuration/actions/workflows/run_tests.yml)
+[![codecov](https://codecov.io/gh/tr11/python-configuration/branch/main/graph/badge.svg?token=5zRYlGnDs7)](https://codecov.io/gh/tr11/python-configuration)
 [![Documentation Status](https://readthedocs.org/projects/python-configuration/badge/?version=latest)](https://python-configuration.readthedocs.io/en/latest/?badge=latest)
 
 This library is intended as a helper mechanism to load configuration files hierarchically.  Supported format types are:

README.md

@@ -4,7 +4,7 @@
 import os
 from importlib.abc import InspectLoader
 from types import ModuleType
-from typing import Any, Dict, Iterable, List, Optional, TextIO, Union, cast
+from typing import Any, Dict, Iterable, List, Mapping, Optional, TextIO, Union, cast
 
 try:
     import yaml
@@ -60,7 +60,7 @@ def config(
     }
 
     for config_ in configs:
-        if isinstance(config_, dict):
+        if isinstance(config_, Mapping):
             instances.append(config_from_dict(config_, **default_kwargs))
             continue
         elif isinstance(config_, str):
@@ -521,7 +521,34 @@ def config_from_ini(
 class DotEnvConfiguration(FileConfiguration):
     """Configuration from a .env type file input."""
 
-    def _reload(self, data: Union[str, TextIO], read_from_file: bool = False) -> None:
+    def __init__(
+        self,
+        data: Union[str, TextIO],
+        read_from_file: bool = False,
+        prefix: str = "",
+        separator: str = "__",
+        *,
+        lowercase_keys: bool = False,
+        interpolate: InterpolateType = False,
+        interpolate_type: InterpolateEnumType = InterpolateEnumType.STANDARD,
+        ignore_missing_paths: bool = False,
+    ):
+        self._prefix = prefix
+        self._separator = separator
+        super().__init__(
+            data=data,
+            read_from_file=read_from_file,
+            lowercase_keys=lowercase_keys,
+            interpolate=interpolate,
+            interpolate_type=interpolate_type,
+            ignore_missing_paths=ignore_missing_paths,
+        )
+
+    def _reload(
+        self,
+        data: Union[str, TextIO],
+        read_from_file: bool = False,
+    ) -> None:
         """Reload the .env data."""
         if read_from_file:
             if isinstance(data, str):
@@ -534,12 +561,23 @@ def _reload(self, data: Union[str, TextIO], read_from_file: bool = False) -> Non
             for x in data.splitlines()
             if x
         )
+
+        result = {
+            k[len(self._prefix) :].replace(self._separator, ".").strip("."): v
+            for k, v in result.items()
+            if k.startswith(self._prefix)
+        }
+
+        print(self._prefix, self._separator, result)
+
         self._config = self._flatten_dict(result)
 
 
 def config_from_dotenv(
     data: Union[str, TextIO],
     read_from_file: bool = False,
+    prefix: str = "",
+    separator: str = "__",
     *,
     lowercase_keys: bool = False,
     interpolate: InterpolateType = False,
@@ -560,6 +598,8 @@ def config_from_dotenv(
     return DotEnvConfiguration(
         data,
         read_from_file,
+        prefix=prefix,
+        separator=separator,
         lowercase_keys=lowercase_keys,
         interpolate=interpolate,
         interpolate_type=interpolate_type,
@@ -678,7 +718,7 @@ def config_from_python(
 
 
 def config_from_dict(
-    data: dict,
+    data: Mapping,
     *,
     lowercase_keys: bool = False,
     interpolate: InterpolateType = False,
@@ -736,7 +776,7 @@ def _reload(
                 loaded = yaml.load(open(data, "rt"), Loader=yaml.FullLoader)
             else:
                 loaded = yaml.load(data, Loader=yaml.FullLoader)
-            if not isinstance(loaded, dict):
+            if not isinstance(loaded, Mapping):
                 raise ValueError("Data should be a dictionary")
             self._config = self._flatten_dict(loaded)
 

config/__init__.py

@@ -69,6 +69,8 @@ def __init__(
 
     def __eq__(self, other):  # type: ignore
         """Equality operator."""
+        if not isinstance(other, (Configuration, Mapping)):
+            return False
         return self.as_dict() == Configuration(other).as_dict()
 
     def _filter_dict(self, d: Dict[str, Any], prefix: str) -> Dict[str, Any]:
@@ -99,7 +101,7 @@ def _flatten_dict(self, d: Mapping[str, Any]) -> Dict[str, Any]:
         :param d: dict
         :return: a flattened dict
         """
-        nested = {k for k, v in d.items() if isinstance(v, (dict, Configuration))}
+        nested = {k for k, v in d.items() if isinstance(v, (Mapping, Configuration))}
         if self._lowercase:
             result = {
                 k.lower() + "." + ki: vi
@@ -109,7 +111,7 @@ def _flatten_dict(self, d: Mapping[str, Any]) -> Dict[str, Any]:
             result.update(
                 (k.lower(), v)
                 for k, v in d.items()
-                if not isinstance(v, (dict, Configuration))
+                if not isinstance(v, (Mapping, Configuration))
             )
         else:
             result = {
@@ -118,7 +120,9 @@ def _flatten_dict(self, d: Mapping[str, Any]) -> Dict[str, Any]:
                 for ki, vi in self._flatten_dict(d[k]).items()
             }
             result.update(
-                (k, v) for k, v in d.items() if not isinstance(v, (dict, Configuration))
+                (k, v)
+                for k, v in d.items()
+                if not isinstance(v, (Mapping, Configuration))
             )
         return result
 
@@ -153,11 +157,11 @@ def __getitem__(self, item: str) -> Union["Configuration", Any]:  # noqa: D105
 
         if v == {}:
             raise KeyError(item)
-        if isinstance(v, dict):
+        if isinstance(v, Mapping):
             return Configuration(v)
         elif self._interpolate is not False:
             d = self.as_dict()
-            d.update(cast(Dict[str, str], self._interpolate))
+            d.update(self._interpolate)
             return interpolate_object(item, v, [d], self._interpolate_type)
         else:
             return v
@@ -186,7 +190,7 @@ def as_attrdict(self) -> AttributeDict:
         """Return the representation as an attribute dictionary."""
         return AttributeDict(
             {
-                x: Configuration(v).as_attrdict() if isinstance(v, dict) else v
+                x: Configuration(v).as_attrdict() if isinstance(v, Mapping) else v
                 for x, v in self.items(levels=1)
             }
         )
@@ -307,9 +311,7 @@ def __iter__(self) -> Iterator[Tuple[str, Any]]:  # noqa: D105
 
     def __reversed__(self) -> Iterator[Tuple[str, Any]]:  # noqa: D105
         if version_info < (3, 8):
-            return OrderedDict(  # type: ignore
-                reversed(list(self.items()))
-            )  # pragma: no cover
+            return OrderedDict(reversed(list(self.items())))  # type: ignore  # pragma: no cover
         else:
             return reversed(dict(self.items()))  # type: ignore
 
@@ -404,7 +406,7 @@ def dotted_iter(self) -> Iterator["Configuration"]:
             self._default_levels = 1
 
     def __repr__(self) -> str:  # noqa: D105
-        return "<Configuration: %s>" % hex(id(self))
+        return "<%s: %s>" % (type(self).__name__, hex(id(self)))
 
     def __str__(self) -> str:  # noqa: D105
         return str({k: clean(k, v) for k, v in sorted(self.as_dict().items())})

config/configuration.py

@@ -79,7 +79,7 @@ def _from_configs(self, attr: str, *args: Any, **kwargs: dict) -> Any:
             return Configuration(result)
         elif self._interpolate is not False:
             d = [d.as_dict() for d in self._configs]
-            d[0].update(cast(Dict[str, str], self._interpolate))
+            d[0].update(self._interpolate)
             return interpolate_object(args[0], values[0], d, self._interpolate_type)
         else:
             return values[0]

config/configuration_set.py

@@ -7,13 +7,14 @@
 from azure.identity import ClientSecretCredential
 from azure.keyvault.secrets import SecretClient
 
+
 from .. import Configuration, InterpolateType
 
 
 class Cache:
     """Cache class."""
 
-    def __init__(self, value: str, ts: float):  # noqa: D107
+    def __init__(self, value: Optional[str], ts: float):  # noqa: D107
         self.value = value
         self.ts = ts
 
@@ -123,7 +124,7 @@ def values(
         return cast(
             ValuesView[str],
             (
-                self._get_secret(k.name)
+                self._get_secret(cast(str, k.name))
                 for k in self._kv_client.list_properties_of_secrets()
             ),
         )
@@ -136,7 +137,7 @@ def items(
         return cast(
             ItemsView[str, Any],
             (
-                (k.name, self._get_secret(k.name))
+                (k.name, self._get_secret(cast(str, k.name)))
                 for k in self._kv_client.list_properties_of_secrets()
             ),
         )

config/contrib/azure.py

@@ -73,7 +73,7 @@ def _get_secret(self, key: str) -> Optional[str]:
                 request={"name": path}
             ).payload.data.decode()
             self._cache[key] = Cache(value=secret, ts=now)
-            return cast(str, secret)
+            return secret
         except NotFound:
             if key in self._cache:
                 del self._cache[key]