configaroo 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- configaroo/__init__.py +2 -0
- configaroo/configuration.py +68 -14
- configaroo-0.1.1.dist-info/METADATA +41 -0
- configaroo-0.1.1.dist-info/RECORD +12 -0
- configaroo-0.1.1.dist-info/licenses/LICENSE +20 -0
- configaroo-0.1.0.dist-info/METADATA +0 -21
- configaroo-0.1.0.dist-info/RECORD +0 -11
- {configaroo-0.1.0.dist-info → configaroo-0.1.1.dist-info}/WHEEL +0 -0
- {configaroo-0.1.0.dist-info → configaroo-0.1.1.dist-info}/top_level.txt +0 -0
configaroo/__init__.py
CHANGED
configaroo/configuration.py
CHANGED
@@ -1,6 +1,8 @@
|
|
1
1
|
"""A dict-like configuration with support for envvars, validation and type conversion"""
|
2
2
|
|
3
|
+
import inspect
|
3
4
|
import os
|
5
|
+
import re
|
4
6
|
from collections import UserDict
|
5
7
|
from pathlib import Path
|
6
8
|
from typing import Any, Self, Type
|
@@ -27,7 +29,9 @@ class Configuration(UserDict):
|
|
27
29
|
) -> Self:
|
28
30
|
"""Read a Configuration from a file"""
|
29
31
|
config_dict = loaders.from_file(file_path, loader=loader)
|
30
|
-
return cls(
|
32
|
+
return cls(config_dict).initialize(
|
33
|
+
envs=envs, env_prefix=env_prefix, extra_dynamic=extra_dynamic, model=model
|
34
|
+
)
|
31
35
|
|
32
36
|
def initialize(
|
33
37
|
self,
|
@@ -51,7 +55,7 @@ class Configuration(UserDict):
|
|
51
55
|
"""Make sure nested sections have type Configuration"""
|
52
56
|
value = self.data[key]
|
53
57
|
if isinstance(value, dict | UserDict | Configuration):
|
54
|
-
return Configuration(
|
58
|
+
return Configuration(value)
|
55
59
|
else:
|
56
60
|
return value
|
57
61
|
|
@@ -76,21 +80,21 @@ class Configuration(UserDict):
|
|
76
80
|
|
77
81
|
def get(self, key: str, default: Any = None) -> Any:
|
78
82
|
"""Allow dotted keys when using .get()"""
|
79
|
-
if key
|
80
|
-
prefix, _, rest = key.partition(".")
|
81
|
-
try:
|
82
|
-
return self[prefix].get(rest, default=default)
|
83
|
-
except KeyError:
|
84
|
-
return default
|
85
|
-
else:
|
83
|
+
if key in self.data:
|
86
84
|
return self[key]
|
87
85
|
|
86
|
+
prefix, _, rest = key.partition(".")
|
87
|
+
try:
|
88
|
+
return self[prefix].get(rest, default=default)
|
89
|
+
except KeyError:
|
90
|
+
return default
|
91
|
+
|
88
92
|
def add(self, key: str, value: Any) -> Self:
|
89
93
|
"""Add a value, allow dotted keys"""
|
90
94
|
prefix, _, rest = key.partition(".")
|
91
95
|
if rest:
|
92
96
|
cls = type(self)
|
93
|
-
return self | {prefix: cls(
|
97
|
+
return self | {prefix: cls(self.setdefault(prefix, {})).add(rest, value)}
|
94
98
|
else:
|
95
99
|
return self | {key: value}
|
96
100
|
|
@@ -116,15 +120,15 @@ class Configuration(UserDict):
|
|
116
120
|
cls = type(self)
|
117
121
|
variables = (
|
118
122
|
self.to_flat_dict()
|
119
|
-
| {"project_path":
|
123
|
+
| {"project_path": _find_pyproject_toml()}
|
120
124
|
| ({} if extra is None else extra)
|
121
125
|
)
|
122
126
|
return cls(
|
123
|
-
|
127
|
+
{
|
124
128
|
key: (
|
125
129
|
value.parse_dynamic(extra=variables)
|
126
130
|
if isinstance(value, Configuration)
|
127
|
-
else value
|
131
|
+
else _incomplete_format(value, variables)
|
128
132
|
if isinstance(value, str)
|
129
133
|
else value
|
130
134
|
)
|
@@ -140,7 +144,7 @@ class Configuration(UserDict):
|
|
140
144
|
def convert(self, model: Type[BaseModel]) -> Self:
|
141
145
|
"""Convert data types to match the given model"""
|
142
146
|
cls = type(self)
|
143
|
-
return cls(
|
147
|
+
return cls(model(**self.data).model_dump())
|
144
148
|
|
145
149
|
def to_dict(self) -> dict[str, Any]:
|
146
150
|
"""Dump the configuration into a Python dictionary"""
|
@@ -166,3 +170,53 @@ class Configuration(UserDict):
|
|
166
170
|
self[nested_key].to_flat_dict(_prefix=f"{_prefix}{nested_key}.").items()
|
167
171
|
)
|
168
172
|
}
|
173
|
+
|
174
|
+
|
175
|
+
def _find_pyproject_toml(
|
176
|
+
path: Path | None = None, _file_name: str = "pyproject.toml"
|
177
|
+
) -> Path:
|
178
|
+
"""Find a directory that contains a pyproject.toml file.
|
179
|
+
|
180
|
+
This searches the given directory and all direct parents. If a
|
181
|
+
pyproject.toml file isn't found, then the root of the file system is
|
182
|
+
returned.
|
183
|
+
"""
|
184
|
+
path = _get_foreign_path() if path is None else path
|
185
|
+
if (path / _file_name).exists() or path == path.parent:
|
186
|
+
return path.resolve()
|
187
|
+
else:
|
188
|
+
return _find_pyproject_toml(path.parent, _file_name=_file_name)
|
189
|
+
|
190
|
+
|
191
|
+
def _get_foreign_path() -> Path:
|
192
|
+
"""Find the path to the library that called this package.
|
193
|
+
|
194
|
+
Search the call stack for the first source code file outside of configaroo.
|
195
|
+
"""
|
196
|
+
self_prefix = Path(__file__).parent.parent
|
197
|
+
return next(
|
198
|
+
path
|
199
|
+
for frame in inspect.stack()
|
200
|
+
if not (path := Path(frame.filename)).is_relative_to(self_prefix)
|
201
|
+
)
|
202
|
+
|
203
|
+
|
204
|
+
def _incomplete_format(text: str, replacers: dict[str, Any]) -> str:
|
205
|
+
"""Replace some, but not necessarily all format specifiers in a text string.
|
206
|
+
|
207
|
+
Regular .format() raises an error if not all {replace} parameters are
|
208
|
+
supplied. Here, we only replace the given replace arguments and leave the
|
209
|
+
rest untouched.
|
210
|
+
"""
|
211
|
+
dot = "__DOT__" # Escape . in fields as they have special meaning in .format()
|
212
|
+
pattern = r"({{{word}(?:![ars])?(?:|:[^}}]*)}})" # Match {word} or {word:...}
|
213
|
+
|
214
|
+
for word, replacement in replacers.items():
|
215
|
+
for match in re.findall(pattern.format(word=word), text):
|
216
|
+
# Split expression to only replace . in the field name
|
217
|
+
field, colon, fmt = match.partition(":")
|
218
|
+
replacer = f"{field.replace('.', dot)}{colon}{fmt}".format(
|
219
|
+
**{word.replace(".", dot): replacement}
|
220
|
+
)
|
221
|
+
text = text.replace(match, replacer)
|
222
|
+
return text
|
@@ -0,0 +1,41 @@
|
|
1
|
+
Metadata-Version: 2.4
|
2
|
+
Name: configaroo
|
3
|
+
Version: 0.1.1
|
4
|
+
Summary: Bouncy handling of configuration files
|
5
|
+
Author-email: Geir Arne Hjelle <geirarne@gmail.com>
|
6
|
+
Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
|
7
|
+
License-Expression: MIT
|
8
|
+
Project-URL: homepage, https://github.com/gahjelle/configaroo
|
9
|
+
Project-URL: github, https://github.com/gahjelle/configaroo
|
10
|
+
Project-URL: issues, https://github.com/gahjelle/configaroo/issues
|
11
|
+
Project-URL: changelog, https://github.com/gahjelle/configaroo/blob/main/CHANGELOG.md
|
12
|
+
Keywords: configuration,configuration-management,toml,json
|
13
|
+
Classifier: Development Status :: 5 - Production/Stable
|
14
|
+
Classifier: Intended Audience :: Developers
|
15
|
+
Classifier: Natural Language :: English
|
16
|
+
Classifier: Operating System :: OS Independent
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
20
|
+
Classifier: Programming Language :: Python :: 3.14
|
21
|
+
Classifier: Programming Language :: Python :: 3
|
22
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
23
|
+
Classifier: Typing :: Typed
|
24
|
+
Requires-Python: >=3.11
|
25
|
+
Description-Content-Type: text/markdown
|
26
|
+
License-File: LICENSE
|
27
|
+
Requires-Dist: pydantic>=2.0
|
28
|
+
Requires-Dist: pyplugs>=0.4.0
|
29
|
+
Requires-Dist: python-dotenv>=1.1.0
|
30
|
+
Dynamic: license-file
|
31
|
+
|
32
|
+
# Configaroo - Bouncy Configuration Handling
|
33
|
+
|
34
|
+
Configaroo is a light configuration package for Python that offers the following features:
|
35
|
+
|
36
|
+
- Access configuration settings with dotted keys: `config.nested.key`
|
37
|
+
- Use different configuration file formats, including TOML and JSON
|
38
|
+
- Override key configuration settings with environment variables
|
39
|
+
- Validate a configuration based on a Pydantic model
|
40
|
+
- Convert the type of configuration values based on a Pydantic model
|
41
|
+
- Dynamically format certain configuration values
|
@@ -0,0 +1,12 @@
|
|
1
|
+
configaroo/__init__.py,sha256=md3Wead8MQu-d77K6w6NDHKbxDfYRjQ4dw8Fy5V1VUU,255
|
2
|
+
configaroo/configuration.py,sha256=plfCA8vJCAjMrb-s7m1WdAbpGqNNd1HqsAZOsLha7mE,7750
|
3
|
+
configaroo/exceptions.py,sha256=1h-6hV7VqqKaRFnu539pjsO0ESSNDibt2kUeF7jAM2M,374
|
4
|
+
configaroo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
5
|
+
configaroo/loaders/__init__.py,sha256=-6GAR4g7vYW7Zagq9Ev479kpkfY7kbvDl4JPXd4wQQ0,756
|
6
|
+
configaroo/loaders/json.py,sha256=6gs_ZegUEe70vb6uSJfKBos7UjfuJnyWgPE_kjDQISw,258
|
7
|
+
configaroo/loaders/toml.py,sha256=ZVbHutZ7V-Z_jf2aHjV18jwaqCXumlr06j48rojHcBM,264
|
8
|
+
configaroo-0.1.1.dist-info/licenses/LICENSE,sha256=2cbzsB4lU8qOO8fO1XVNJD7XPxzPhaWXm6U9DenSc0s,1089
|
9
|
+
configaroo-0.1.1.dist-info/METADATA,sha256=gJFHgY61fppoAMMt_1dLgKx8luG6p1aD5y_3_pB7bvo,1825
|
10
|
+
configaroo-0.1.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
|
11
|
+
configaroo-0.1.1.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
|
12
|
+
configaroo-0.1.1.dist-info/RECORD,,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright © 2025 Geir Arne Hjelle
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
6
|
+
this software and associated documentation files (the “Software”), to deal in
|
7
|
+
the Software without restriction, including without limitation the rights to
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
10
|
+
subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
@@ -1,21 +0,0 @@
|
|
1
|
-
Metadata-Version: 2.4
|
2
|
-
Name: configaroo
|
3
|
-
Version: 0.1.0
|
4
|
-
Summary: Bouncy handling of configuration files
|
5
|
-
Author-email: Geir Arne Hjelle <geirarne@gmail.com>
|
6
|
-
Requires-Python: >=3.11
|
7
|
-
Description-Content-Type: text/markdown
|
8
|
-
Requires-Dist: pydantic>=2.0
|
9
|
-
Requires-Dist: pyplugs>=0.4.0
|
10
|
-
Requires-Dist: python-dotenv>=1.1.0
|
11
|
-
|
12
|
-
# Configaroo - Bouncy Configuration Handling
|
13
|
-
|
14
|
-
Configaroo is a light configuration package for Python that offers the following features:
|
15
|
-
|
16
|
-
- Access configuration settings with dotted keys: `config.nested.key`
|
17
|
-
- Use different configuration file formats, including TOML and JSON
|
18
|
-
- Override key configuration settings with environment variables
|
19
|
-
- Validate a configuration based on a Pydantic model
|
20
|
-
- Convert the type of configuration values based on a Pydantic model
|
21
|
-
- Dynamically format certain configuration values
|
@@ -1,11 +0,0 @@
|
|
1
|
-
configaroo/__init__.py,sha256=10BHeYLHiIz-oAGM1IdfaqBKyHbn2hiNnjS_zrFOtC8,232
|
2
|
-
configaroo/configuration.py,sha256=V1Dx9LdkRlUSq46Djdq12sWb9JfNi_8N4VBnkXdB11s,5821
|
3
|
-
configaroo/exceptions.py,sha256=1h-6hV7VqqKaRFnu539pjsO0ESSNDibt2kUeF7jAM2M,374
|
4
|
-
configaroo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
5
|
-
configaroo/loaders/__init__.py,sha256=-6GAR4g7vYW7Zagq9Ev479kpkfY7kbvDl4JPXd4wQQ0,756
|
6
|
-
configaroo/loaders/json.py,sha256=6gs_ZegUEe70vb6uSJfKBos7UjfuJnyWgPE_kjDQISw,258
|
7
|
-
configaroo/loaders/toml.py,sha256=ZVbHutZ7V-Z_jf2aHjV18jwaqCXumlr06j48rojHcBM,264
|
8
|
-
configaroo-0.1.0.dist-info/METADATA,sha256=Oy67b4ut26KSC43oh5g50fpjR_Mz5chJ0iqvo4nrWIo,827
|
9
|
-
configaroo-0.1.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
|
10
|
-
configaroo-0.1.0.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
|
11
|
-
configaroo-0.1.0.dist-info/RECORD,,
|
File without changes
|
File without changes
|