Skip to content

Environment

Environment variable management and .env file loading.

3 modules

ModuleDescription
Obtenir la variable d'environnementObtenir la valeur d'une variable d'environnement
Charger le fichier .envCharger les variables d'environnement depuis un fichier .env
Définir la variable d'environnementDéfinir une variable d'environnement dans le processus actuel

Modules

Obtenir la variable d'environnement

env.get

Obtenir la valeur d'une variable d'environnement

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-Nom de la variable d'environnement
defaultstringNo-Valeur par défaut si la variable n'est pas définie

Output:

FieldTypeDescription
namestringNom de la variable
valuestringValeur de la variable (ou par défaut si non définie)
existsbooleanSi la variable existe dans l'environnement

Example: Get HOME variable

yaml
name: HOME

Example: Get variable with default

yaml
name: MY_APP_PORT
default: 8080

Charger le fichier .env

env.load_dotenv

Charger les variables d'environnement depuis un fichier .env

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes.envChemin vers le fichier .env
overridebooleanNoFalseSi les variables d'environnement existantes doivent être remplacées

Output:

FieldTypeDescription
loaded_countnumberNombre de variables chargées
variablesarrayListe des noms de variables qui ont été chargées

Example: Load .env file

yaml
path: .env
override: false

Définir la variable d'environnement

env.set

Définir une variable d'environnement dans le processus actuel

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-Nom de la variable d'environnement à définir
valuestringYes-Valeur à attribuer à la variable d'environnement

Output:

FieldTypeDescription
namestringNom de la variable
valuestringNouvelle valeur qui a été définie
previous_valuestringValeur précédente (nulle si non définie auparavant)

Example: Set an environment variable

yaml
name: MY_APP_PORT
value: 3000

Released under the Apache 2.0 License.