Skip to main content

Expand system variables Unix style

Project description

expandvars

Expand system variables Unix style

PyPI version Build Status codecov

Inspiration

This module is inspired by GNU bash's variable expansion features. It can be used as an alternative to Python's os.path.expandvars function.

A good use case is reading config files with the flexibility of reading values from environment variables using advanced features like returning a default value if some variable is not defined. For example:

[default]
my_secret_access_code = "${ACCESS_CODE:-default_access_code}"

NOTE: Although it copies most of the common behaviours, it doesn't follow it strictly. For example, it doesn't work with arrays.

Usage

from expandvars import expandvars

print(expandvars("$PATH:$HOME/bin:${SOME_UNDEFINED_PATH:-/default/path}"))
# /bin:/sbin:/usr/bin:/usr/sbin:/home/you/bin:/default/path

Examples

For now, refer to the test cases to see how it behaves.

Contributing

To contribute, setup environment following way:

# Clone repo
git clone https://github.com/sayanarijit/expandvars && cd expandvars

# Create virtualenv
virtualenv .venv && source .venv/bin/activate

# Install project
pip install -e '.[testing]'

# Optional install black, ipython
pip install black ipython isort

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

expandvars-0.1.6.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

expandvars-0.1.6-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: expandvars-0.1.6.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for expandvars-0.1.6.tar.gz
Algorithm Hash digest
SHA256 131163861df452e0e2387266ee77126420e2f03f4a2ce91818adbf6dc5350e2c
MD5 3a76a7d8137e3badc83de475bc80ae9c
BLAKE2b-256 a0c615f58334281f86511a9a78671b48d36ab8428f4737b53e4dd49c72e6c57a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: expandvars-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for expandvars-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 82d0fc5904b4cacd123f0ae776a93032f64098ef9af81857fdad903fe2a21e52
MD5 42123e26dfda2909a15b2f8a297076d6
BLAKE2b-256 f3c61d53935b91ae9bc617a1797596837516956e072e3c2daf390f2080aa0feb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page