envwrap 0.2.0__tar.gz

envwrap-0.2.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: [casperdcl, tqdm]
+thanks_dev: u/gh/casperdcl
+custom: https://tqdm.github.io/merch

envwrap-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,74 @@
+name: ci
+on:
+  push:
+  pull_request:
+  schedule: [{cron: '3 2 * * 6'}]  # M H d m w (Sat 2:03)
+jobs:
+  test:
+    if: github.event_name != 'pull_request' || !contains('OWNER,MEMBER,COLLABORATOR', github.event.pull_request.author_association)
+    strategy:
+      matrix:
+        python: [3.8, 3.9, '3.10', 3.11, 3.12, 3.13, 3.14]
+        os: [ubuntu]
+        include: [{os: macos, python: 3.13}, {os: windows, python: 3.13}]
+    runs-on: ${{ matrix.os }}-latest
+    timeout-minutes: 5
+    defaults: {run: {shell: bash}}
+    steps:
+    - uses: actions/checkout@v6
+      with: {fetch-depth: 0}
+    - uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python }}
+    - run: pip install -e .[dev]
+    - run: pytest --cov=envwrap --cov-report=xml
+    - uses: coverallsapp/github-action@v2
+      with:
+        flag-name: ${{ matrix.python }}-${{ matrix.os }}
+        parallel: true
+    - uses: codecov/codecov-action@v6
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        flags: ${{ matrix.python }}, ${{ matrix.os }}
+    - name: codacy
+      run: |
+        bash <(curl -fsL https://coverage.codacy.com/get.sh) report -l Python -r coverage.xml --partial || :
+      env:
+        CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+  finish:
+    continue-on-error: ${{ github.event_name != 'push' }}
+    needs: test
+    runs-on: ubuntu-slim
+    steps:
+    - uses: coverallsapp/github-action@v2
+      with: {parallel-finished: true}
+    - name: codacy
+      run: |
+        bash <(curl -fsL https://coverage.codacy.com/get.sh) final || :
+      env:
+        CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions: {contents: write, id-token: write, packages: write}
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.GH_TOKEN || github.token }}
+    - uses: actions/setup-python@v6
+      with: {python-version: '3.x'}
+    - id: dist
+      uses: casperdcl/deploy-pypi@v3
+      with:
+        upload: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags') }}
+        build: true
+    - if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+      name: Release
+      run: |
+        changelog=$(git log --pretty='format:%d%n- %s%n%b---' $(git tag --sort=v:refname | tail -n2 | head -n1)..HEAD)
+        tag="${GITHUB_REF#refs/tags/}"
+        gh release create --title "tqdm $tag stable" --draft --notes "$changelog" "$tag" dist/${{ steps.dist.outputs.whl }} dist/${{ steps.dist.outputs.whl_asc }}
+      env:
+        GH_TOKEN: ${{ secrets.GH_TOKEN }}

envwrap-0.2.0/.gitignore

@@ -0,0 +1,11 @@
+*.py[cod]
+__pycache__/
+
+# Packages
+/*.egg*/
+/build/
+/dist/
+
+# Unit test / coverage reports
+/.coverage*
+/coverage.xml

envwrap-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+default_language_version:
+  python: python3
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-docstring-first
+  - id: check-executables-have-shebangs
+  - id: check-toml
+  - id: check-merge-conflict
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: sort-simple-yaml
+  - id: trailing-whitespace
+    exclude: ^README.rst$
+- repo: local
+  hooks:
+  - id: todo
+    name: Check TODO
+    language: pygrep
+    entry: WIP
+    args: [-i]
+    types: [text]
+    exclude: ^(.pre-commit-config.yaml|.github/workflows/test.yml)$
+  - id: pytest
+    name: pytest
+    language: python
+    entry: env PYTHONPATH=. pytest
+    args: [--cov=envwrap]
+    types: [python]
+    pass_filenames: false
+    additional_dependencies:
+    - pytest-cov
+    - platformdirs
+    - PyYAML
+    - toml
+- repo: https://github.com/PyCQA/bandit
+  rev: '1.9.4'
+  hooks:
+  - id: bandit
+    args: [-c, pyproject.toml]
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.3.0
+  hooks:
+  - id: flake8
+    args: [-j8]
+    additional_dependencies:
+    - flake8-broken-line
+    - flake8-bugbear
+    - flake8-comprehensions
+    - flake8-debugger
+    - flake8-isort
+    - flake8-pyproject
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.21.2
+  hooks:
+  - id: pyupgrade
+    args: [--py38-plus]
+- repo: https://github.com/PyCQA/isort
+  rev: 9.0.0a3
+  hooks:
+  - id: isort

