expandvars

https://pypi.org/project/expandvars/
Admin
A Python library that expands system variables Unix-style, inspired by GNU bash's variable expansion...
Tokens:1,589
Snippets:27
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Clone Repository and Setup Environment

Source: https://pypi.org/project/expandvars

Instructions for cloning the expandvars repository and setting up a virtual environment for development, including installing test dependencies.

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

# Setup virtualenv
python -m venv .venv
source ./.venv/bin/activate

# Install as editable including test dependencies
pip install -e ".[tests]"

```

--------------------------------

### Configuration File Example

Source: https://pypi.org/project/expandvars/1.1.1

Illustrates how to use expandvars for reading configuration files with environment variable expansion, including default values and error handling.

```text
[default]
my_secret_access_code = "${ACCESS_CODE:-default_access_code}"
my_important_variable = "${IMPORTANT_VARIABLE:?}"
my_updated_path = "$PATH:$HOME/.bin"
my_process_id = "$$"
my_nested_variable = "${!NESTED}"

```

--------------------------------

### Configuration File Example

Source: https://pypi.org/project/expandvars

Illustrates how to use expandvars for reading configuration files with environment variable expansion, including default values and error handling.

```ini
[default]
my_secret_access_code = "${ACCESS_CODE:-default_access_code}"
my_important_variable = "${IMPORTANT_VARIABLE:?}"
my_updated_path = "$PATH:$HOME/.bin"
my_process_id = "$$"
my_nested_variable = "${!NESTED}"


```

--------------------------------

### Install expandvars using Conda

Source: https://pypi.org/project/expandvars

Installation command for the expandvars package using Conda.

```bash
conda install -c conda-forge expandvars

```

--------------------------------

### Install expandvars using Pip

Source: https://pypi.org/project/expandvars

Standard installation command for the expandvars package using pip.

```bash
pip install expandvars

```

--------------------------------

### Installing expandvars with test dependencies

Source: https://pypi.org/project/expandvars/1.1.1

Installs the expandvars package in editable mode, including dependencies required for running tests.

```bash
# Install as editable including test dependencies
pip install -e ".[tests]"

```

--------------------------------

### Setting up a virtual environment

Source: https://pypi.org/project/expandvars/1.1.1

Commands to set up and activate a Python virtual environment for the expandvars project.

```bash
# Setup virtualenv
python -m venv .venv
source ./.venv/bin/activate

```

--------------------------------

### Cloning the expandvars repository

Source: https://pypi.org/project/expandvars/1.1.1

Instructions for cloning the expandvars project repository from GitHub.

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

```

--------------------------------

### Basic Usage of expandvars

Source: https://pypi.org/project/expandvars

Demonstrates the basic usage of the expandvars function to expand environment variables, including default values for undefined variables.

```python
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

```

--------------------------------

### Running tests with coverage

Source: https://pypi.org/project/expandvars/1.1.1

Command to run local tests for the expandvars project and generate a coverage report.

```bash
# Test your changes locally by running `pytest` (pass `--cov --cov-report html` for browsable coverage report).
pytest --cov --cov-report html

```

--------------------------------

### Customizing expand function

Source: https://pypi.org/project/expandvars

Demonstrates the use of the more general 'expand' function for customization, including changing the variable symbol, escape character, and expansion environment.

```python
from expandvars import expand

print(expand("%PATH:$HOME/bin:%{SOME_UNDEFINED_PATH:-D:\\default\\path}", environ={"PATH": "/example"}, var_symbol="%", surrounded_vars_only=True, escape_char=""))
# %PATH:$HOME/bin:D:\default\path

```

--------------------------------

### Strict Parsing with nounset=True

Source: https://pypi.org/project/expandvars

Shows how to enable strict parsing, similar to bash's 'set -u', where all variables must be defined. This will raise an UnboundVariable error if a variable is not set.

```python
# All the variables must be defined.
expandvars("$VAR1:${VAR2}:$VAR3", nounset=True)

# Raises UnboundVariable error.

```

--------------------------------

### Temporarily Disable Strict Parsing

Source: https://pypi.org/project/expandvars

Explains how to temporarily disable strict parsing for 'nounset=True' and '${VAR:?}' syntax by setting the EXPANDVARS_RECOVER_NULL environment variable. Avoid permanent export.

```bash
EXPANDVARS_RECOVER_NULL=foo myapp --config production.ini && echo "All fine."

```
Tokens:
Raw