Skip to content

Environment

Environment variable management and .env file loading.

3 modules

ModuleDescription
Obtener Variable de EntornoObtener el valor de una variable de entorno
Cargar Archivo .envCargar variables de entorno desde un archivo .env
Establecer Variable de EntornoEstablecer una variable de entorno en el proceso actual

Modules

Obtener Variable de Entorno

env.get

Obtener el valor de una variable de entorno

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-Nombre de la variable de entorno
defaultstringNo-Valor predeterminado si la variable no está establecida

Output:

FieldTypeDescription
namestringNombre de la variable
valuestringValor de la variable (o predeterminado si no está establecida)
existsbooleanSi la variable existe en el entorno

Example: Get HOME variable

yaml
name: HOME

Example: Get variable with default

yaml
name: MY_APP_PORT
default: 8080

Cargar Archivo .env

env.load_dotenv

Cargar variables de entorno desde un archivo .env

Parameters:

NameTypeRequiredDefaultDescription
pathstringYes.envRuta al archivo .env
overridebooleanNoFalseSi se deben sobrescribir las variables de entorno existentes

Output:

FieldTypeDescription
loaded_countnumberNúmero de variables cargadas
variablesarrayLista de nombres de variables que se cargaron

Example: Load .env file

yaml
path: .env
override: false

Establecer Variable de Entorno

env.set

Establecer una variable de entorno en el proceso actual

Parameters:

NameTypeRequiredDefaultDescription
namestringYes-Nombre de la variable de entorno a establecer
valuestringYes-Valor a asignar a la variable de entorno

Output:

FieldTypeDescription
namestringNombre de la variable
valuestringNuevo valor que se estableció
previous_valuestringValor anterior (nulo si no estaba establecido previamente)

Example: Set an environment variable

yaml
name: MY_APP_PORT
value: 3000

Released under the Apache 2.0 License.