philiprehberger-temp-env
v0.2.0817 downloadsMIT
Temporarily set, override, or remove environment variables with a context manager
$
pip install philiprehberger-temp-envREADME
philiprehberger-temp-env
Temporarily set, override, or remove environment variables with a context manager.
Installation
pip install philiprehberger-temp-env
Usage
Context manager
from philiprehberger_temp_env import temp_env
with temp_env(API_KEY="test-key", DEBUG="1"):
# API_KEY and DEBUG are set
...
# Original values are restored
Remove a variable temporarily
from philiprehberger_temp_env import temp_env
with temp_env(SECRET=None):
# SECRET is removed from the environment
...
# SECRET is restored
Decorator for tests
from philiprehberger_temp_env import env_override
@env_override(DATABASE_URL="sqlite:///:memory:", DEBUG="0")
def test_database():
...
Load from .env file
from philiprehberger_temp_env import TempEnv
ctx = TempEnv.from_file(".env")
with ctx:
...
TempEnv class directly
from philiprehberger_temp_env import TempEnv
with TempEnv(API_KEY="test", VERBOSE="1"):
...
Unsetting and snapshotting
from philiprehberger_temp_env import temp_unset, snapshot_env, restore_env
# Temporarily remove env vars; restore on exit
with temp_unset("AWS_PROFILE", "AWS_REGION"):
# AWS_PROFILE and AWS_REGION are unset
...
# Explicit save/restore beyond a context manager block
snap = snapshot_env("API_KEY", "DEBUG")
# ... mutate the environment freely ...
restore_env(snap) # Variables that were unset before are removed again
API
| Name | Description |
|---|---|
temp_env(**kwargs: str | None) | Context manager that temporarily sets, overrides, or removes env vars. Pass None to remove a variable. |
env_override(**kwargs: str | None) | Decorator that wraps a function with temporary env var overrides. |
TempEnv(**kwargs: str | None) | Class that can be used as a context manager directly. |
TempEnv.from_file(path) | Classmethod that parses a .env file and returns a TempEnv instance. |
temp_unset(*names) | Context manager that temporarily removes the named env vars and restores them on exit. |
snapshot_env(*names) | Returns a dict[str, str | None] capturing the current value (or None if unset) of each name. |
restore_env(snapshot) | Restores env vars from a snapshot dict; None values mean "remove if present". |
Development
pip install -e .
python -m pytest tests/ -v
Support
If you find this project useful: