Saltar a contenido

Tutorial

Tutorial para configuration files y log.

Este módulo muestra como usar:

  • El archivo con variables de entorno.
  • El archivo de configuración desde cualquier parte del proyecto.
  • El log desde cualquier módulo del proyecto.

La idea es que el usuario borre este archivo y ajuste el archivo de configuración de prueba una vez esté familiarizado con lo que aquí se muestra.

Author: Alejandro Perez Londoño

my_app()

Usa archivos de configuración y variables de entorno en la aplicación.

  • Lleva al log todas las variables de los archivos .env.public y .env.private
  • Lleva al log todas las variables del archivo de configuración de prueba que está en conf/main.yaml
Source code in src/tutorial.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def my_app() -> None:
    """Usa archivos de configuración y variables de entorno en la aplicación.

    - Lleva al log todas las variables de los archivos .env.public y
        .env.private
    - Lleva al log todas las variables del archivo de configuración de prueba
        que está en conf/main.yaml
    """
    ic.configureOutput(prefix="debug | ")

    # ¿Cómo usar una variable de configuración cargada en los .env?

    ic(configuracion.admin_email)

    log.debug("Variables de Entorno: {}", configuracion)

    # ¿Cómo "logear" algo en cualquier módulo?
    log.debug(
        "Si está usando Python {}, es, por supuesto, preferible {feature}!",
        ">=3.6",
        feature="f-strings",
    )
    log.info("Eso es todo, log fácil!")

    # ¿Cómo agregar más información al log (agregar contexto)?
    log_contextualizado = log.bind(cliente_id="001", producto_id="123")
    log_contextualizado.info("Fácil, log con información adicional")

    # ¿Cómo hacer debugging (imprimir información durante la ejecución)?
    x = 1
    y = 2

    z = x + y

    ic(x)
    ic(z)