envparse

library0.2.0pypypi✓ verified 86d ago

Envparse is a Python utility designed for parsing environment variables, inspired by the 12 Factor App methodology. It simplifies configuration management by providing a wrapper around `os.environ` that handles type casting and default values, reducing boilerplate code. The current stable version on PyPI is 0.2.0, released in December 2015, indicating a mature but infrequently updated library.

devops

pip install envparse

github ↗package ↗

INSTALL

IMPORT

SIG · ENVPARSE

envparse

devopspythonv0.2.0

Install

—

Import

—

Disk

—

Pass rate

0/ 10

Env Coverage0 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.2.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

glibc

py 3.10

4/8 runs

py 3.11

4/8 runs

py 3.12

4/8 runs

py 3.13

4/8 runs

py 3.9

4/8 runs

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

env

✓ from envparse import env

Env

✓ from envparse import Env

This quickstart demonstrates both the standard `env` object and the schema-based `Env` class. It shows how to load variables, cast them to specific types (explicitly and implicitly for built-in types), and provide default values. A dummy `.env` file is created and cleaned up for a self-contained example. Note the use of `type` for explicit casting and `env.int()` for implicit casting of built-in types, as per version 0.2.0 documentation.

import os from envparse import env, Env # Create a dummy .env file for demonstration with open('.env', 'w') as f: f.write('DATABASE_URL=sqlite:///db.sqlite ') f.write('DEBUG=True ') f.write('ALLOWED_HOSTS=localhost,127.0.0.1 ') f.write('WORKERS=4 ') # Load .env file (optional, envparse searches parent directories too) env.read_envfile() # --- Standard usage (env object) --- db_url = env('DATABASE_URL', default='postgres://localhost/mydb') debug_mode = env('DEBUG', type=bool, default=False) workers = env.int('WORKERS', default=2) # Implicit type casting for built-in types print(f"[Standard] DB URL: {db_url}") print(f"[Standard] Debug Mode: {debug_mode} (type: {type(debug_mode)})") print(f"[Standard] Workers: {workers} (type: {type(workers)})") # --- Usage with schema (Env class) --- # Define a schema for environment variables config_schema = Env( ALLOWED_HOSTS=(list, ['*']), # (type, default) SECRET_KEY=str # type only, no default, will raise ConfigurationError if missing ) # Load config from schema allowed_hosts = config_schema('ALLOWED_HOSTS') print(f"[Schema] Allowed Hosts: {allowed_hosts} (type: {type(allowed_hosts)})") # Clean up dummy .env file os.remove('.env')

Debug

Known issues

gotchaThe `env.read_envfile()` method uses `os.environ.setdefault()`, which means environment variables already set in the operating system will *not* be overridden by values in the `.env` file. This can lead to unexpected behavior if you intend for the `.env` file to always be the source of truth.

fix

Manually delete conflicting environment variables before running your application, or consider a library that explicitly supports overriding existing variables. For testing, you might use `del os.environ['VAR_NAME']` before calling `read_envfile()`.

affects: 0.1.x, 0.2.0

gotchaThere is a discrepancy in keyword arguments for type casting between the PyPI 0.2.0 description (`type`, `subtype`) and the current GitHub README (`cast`, `subcast`). For the installed 0.2.0 version from PyPI, use `type=some_type` and `subtype=some_nested_type` (e.g., for lists). If installing directly from GitHub, `cast` and `subcast` might be required.

fix

Refer to the specific version's documentation or the GitHub README for the most up-to-date API. For `pip install envparse==0.2.0`, use `type` and `subtype`.

affects: 0.2.0 (PyPI install)

deprecatedThe `envparse` library, at version 0.2.0, has not seen a new release since December 2015. While functional, it may lack features or bug fixes present in more actively maintained environment variable parsing libraries. Consider alternatives like `python-decouple` or `environs` if active development and newer features are a priority.

fix

Evaluate newer alternatives for active development. If continuing with `envparse`, be aware that issues might not be actively addressed.

affects: 0.2.0 (since 2015)

Errors

Common errors & fixes

KeyError: 'ENV_VAR_NAME'

Attempting to access an environment variable that is not set, and no default value or schema is provided.

fix

Provide a default value: `value = env('ENV_VAR_NAME', default='fallback_value')`. Alternatively, use the `Env` class with a defined schema, which raises a `ConfigurationError` for missing variables, providing a more specific error.

assert mail_enabled is True # where MAIL_ENABLED=0 in .env

Boolean environment variables are parsed as strings ('True', 'False', '1', '0') by default. Without explicit casting, `env('DEBUG')` might return the string 'True' or '0', which evaluates to `True` in a boolean context, but `is True` will fail for the string 'True' and '0' is not `False`.

fix

Always explicitly cast boolean-like environment variables: `mail_enabled = env('MAIL_ENABLED', type=bool)` or `mail_enabled = env.bool('MAIL_ENABLED')`. This will correctly convert '0', 'False', 'off' to `False` and '1', 'True', 'on' to `True`.

AttributeError: 'envparse.env.Env' object has no attribute 'json'

Attempting to use convenience methods like `env.json()` or `env.url()` which might not be available in older versions or are not explicitly imported.

fix

For basic types, use explicit casting: `json_data = env('JSON_VAR', type=dict)`. Ensure you are using the correct method signatures as per the specific version of `envparse` being used, or consult the GitHub README for the most current API if these convenience methods are desired and not working.

Upgrade

Version history

0.2.0latest on PyPI · released Dec 19, 2015

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/rconradharris/envparse ↗

packagehttps://pypi.org/project/envparse/ ↗