Expand system variables Unix style
Project description
expandvars
Expand system variables Unix style
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 this module copies most of the common behaviours of bash, it doesn't follow bash 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 library in edit mode along with other handy dev tools
pip install -r dev-requirements.txt
- Follow general git guidelines.
- Keep it simple. Use black to format code.
- Test your changes locally by running
pytest. - If you are familiar with tox, you may want to use it for testing in different python versions.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file expandvars-0.5.1.tar.gz.
File metadata
- Download URL: expandvars-0.5.1.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f86e28d76b29dd3a5f129e781da1dae091487b342738c57b7df80691e4115923 |
|
| MD5 | 2247b9f6113faa0ac00ad94ebdb03c20 |
|
| BLAKE2b-256 | b745cb6831f582cdcfc171a8d3ccc6d47d7e60afa78d0ede691b4207ace18785 |
File details
Details for the file expandvars-0.5.1-py3-none-any.whl.
File metadata
- Download URL: expandvars-0.5.1-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f13832b9a4c1452e7ebf5c53e8bec88278a45d1c3fc3c72e4f085cdfb43e0917 |
|
| MD5 | 2ff499c2da1dd741787ab99c4addf4f2 |
|
| BLAKE2b-256 | cdead15adc9e42ec2bcf5770ac8b88694569de8fe8cceba59fa5981aee7a6b14 |