envwrap-0.2.0/LICENCE

@@ -0,0 +1,7 @@
+Mozilla Public License Version 2.0
+==================================
+
+This Source Code Form is subject to the terms of the
+Mozilla Public License, v. 2.0.
+If a copy of the MPL was not distributed with this project,
+You can obtain one at https://mozilla.org/MPL/2.0/.

envwrap-0.2.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: envwrap
+Version: 0.2.0
+Summary: Override parameter defaults via environment variables & config files
+Maintainer-email: tqdm developers <devs@tqdm.ml>
+License: MPL-2.0
+Project-URL: repository, https://github.com/tqdm/envwrap
+Project-URL: changelog, https://github.com/tqdm/envwrap/releases
+Keywords: config,environment,env,defaults,partial,appdir,appdirs,platformdirs
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: platformdirs
+Requires-Dist: toml; python_version < "3.11"
+Requires-Dist: PyYAML
+Provides-Extra: dev
+Requires-Dist: pytest>=6; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Dynamic: license-file
+
+# envwrap
+
+[![CI](https://github.com/tqdm/envwrap/actions/workflows/test.yml/badge.svg)](https://github.com/tqdm/envwrap/actions/workflows/test.yml)
+[![coveralls](https://img.shields.io/coveralls/github/tqdm/envwrap/main?logo=coveralls)](https://coveralls.io/github/tqdm/envwrap)
+[![codecov](https://codecov.io/gh/tqdm/envwrap/graph/badge.svg?token=PEWICBIPVW)](https://codecov.io/gh/tqdm/envwrap)
+[![codacy](https://app.codacy.com/project/badge/Grade/6ca7a441560444489fd5c5b1548ab0de)](https://app.codacy.com/gh/tqdm/envwrap/dashboard)
+
+Override parameter defaults via environment variables & config files.
+
+```py
+import envwrap
+
+@envwrap.envwrap("name", "app")
+def func(a=1):
+    ...
+```
+
+Precedence (descending):
+
+- call (`func(a=3)`)
+- environment (`NAME_APP_FUNC_A=2`, `NAME_FUNC_A=2`, `NAME_APP_A=2`, `NAME_A=2`)
+  - `UPPER_CASE` env vars -> `lower_case` param names
+  - other cases aren't supported because Windows ignores case
+- config file:
+  - ./`{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+  - [platformdirs](https://platformdirs.readthedocs.io/en/latest/parameters.html).{user,site}_config_path(name, False)/
+    - `{app}.{toml,yaml,yml,json,ini,cfg}::{func.a,a}`
+    - `{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+- signature (`def foo(a=1)`)
+
+## Advanced Usage
+
+### Live-reload
+
+To force re-reading config files & environment variables without restarting the process:
+
+```py
+envwrap.get_defaults.cache_clear()
+```
+
+### Debugging
+
+A CLI tool can print defaults. For example, with this config:
+
+```toml
+# config file: foo.toml
+[test]
+a = 1337
+b = 2
+```
+
+```sh
+python -m envwrap --help
+FOO_A=42 python -m envwrap foo test
+```
+
+will print:
+
+```py
+>>> @envwrap.envwrap('foo', '')
+>>> def test(...):
+...    ...
+will use defaults:
+{'a': '42', 'b': 2, ...}
+```

envwrap-0.2.0/README.md

@@ -0,0 +1,65 @@
+# envwrap
+
+[![CI](https://github.com/tqdm/envwrap/actions/workflows/test.yml/badge.svg)](https://github.com/tqdm/envwrap/actions/workflows/test.yml)
+[![coveralls](https://img.shields.io/coveralls/github/tqdm/envwrap/main?logo=coveralls)](https://coveralls.io/github/tqdm/envwrap)
+[![codecov](https://codecov.io/gh/tqdm/envwrap/graph/badge.svg?token=PEWICBIPVW)](https://codecov.io/gh/tqdm/envwrap)
+[![codacy](https://app.codacy.com/project/badge/Grade/6ca7a441560444489fd5c5b1548ab0de)](https://app.codacy.com/gh/tqdm/envwrap/dashboard)
+
+Override parameter defaults via environment variables & config files.
+
+```py
+import envwrap
+
+@envwrap.envwrap("name", "app")
+def func(a=1):
+    ...
+```
+
+Precedence (descending):
+
+- call (`func(a=3)`)
+- environment (`NAME_APP_FUNC_A=2`, `NAME_FUNC_A=2`, `NAME_APP_A=2`, `NAME_A=2`)
+  - `UPPER_CASE` env vars -> `lower_case` param names
+  - other cases aren't supported because Windows ignores case
+- config file:
+  - ./`{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+  - [platformdirs](https://platformdirs.readthedocs.io/en/latest/parameters.html).{user,site}_config_path(name, False)/
+    - `{app}.{toml,yaml,yml,json,ini,cfg}::{func.a,a}`
+    - `{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+- signature (`def foo(a=1)`)
+
+## Advanced Usage
+
+### Live-reload
+
+To force re-reading config files & environment variables without restarting the process:
+
+```py
+envwrap.get_defaults.cache_clear()
+```
+
+### Debugging
+
+A CLI tool can print defaults. For example, with this config:
+
+```toml
+# config file: foo.toml
+[test]
+a = 1337
+b = 2
+```
+
+```sh
+python -m envwrap --help
+FOO_A=42 python -m envwrap foo test
+```
+
+will print:
+
+```py
+>>> @envwrap.envwrap('foo', '')
+>>> def test(...):
+...    ...
+will use defaults:
+{'a': '42', 'b': 2, ...}
+```

envwrap-0.2.0/envwrap/__init__.py

@@ -0,0 +1,172 @@
+"""Override parameter defaults via environment variables & config files."""
+import logging
+import os
+from functools import partial, partialmethod
+
+try:
+    from functools import cache  # py>=3.9
+except ImportError:
+    from functools import lru_cache
+    cache = lru_cache(maxsize=None)
+from inspect import signature
+from pathlib import Path, PurePath
+from warnings import warn
+
+from platformdirs import PlatformDirs
+
+log = logging.getLogger(__name__)
+
+
+def read_config(fpath: PurePath) -> dict:
+    log.debug("Reading: %s", fpath)
+    ext = fpath.suffix.lower()[1:]
+    if ext == "toml":
+        try:
+            from tomllib import loads  # py>=3.11
+        except ModuleNotFoundError:
+            from toml import loads
+    elif ext in ("yaml", "yml"):
+        from yaml import safe_load as loads
+    elif ext == "json":
+        from json import loads
+    elif ext in ("ini", "cfg"):
+        from configparser import ConfigParser
+        parser = ConfigParser()
+        parser.read_string(fpath.read_text())
+        res = {sec: dict(parser.items(sec)) for sec in parser.sections() if sec.count(".") == 0}
+        for sec in parser.sections():
+            if sec.count(".") == 1:
+                parent, child = sec.split(".", 1)
+                res.setdefault(parent, {}).setdefault(child, {})
+                res[parent][child] |= parser.items(sec)
+            elif sec.count(".") > 1:
+                warn(f"Skipping nested section: {sec}", UserWarning, stacklevel=2)
+        return res
+    else:
+        raise TypeError(f"Unsupported config filetype: {fpath}")
+
+    return loads(fpath.read_text())
+
+
+@cache
+def get_defaults(name: str, app: str, func: str):
+    """In-memory (functools.cache) of overrides extracted from config files & env vars."""
+    conf = PlatformDirs(name, False)
+    overrides = {}
+    for pth, base in (
+        (conf.site_config_path, name),
+        (conf.site_config_path, app),
+        (conf.user_config_path, name),
+        (conf.user_config_path, app),
+        (Path("."), name),
+    ):
+        if not base:
+            continue
+        log.debug("Searching in %s/%s.*", pth, base)
+        for ext in ('cfg', 'ini', 'json', 'yml', 'yaml', 'toml'):
+            if (fpath := pth / f"{base}.{ext}").is_file():
+                try:
+                    cfg = read_config(fpath)
+                    overrides.update(cfg)
+                    if base == name:
+                        # app.func.a,func.a,app.a,a
+                        if app in cfg:
+                            overrides.update(cfg[app])
+                        if func in cfg:
+                            overrides.update(cfg[func])
+                        if app in cfg and func in cfg[app]:
+                            overrides.update(cfg[app][func])
+                    elif base == app:
+                        # func.a,a
+                        if func in cfg:
+                            overrides.update(cfg[func])
+                except Exception as exc:
+                    log.debug(f"Exception ignored: {exc}")
+    if app:
+        prefixes = name, f"{name}_{app}", f"{name}_{func}", f"{name}_{app}_{func}"
+    else:
+        prefixes = name, f"{name}_{func}"
+    for prefix in prefixes:
+        prefix = prefix.upper() + "_"
+        log.debug(f"Looking for variables: {prefix}*")
+        overrides.update(
+            (k[len(prefix):].lower(), v) for k, v in os.environ.items() if k.startswith(prefix))
+    return overrides
+
+
+def envwrap(name: str, app: str = "", types: dict = None, is_method=False):
+    """Function decorator overriding default arguments.
+
+    Precedence (descending):
+    - call (`func(a=3)`)
+    - environment (`NAME_APP_FUNC_A=2`, `NAME_FUNC_A=2`, `NAME_APP_A=2`, `NAME_A=2`)
+        - `UPPER_CASE` env vars -> `lower_case` param names
+        - other cases aren't supported because Windows ignores case
+    - config file:
+        - ./`{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+        - platformdirs.{user,site}_config_path(name, False)/
+            - `{app}.{toml,yaml,yml,json,ini,cfg}::{func.a,a}`
+            - `{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+    - signature (`def foo(a=1)`)
+
+    Parameters
+    ----------
+    name:
+        Configuration name.
+    app:
+        Application name.
+    types:
+        Fallback mappings `{'param_name': type, ...}` if types cannot be
+        inferred from function signature.
+        Consider using `types=collections.defaultdict(lambda: ast.literal_eval)`.
+    is_method:
+        Whether to use `functools.partialmethod`. If (default: False) use `functools.partial`.
+
+    Examples
+    --------
+    >>> os.environ.update(dict(FOO_A="7", FOO_TEST_A="42", FOO_C="1337"))
+    >>> from envwrap import envwrap
+    >>> @envwrap("FOO")
+    >>> def test(a=1, b=2, c=3):
+    ...     print(f"received: a={a}, b={b}, c={c}")
+    ...
+    >>> test(c=99)
+    received: a=42, b=2, c=99
+
+    """
+    if types is None:
+        types = {}
+    if name[-1] == "_":
+        name = name[:-1]
+        warn("Trailing underscore in `name` is automatic", DeprecationWarning, stacklevel=2)
+
+    part = partialmethod if is_method else partial
+
+    def wrap(func):
+        params = signature(func).parameters
+        env_overrides = get_defaults(name, app, func.__name__)
+        # ignore unknown env vars
+        overrides = {k: v for k, v in env_overrides.items() if k in params}
+        log.debug("Loaded overrides for %s: %s", func.__name__, overrides)
+        # infer overrides' `type`s
+        for k in overrides:
+            param = params[k]
+            if param.annotation is not param.empty: # typehints
+                for typ in getattr(param.annotation, '__args__', (param.annotation,)):
+                    try:
+                        overrides[k] = typ(overrides[k])
+                    except Exception:
+                        log.debug("Failed to convert %s to %s", overrides[k], typ)
+                    else:
+                        break
+            elif param.default is not None:         # type of default value
+                overrides[k] = type(param.default)(overrides[k])
+            else:
+                try:                                # `types` fallback
+                    overrides[k] = types[k](overrides[k])
+                except KeyError:                    # keep unconverted (`str`)
+                    pass
+        log.debug("Typed overrides: %s", overrides)
+        return part(func, **overrides)
+
+    return wrap

envwrap-0.2.0/envwrap/cli.py

@@ -0,0 +1,30 @@
+import argparse
+import logging
+from pprint import pprint
+
+from . import get_defaults
+
+
+def main(argv=None):
+    parser = argparse.ArgumentParser(description="Print envwrap overrides")
+    parser.add_argument("args", nargs="+", help="<name> [<app>] <func>")
+    parser.add_argument("-v", "--verbose", action="count", default=0, help="print debug info")
+
+    args = parser.parse_args(argv)
+    logging.basicConfig(
+        level={0: logging.INFO, 1: logging.DEBUG}.get(args.verbose, logging.NOTSET))
+    if len(args.args) == 2:
+        app = ""
+    elif len(args.args) == 3:
+        app = args.args[1]
+    else:
+        raise ValueError("Usage: envwrap <config_name> [<app_name>] <func_name>")
+    name = args.args[0]
+    func = args.args[-1]
+    print(f">>> @envwrap.envwrap('{name}', '{app}')", f">>> def {func}(...):", "...    ...",
+          "will use defaults:", sep="\n")
+    pprint(get_defaults(name, app, func))
+
+
+if __name__ == "__main__":
+    main()    # pragma: no cover

envwrap-0.2.0/envwrap.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: envwrap
+Version: 0.2.0
+Summary: Override parameter defaults via environment variables & config files
+Maintainer-email: tqdm developers <devs@tqdm.ml>
+License: MPL-2.0
+Project-URL: repository, https://github.com/tqdm/envwrap
+Project-URL: changelog, https://github.com/tqdm/envwrap/releases
+Keywords: config,environment,env,defaults,partial,appdir,appdirs,platformdirs
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+Requires-Dist: platformdirs
+Requires-Dist: toml; python_version < "3.11"
+Requires-Dist: PyYAML
+Provides-Extra: dev
+Requires-Dist: pytest>=6; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Dynamic: license-file
+
+# envwrap
+
+[![CI](https://github.com/tqdm/envwrap/actions/workflows/test.yml/badge.svg)](https://github.com/tqdm/envwrap/actions/workflows/test.yml)
+[![coveralls](https://img.shields.io/coveralls/github/tqdm/envwrap/main?logo=coveralls)](https://coveralls.io/github/tqdm/envwrap)
+[![codecov](https://codecov.io/gh/tqdm/envwrap/graph/badge.svg?token=PEWICBIPVW)](https://codecov.io/gh/tqdm/envwrap)
+[![codacy](https://app.codacy.com/project/badge/Grade/6ca7a441560444489fd5c5b1548ab0de)](https://app.codacy.com/gh/tqdm/envwrap/dashboard)
+
+Override parameter defaults via environment variables & config files.
+
+```py
+import envwrap
+
+@envwrap.envwrap("name", "app")
+def func(a=1):
+    ...
+```
+
+Precedence (descending):
+
+- call (`func(a=3)`)
+- environment (`NAME_APP_FUNC_A=2`, `NAME_FUNC_A=2`, `NAME_APP_A=2`, `NAME_A=2`)
+  - `UPPER_CASE` env vars -> `lower_case` param names
+  - other cases aren't supported because Windows ignores case
+- config file:
+  - ./`{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+  - [platformdirs](https://platformdirs.readthedocs.io/en/latest/parameters.html).{user,site}_config_path(name, False)/
+    - `{app}.{toml,yaml,yml,json,ini,cfg}::{func.a,a}`
+    - `{name}.{toml,yaml,yml,json,ini,cfg}::{app.func.a,func.a,app.a,a}`
+- signature (`def foo(a=1)`)
+
+## Advanced Usage
+
+### Live-reload
+
+To force re-reading config files & environment variables without restarting the process:
+
+```py
+envwrap.get_defaults.cache_clear()
+```
+
+### Debugging
+
+A CLI tool can print defaults. For example, with this config:
+
+```toml
+# config file: foo.toml
+[test]
+a = 1337
+b = 2
+```
+
+```sh
+python -m envwrap --help
+FOO_A=42 python -m envwrap foo test
+```
+
+will print:
+
+```py
+>>> @envwrap.envwrap('foo', '')
+>>> def test(...):
+...    ...
+will use defaults:
+{'a': '42', 'b': 2, ...}
+```

envwrap-0.2.0/envwrap.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+.gitignore
+.pre-commit-config.yaml
+LICENCE
+README.md
+pyproject.toml
+.github/FUNDING.yml
+.github/workflows/test.yml
+envwrap/__init__.py
+envwrap/cli.py
+envwrap.egg-info/PKG-INFO
+envwrap.egg-info/SOURCES.txt
+envwrap.egg-info/dependency_links.txt
+envwrap.egg-info/entry_points.txt
+envwrap.egg-info/requires.txt
+envwrap.egg-info/top_level.txt
+tests/test_envwrap.py

envwrap-0.2.0/envwrap.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

envwrap-0.2.0/envwrap.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+envwrap = envwrap.cli:main

envwrap-0.2.0/envwrap.egg-info/requires.txt

@@ -0,0 +1,10 @@
+platformdirs
+PyYAML
+
+[:python_version < "3.11"]
+toml
+
+[dev]
+pytest>=6
+pytest-cov
+toml

envwrap-0.2.0/envwrap.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+envwrap

envwrap-0.2.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=42", "setuptools-scm[toml]>=3.4"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+
+[tool.setuptools.packages.find]
+exclude = ["tests"]
+
+[project.urls]
+repository = "https://github.com/tqdm/envwrap"
+changelog = "https://github.com/tqdm/envwrap/releases"
+
+[project]
+name = "envwrap"
+dynamic = ["version"]
+maintainers = [{name = "tqdm developers", email = "devs@tqdm.ml"}]
+description = "Override parameter defaults via environment variables & config files"
+readme = "README.md"
+requires-python = ">=3.8"
+keywords = ["config", "environment", "env", "defaults", "partial", "appdir", "appdirs", "platformdirs"]
+license = {text = "MPL-2.0"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft",
+    "Operating System :: POSIX",
+    "Operating System :: Unix"]
+dependencies = [
+    "platformdirs",
+    "toml; python_version < '3.11'",
+    "PyYAML",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=6", "pytest-cov", "toml"]
+
+[project.scripts]
+envwrap = "envwrap.cli:main"
+
+[tool.bandit]
+exclude_dirs = ["tests"]
+
+[tool.flake8]
+max_line_length = 99
+extend_ignore = ["E261"]
+exclude = [".git", "__pycache__", "build", "dist", ".eggs"]
+
+[tool.yapf]
+spaces_before_comment = [15, 20]
+arithmetic_precedence_indication = true
+allow_split_before_dict_value = false
+coalesce_brackets = true
+column_limit = 99
+each_dict_entry_on_separate_line = false
+space_between_ending_comma_and_closing_bracket = false
+split_before_named_assigns = false
+split_before_closing_bracket = false
+blank_line_before_nested_class_or_def = false
+
+[tool.isort]
+line_length = 99
+multi_line_output = 4
+known_first_party = ["envwrap", "tests"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+log_level = "INFO"
+testpaths = ["tests"]
+addopts = "-v --tb=short -rxs -W=error --durations=0 --durations-min=0.1"
+
+[tool.coverage.run]
+branch = true
+[tool.coverage.report]
+show_missing = true

envwrap-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

envwrap-0.2.0/tests/test_envwrap.py

@@ -0,0 +1,115 @@
+import os
+from sys import version_info
+from textwrap import dedent
+
+import pytest
+
+from envwrap import cli, envwrap, get_defaults
+
+
+def write_config(fpath, cfg):
+    ext = fpath.suffix.lower()[1:]
+    fpath.parent.mkdir(parents=True, exist_ok=True)
+    if ext == "toml":
+        from toml import dumps
+    elif ext in ("yaml", "yml"):
+        from yaml import safe_dump as dumps
+    elif ext == "json":
+        from json import dumps
+    elif ext in ("ini", "cfg"):
+        from configparser import ConfigParser
+        parser = ConfigParser()
+        for sec, items in cfg.items():
+            parser[sec] = {k: v for k, v in items.items() if not isinstance(v, dict)}
+            for subsec, subitems in items.items():
+                if isinstance(subitems, dict):
+                    parser[f"{sec}.{subsec}"] = subitems
+        with fpath.open("w") as fd:
+            return parser.write(fd)
+    else:
+        raise TypeError(f"Unsupported config filetype: {fpath}")
+    fpath.write_text(dumps(cfg))
+
+
+@pytest.fixture(autouse=True)
+def set_env():
+    os.environ["ENVWRAP_B"] = "42"
+    os.environ["ENVWRAP_C"] = "1337"
+    os.environ["ENVWRAP_TESTENV_D"] = "360"
+    os.environ["ENVWRAP_FUNCNAME_E"] = "101"
+    os.environ["ENVWRAP_TESTENV_FUNCNAME_F"] = "404"
+    get_defaults.cache_clear()
+
+
+def funcname(a=1, b=2, c=3, d=4, e=5, f=6):
+    return {"a": a, "b": b, "c": c, "d": d, "e": e, "f": f}
+
+
+def test_env():
+    f = envwrap("envwrap", "testenv")(funcname)
+    assert f(c=99) == {"a": 1, "b": 42, "c": 99, "d": 360, "e": 101, "f": 404}
+    f = envwrap("envwrap")(funcname)
+    assert f(c=99) == {"a": 1, "b": 42, "c": 99, "d": 4, "e": 101, "f": 6}
+
+
+@pytest.mark.parametrize("ext", ["toml", "yaml", "yml", "json", "ini", "cfg"])
+def test_conf(tmp_path, ext):
+    if version_info < (3, 9) and ext in ("ini", "cfg"):
+        pytest.skip("configparser dict merging requires python>=3.9")
+    config = {
+        "testcfg": {"b": 43, "c": 1338, "d": 361, "funcname": {"f": 405}}, "funcname": {"e": 102}}
+    write_config(tmp_path / f"cfgwrap.{ext}", config)
+    pwd = os.curdir
+    os.chdir(tmp_path)
+    try:
+        f = envwrap("cfgwrap", "testcfg")(funcname)
+        assert f(c=98) == {"a": 1, "b": 43, "c": 98, "d": 361, "e": 102, "f": 405}
+    finally:
+        os.chdir(pwd)
+
+
+def test_env_cli(capsys):
+    cli.main(["envwrap", "testenv", "funcname"])
+    out, err = capsys.readouterr()
+    assert out == dedent("""\
+    >>> @envwrap.envwrap('envwrap', 'testenv')
+    >>> def funcname(...):
+    ...    ...
+    will use defaults:
+    {'b': '42',
+     'c': '1337',
+     'd': '360',
+     'e': '101',
+     'f': '404',
+     'funcname_e': '101',
+     'funcname_f': '404',
+     'testenv_d': '360',
+     'testenv_funcname_f': '404'}
+    """)
+    assert not err
+
+    cli.main(["envwrap", "funcname"])
+    out, err = capsys.readouterr()
+    assert out == dedent("""\
+    >>> @envwrap.envwrap('envwrap', '')
+    >>> def funcname(...):
+    ...    ...
+    will use defaults:
+    {'b': '42',
+     'c': '1337',
+     'e': '101',
+     'funcname_e': '101',
+     'testenv_d': '360',
+     'testenv_funcname_f': '404'}
+    """)
+    assert not err
+
+    with pytest.raises(ValueError):
+        cli.main(["envwrap"])
+    with pytest.raises(ValueError):
+        cli.main(["envwrap", "testenv", "funcname", "extra"])
+
+
+def test_deprecated_underscore():
+    with pytest.warns(DeprecationWarning, match="Trailing underscore"):
+        envwrap("envwrap_", "testenv")(funcname)