Skip to main content

easy_env

https://travis-ci.org/vaniakosmos/easy_env.svg?master

Implement common operations over env vars such as reading booleans and integers.

Installation

pip install easy_env

Usage

import os
import easy_env


# setup env vars
setup_vars = [
        ('int', '42'),
        ('float', '42.9'),
        ('bool', 'yes'),
        ('str', 'foo bar'),
        ('bytes', 'Zm9v'),  # base64 encoded b'foo'
        ('list', '1,2,3'),
        ('list2', '4 5 6'),
]
for var, value in setup_vars:
        os.environ[var] = value


# get var
assert easy_env.get_int('int') == 42
assert easy_env.get_float('float') == 42.9
assert easy_env.get_bool('bool') is True
assert easy_env.get_str('str') == 'foo bar'
assert easy_env.get_bytes('bytes') == b'foo'
assert easy_env.get_list('list') == ['1', '2', '3']

# get w/ default
assert easy_env.get_int('NEW_VAR', 5) == 5

# get w/o default
assert easy_env.get_int('NEW_VAR') is None

# get w/o default and raise exception
try:
        easy_env.get_int('NEW_VAR', raise_error=True)
        assert False
except KeyError:
        assert True

# get list of integers
assert easy_env.get_list('list', item_factory=int) == [1, 2, 3]
# get list w/ another separator
assert easy_env.get_list('list2', separator=' ') == ['4', '5', '6']

# detect type based on type of default
assert easy_env.get('int', 1) == 42
assert easy_env.get('int') == '42'
assert easy_env.get('float', 1.0) == 42.9
assert easy_env.get('bool', False) is True
assert easy_env.get('bytes', b'') == b'foo'
assert easy_env.get('list2', default=[], separator=' ') == ['4', '5', '6']


# set int
easy_env.set_int('int_var', 42)
assert os.getenv('int_var') == '42'

# set float
easy_env.set_float('float_var', 42.0)
assert os.getenv('float_var') == '42.0'

# set bool
easy_env.set_bool('bool_var', True)
assert os.getenv('bool_var') == '1'
easy_env.set_bool('bool_var', False)
assert os.getenv('bool_var') == '0'

# set string
easy_env.set_str('str_var', 'foo bar')
assert os.getenv('str_var') == 'foo bar'

# set bytes
easy_env.set_bytes('bytes_var', b'foo')
assert os.getenv('bytes_var') == 'Zm9v'

# set list
easy_env.set_list('list_var', [1, 2, 3])
assert os.getenv('list_var') == '1,2,3'
easy_env.set_list('list_var', [1, 2, 3], separator=' ')
assert os.getenv('list_var') == '1 2 3'
easy_env.set_list('list_var', [1, 2, 3], serializer=lambda x: str(x - 1))
assert os.getenv('list_var') == '0,1,2'

Metadata

Release files for easy-env 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for easy-env 0.1.3
File Interpreter ABI Platform Actions
easy_env-0.1.3-py3-none-any.whl Python 3 none any Details for easy_env-0.1.3-py3-none-any.whl

Release files / easy_env-0.1.3-py3-none-any.whl

Download URL easy_env-0.1.3-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea7af91d1f182bb2382f7a366858d2d6887d589a6fbf6f79a75cc48e2d415d3f
BLAKE2b-256 checksum
How to use checksums
a4b073e49fde1f3065d5bca4046636b5764283a2f549f4349d28d6435c5e8b37
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for easy-env 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page