readables-py

Enhance code readability and self-documentation in our Python code

---

Distributed Lock

Note

Check out the dedicated documentation.

---

Environment Variable Manager and Exporter

Declare and retrieve variables

Here is how you can declare and retrieve variables.

# file: your_app/constants.py
from readables.env import required_env, optional_env, flag

ALPHA = required_env('ALPHA', help='Alpha variable')
BETA = optional_env('BETA', 'default_value', help='Beta variable')
CHARLIE = flag('CHARLIE', help='Charlie flag')

Tip

When required_env is used, if the variable is not set, it will raise an exception.

Export variables

We have provided two exporters: the env file exporter and the MarkDown exporter. If you are working on the code that the required environment variables have not been set, you will need to set READABLES_ENV_ALLOW_UNSET_REQUIRED to true before using an exporter to suppress the error.

In this example, we use the env file exporter to generate the content of the distributed env file using the content above.

# file: scripts/gen_dist_env.py
from os import environ

environ['READABLES_ENV_ALLOW_UNSET_REQUIRED'] = 'true'

# noinspection PyUnresolvedReferences
from your_app import constants
from readables.env import manager, EnvFileExporter

output = EnvFileExporter.export(manager.variables)

Note

An exporter does not know how to scan the code. So, you need to find the way to ensure that the manager knows the declared variables. In this example, it imports any references to the "static" variables.