Skip to main content

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

Project description

philiprehberger-temp-env

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.

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.1.tar.gz (3.5 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.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: philiprehberger_temp_env-0.1.1.tar.gz
  • Upload date:
  • Size: 3.5 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.1.tar.gz
Algorithm Hash digest
SHA256 60d7a159376868e17079a9b01dd6164be024adf8d0933b1c85991e4b47ce9976
MD5 0e344210539cd15b48f012c4d4a64bdd
BLAKE2b-256 57b88534d435fb2cc426498c3e5d17a2312a913669ae1a6c0c3fdbd506265d43

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_temp_env-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e6401bc6e986dde32a2efad46a58eb45b42dea490e651e10c20395b1242ee5f6
MD5 c817180af64bb85549a50e3bd4f39250
BLAKE2b-256 02160b55a7693e2477c692bb596003f5f5c52ded69e8e841b49f3eb9f60bf345

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