Especifica dependencias en Python
Existen dos formas de especificar las dependencias para las funciones de Cloud Functions escritas en Python: usar el archivo requirements.txt del administrador de paquetes pip o empaquetar las dependencias locales junto con tu función.
La especificación de dependencias que usa el estándar Pipfile/Pipfile.lock no es compatible. Tu proyecto no debe incluir estos archivos.
Especifica dependencias con pip
Las dependencias en Python se administran con pip y se expresan en un archivo de metadatos llamado requirements.txt.
Este archivo debe estar en el mismo directorio que el archivo main.py que contiene el código de tu función.
Cuando implementas o vuelves a implementar tu función, Cloud Functions usa pip para descargar y, luego, instalar la última versión de tus dependencias como se declara en el archivo requirements.txt.
El archivo requirements.txt contiene una línea por paquete. Cada línea contiene el nombre del paquete y, opcionalmente, la versión solicitada. Para obtener más detalles, consulta la referencia requirements.txt.
Para evitar que tu compilación se vea afectada por los cambios de versión de dependencia, considera fijar tus paquetes de dependencia a una versión específica.
El siguiente es un archivo requirements.txt de ejemplo:
functions-framework requests==2.20.0 numpy
Functions Framework es una dependencia obligatoria para todas las funciones. Aunque Cloud Functions la instala en tu nombre cuando se crea la función, te recomendamos que la incluyas como una dependencia explícita para brindar mayor claridad.
Si tu
función depende de dependencias privadas, te recomendamos que
dupliques functions-framework en tu registro privado. Incluye el functions-framework duplicado
como una dependencia en tu función para evitar la instalación del
paquete desde la Internet pública.
Empaqueta las dependencias locales
Puedes empaquetar y, además, implementar dependencias junto con tu función. Este enfoque es útil si tu dependencia no está disponible a través del administrador de paquetes pip o si el acceso a Internet del entorno de Cloud Functions está restringido.
Por ejemplo, puedes usar una estructura de directorio como la que se muestra a continuación:
myfunction/
├── main.py
└── localpackage/
├── __init__.py
└── script.py
Luego, puedes importar el código como de costumbre desde localpackage con la siguiente declaración import.
# Code in main.py from localpackage import script
Ten en cuenta que este enfoque no ejecutará ningún archivo setup.py. Los paquetes con esos archivos aún se pueden agrupar, pero es posible que no se ejecuten correctamente en Cloud Functions.
Dependencias del proveedor
Las dependencias de vendoring son dependencias cuyos orígenes se incluyen de forma directa en tu paquete de código fuente y que vuelven a compilarse junto con tu propio código. Usa la variable de entorno GOOGLE_VENDOR_PIP_DEPENDENCIES para crear dependencias de pip del proveedor y evitar instalarlas durante la implementación.
Crea dependencias del proveedor
Asegúrate de que python3 esté instalado en tu sistema de desarrollo.
Declara tus dependencias de aplicación en un archivo
requirements.txten el directorio raíz del árbol de desarrollo.Declara Functions Framework como requisito al incluir
functions-frameworken una línea separada en el archivorequirements.txt.Descarga las dependencias de tu función al directorio local. Los pasos para hacerlo dependen de si la dependencia es un archivo de rueda de Python (*.whl) o un archivo tar (*.tar.gz).
Si la dependencia es una rueda de Python (*.whl), descárgala en el directorio raíz de tu árbol de desarrollo con este comando pip:
python3 -m pip download -r requirements.txt --only-binary=:all: \ -d DIRECTORY \ --python-version PYTHON_RUNTIME_NAME \ --platform manylinux2014_x86_64 \ --implementation cpReemplaza lo siguiente:
- DIRECTORY: el nombre del directorio local en el que se descargará.
- PYTHON_RUNTIME_NAME: la versión de Python que se usa para las verificaciones de compatibilidad.
La estructura de directorios resultante debería verse así:
myfunction/ ├── main.py └── requirements.txt └── DIRECTORY ├── dependency1.whl └── dependency2.whl
Si la dependencia es un archivo tar (*.tar.gz):
Si la dependencia está escrita en Python, usa pip para descargarla:
python3 -m pip download -r requirements.txt \ -d DIRECTORYSi una dependencia consiste en código escrito en C o C++, debes descargarlo y compilarlo por separado.
Implementa tu función y sus dependencias de proveedores:
gcloud functions deploy FUNCTION_NAME \ --runtime PYTHON_RUNTIME_NAME \ --set-build-env-vars GOOGLE_VENDOR_PIP_DEPENDENCIES=DIRECTORYReemplaza lo siguiente:
- FUNCTION_NAME: el nombre de la función de Cloud Functions que estás implementando
- PYTHON_RUNTIME_NAME: el nombre del entorno de ejecución de Python en el que se ejecutará la función implementada, por ejemplo, python311. Debe ser la misma versión del entorno de ejecución de Python que usaste en tu entorno de desarrollo local.
- DIRECTORY: el nombre del directorio que contiene las dependencias de destino
Para obtener más detalles sobre cómo se usan los paquetes de compilación, consulta Compila una función con paquetes de compilación.
Usa dependencias privadas
Dependencias privadas de Artifact Registry
Un repositorio de Python de Artifact Registry puede alojar dependencias privadas para tu función de Python. Cuando se implementa en Cloud Functions, el proceso de compilación generará de forma automática las credenciales de Artifact Registry para la cuenta de servicio de Cloud Build. Solo debes incluir la URL de Artifact Registry en la requirements.txt sin generar credenciales adicionales. Por ejemplo:
--index-url REPOSITORY_URL
sampleapp
Flask==0.10.1
google-cloud-storage
Si tu compilación necesita varios repositorios, usa un repositorio virtual de Artifact Registry para controlar de forma segura el orden en que pip busca tus repositorios.
Dependencias privadas de otros repositorios
Las dependencias se instalan en un entorno de Cloud Build que no proporciona acceso a las llaves SSH. Los paquetes que se alojan en repositorios que requieren una autenticación basada en SSH se deben copiar y subir junto con el código del proyecto, como se describe en la sección anterior.
Puedes usar el comando pip install con el marcador -t DIRECTORY para copiar las dependencias privadas en un directorio local antes de implementar tu aplicación, de la siguiente manera:
Copia tu dependencia en un directorio local:
pip install -t DIRECTORY DEPENDENCY
Agrega un archivo
__init__.pyvacío al directorioDIRECTORYpara convertirlo en un módulo.Importa desde este módulo para usar tu dependencia:
import DIRECTORY.DEPENDENCY
Paquetes preinstalados
Los siguientes paquetes de Python se instalan automáticamente junto con tu función durante la implementación. Si usas alguno de estos paquetes en el código de tu función, te recomendamos que incluyas las siguientes versiones en el archivo requirements.txt:
Python 3.7
Python 3.8 y versiones posteriores
* `pip` (latest version)
* `setuptools` (latest version)
* `wheel` (determined by product requirements)
Además, el entorno de ejecución de Python incluye una serie de paquetes de sistema en el entorno de ejecución. Si tu función usa una dependencia que requiere un paquete de sistema que no está en la lista, puedes solicitar un paquete.