Skip to main content

Temporarily set, override, or remove environment variables with a context manager

Project description

philiprehberger-temp-env

Tests PyPI version License

Temporarily set, override, or remove environment variables with a context manager.

Install

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"):
    ...

API Reference

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.

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

philiprehberger_temp_env-0.1.4.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_temp_env-0.1.4-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_temp_env-0.1.4.tar.gz.

File metadata

  • Download URL: philiprehberger_temp_env-0.1.4.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for philiprehberger_temp_env-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8920a53516cb4e770c020102a8c2ada5ea3c78a6f618cf5d0c608e3b2f9b4cd1
MD5 9abb1724ace8c6262abb774a8b40a756
BLAKE2b-256 e25a922e1e7946f92613ebf1ae6ff6f67dd777c1d85578a4f556364eececd17c

See more details on using hashes here.

File details

Details for the file philiprehberger_temp_env-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_temp_env-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2789a3aa3a4c0e58ba7e892c715910713e9a6a6971daf62a1a976e85866d35cf
MD5 cda9cc649027d18053626d4974c2d921
BLAKE2b-256 d279727a6dc032e890849f209e7097b9dfca63631c357e627f78bace518a5f39

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page