Configuración y uso de variables de entorno en Jupyter Notebooks

En este tutorial, aprenderá a usar variables de entorno con Jupyter Notebook. Aprenderemos qué son las variables de entorno y las mejores prácticas para usarlas con Jupyter Notebook.

Puede saltar adelante usando la tabla de contenido y seguir usando el cuaderno jupyter.

¿Qué son las variables de entorno?

Las variables de entorno son valores que pasa al sistema operativo de una computadora o una aplicación en tiempo de ejecución. Estos valores se utilizan para configurar el comportamiento del sistema operativo o aplicaciones como Jupyter Notebook. Los casos de uso típicos son el almacenamiento de configuraciones como rutas de archivos, preferencias de usuario y otras configuraciones.

Él printenv El comando enumera todas sus variables de entorno. Aprenderá acerca de este comando en un minuto. Puede ver fácilmente la ruta de mi directorio de inicio, mi nombre y que estoy ejecutando Ubuntu. ejemplo de variables de entorno printenv

¿Qué es el cuaderno Jupyter?

Jupyter Notebook es una aplicación web de código abierto que permite a los usuarios crear y compartir documentos que contienen código en vivo, ecuaciones, visualizaciones y texto narrativo.

Es una poderosa herramienta para el análisis de datos y la computación científica. Lo uso para la exploración de datos y para la creación de prototipos. trading estrategias.

Tutorial de Python sobre variables de entorno

Antes de abrir el cuaderno Jupyter, aprendamos cómo imprimir las variables actuales usando la terminal, como demostré anteriormente.

Lista de variables de entorno del sistema operativo

Puede enumerar sus variables de entorno existentes usando printenv en un sistema operativo similar a Unix o el comando set en Windows. Salida de impresión

Ahora que cubrimos los conceptos básicos, aprendamos a trabajar con variables de entorno en Jupyter Notebook.

Por lo general, hay dos formas de establecer una variable de entorno usando Python:

Configúralo directamente.

Leer de un archivo.

Configuración y obtención de variables de entorno

Para configurar una variable de entorno en Jupyter Notebook, puede usar Python para configurarla usando el os.environ o usar comandos mágicos. Primero cubramos la función os.environ.

Este os.environ Esta función establece las variables de entorno en el sistema operativo donde se ejecuta el servidor de Jupyter Notebook.

Para establecer la variable de entorno MY_VAR en el valor my_value, ingrese lo siguiente: Usando os.environ para establecer la variable de entorno

Puede usar la función os.getenv para acceder a las variables de entorno. Tomemos la variable MY_VAR que establecimos anteriormente. Si ya importó el sistema operativo, no tiene que volver a hacerlo. Usando os.getenv para obtener la variable de entorno

Ahora cubramos los comandos mágicos. Comandos magicos son comandos especiales integrados en Jupyter Notebook con el prefijo %. Jupyter notebook env y comandos mágicos set_env

Ahora que hemos cubierto cómo configurar y acceder a las variables de entorno en Jupyter Notebook, analicemos los archivos dotenv.

Lectura de variables de entorno Dotenv

Python-dotenv es un paquete que le permite cargar variables de entorno directamente desde un archivo .env. Esto es útil para almacenar información confidencial, como credenciales de bases de datos o claves de API. También es útil para mantener configuraciones de aplicaciones, como entornos de desarrollo o producción.

El archivo .env es un archivo de texto simple que contiene pares clave-valor donde las claves son los nombres de las variables. Puede tener tantas variables como desee. Ejemplo de archivo Python dotenv

Para usar python-dotenv, instale el paquete usando pip. Recuerde anteponer un signo de exclamación si ejecuta el código en Jupyter Notebook. Ejemplo de instalación de la terminal python-dotenv y el cuaderno Júpiter

Después de la instalación, use dotenv para cargar los pares clave-valor del archivo .env en su entorno. python-dotenv cargar y obtener valores

Observe cómo ahora tenemos MY_OTHER_VALUE, ya que no estaba disponible para nosotros.

Uso de variables de entorno para información confidencial

Uno de los casos de uso más comunes es almacenar información confidencial, como claves de API o credenciales de bases de datos. Uso archivos .env para casi todo el código que comparto por razones obvias. Esto me permite separar los datos confidenciales y garantiza que no los comprometo con el código fuente compartido.

Los cinco mejores consejos para usar variables de entorno con Jupyter Notebook

Use nombres descriptivos y únicos para sus variables de entorno para evitar conflictos.

Recuerde que las variables de entorno distinguen entre mayúsculas y minúsculas. Use la especificación XCU de todas las mayúsculas con guiones bajos si quiere hacerlo bien.

Considere almacenar información confidencial en variables de entorno para mantenerlas separadas de su código.

Use el comando printenv o set desde una terminal o anteponiendo un ! cuando esté dentro de Jupyter Notebook para enumerar las variables de entorno.

Use el paquete python-dotenv para administrar las variables de entorno en un archivo .env.

Preguntas frecuentes

¿Cómo puedo enumerar las variables de entorno en Jupyter Notebook?

Utilice el comando mágico %env incorporado o pase los comandos printenv o set al sistema operativo.

¿Por qué Jupyter Notebook no ve mis variables de entorno?

Las razones más comunes son:
1. No están configurados correctamente en su sistema operativo. Verifique la configuración usando printenv o establezca desde una terminal para verificar.
2. El cuaderno no tiene acceso a sus variables de nivel de usuario en su perfil bash. Es posible que deba configurar las variables de entorno a nivel del sistema en /etc/environment o C:\Windows\System32\SystemPropertiesAdvanced.exe
3. Los valores no se pasan correctamente a Jupyter Notebook. Utilizar el %env Magia para diagnosticar.

¿Cómo recargo las variables de entorno en Jupyter Notebook?

Vuelva a cargar cualquier módulo o variable de entorno que haya cambiado usando el %reload_ext autoreload comando mágico.