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.

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.3.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.3-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: philiprehberger_temp_env-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 94fb6ac057e66eb8e8d16d3826629d4e6b2f1638d2ac048ad4bf799eb18cd89e
MD5 dba719cf836a87e5bd20d262fc623b0c
BLAKE2b-256 54f661fc0c9929b8d08ca020bea8a566b41da09f57dfbf9a75037f4c2a80c94a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_temp_env-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b8e482f43afc386dc0712f91893b9132167854d4a75cfed1415280eac17df19a
MD5 86bb0c258ed43f0edd502ba533018604
BLAKE2b-256 c6f5afca689763c908ffb6676257ce0fecb33206cd9ac3baf122dbdeb3221b4c

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