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.

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

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.6.tar.gz (3.8 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.6-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: philiprehberger_temp_env-0.1.6.tar.gz
  • Upload date:
  • Size: 3.8 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.6.tar.gz
Algorithm Hash digest
SHA256 48ca3234265c00c45abb4f9428f806cf847c93ce45c58c918fe4d1ab9041d7cd
MD5 b101d28bb6e67d4957f3a585a94dada7
BLAKE2b-256 36235ef1d3d841fff5b67d0a2ee1b35b0ed01d0d2b405ad46f071ab7b971ca96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_temp_env-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1ea4379f14ff02859d9ef4e2c74522457df879f17120734b1e676ddfa719eaab
MD5 7cfbd19f6ae0348760179d76659af114
BLAKE2b-256 4c2fac329c6d3531491afc74b58e14ac87cd5a7387e81239306b305aaa16424c

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