Especificar dependencias en Python (1.ª gen.)
Hay dos formas de especificar las dependencias de las funciones de Cloud Run escritas en Python: mediante el archivo requirements.txt del gestor de paquetes pip o empaquetando las dependencias locales junto con la función.
No se admite la especificación de dependencias mediante el estándar Pipfile/Pipfile.lock. Tu proyecto no debe incluir estos archivos.
Especificar dependencias con pip
Las dependencias de Python se gestionan 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 la función.
Cuando despliegues o vuelvas a desplegar tu función, Cloud Run Functions usará pip para descargar e instalar la versión más reciente de tus dependencias, tal 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 información, consulta la referencia de requirements.txt.
Para evitar que la compilación se vea afectada por los cambios en la versión de las dependencias, te recomendamos que fijes los paquetes de dependencias a una versión específica.
A continuación, se muestra un ejemplo de archivo requirements.txt:
functions-framework requests==2.20.0 numpy
El Functions Framework es una dependencia obligatoria para todas las funciones. Aunque Cloud Run Functions lo instala en tu nombre cuando se crea la función, te recomendamos que lo incluyas como dependencia explícita para mayor claridad.
Si tu función depende de dependencias privadas, te recomendamos que hagas una réplica de functions-framework en tu registro privado. Incluye functions-framework como dependencia de tu función para evitar instalar el paquete desde Internet.
Empaquetar dependencias locales
También puedes empaquetar e implementar dependencias junto con tu función. Este método es útil si tu dependencia no está disponible a través del gestor de paquetes pip o si el acceso a Internet del entorno de tus funciones de Cloud Run está restringido.
Por ejemplo, puedes usar una estructura de directorios como la siguiente:
myfunction/
├── main.py
└── localpackage/
├── __init__.py
└── script.py
A continuación, puedes importar el código como de costumbre desde localpackage con la siguiente instrucción import.
# Code in main.py from localpackage import script
Ten en cuenta que con este método no se ejecutarán archivos setup.py. Los paquetes con esos archivos se pueden seguir empaquetando, pero es posible que no se ejecuten correctamente en las funciones de Cloud Run.
Dependencias de proveedores
Las dependencias de proveedores son dependencias cuyo origen se incluye directamente en tu paquete de código fuente y se recompilan junto con tu propio código. Usa la variable de entorno de compilación GOOGLE_VENDOR_PIP_DEPENDENCIES para crear dependencias de pip de proveedores y evitar instalarlas durante el despliegue.
Crear dependencias de proveedores
Asegúrate de que python3 esté instalado en tu sistema de desarrollo.
Declara las dependencias de tu aplicación en un archivo
requirements.txtdel directorio raíz de tu árbol de desarrollo.Declara Functions Framework como requisito incluyendo
functions-frameworken una línea independiente de tu archivorequirements.txt.Descarga las dependencias de tu función en tu 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 un wheel 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_VERSION \ --platform manylinux2014_x86_64 \ --implementation cpSustituye:
- DIRECTORY: el nombre del directorio local en el que se descargará el archivo
- PYTHON_RUNTIME_VERSION: la versión de Python que se va a usar para las comprobaciones de compatibilidad. Por ejemplo,
311para Python 3.11.
Esta versión debe coincidir con uno de los runtimes de Python compatibles.
La estructura de directorios resultante debería ser similar a esta:
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 consta de código escrito en C o C++, debes descargarla y compilarla por separado.
Despliega tu función y sus dependencias de proveedor:
gcloud functions deploy FUNCTION_NAME \ --runtime PYTHON_RUNTIME_NAME \ --set-build-env-vars GOOGLE_VENDOR_PIP_DEPENDENCIES=DIRECTORYSustituye:
- FUNCTION_NAME: el nombre de la función de Cloud Run Functions que vas a desplegar
- PYTHON_RUNTIME_NAME: el nombre de uno de los runtimes de Python admitidos para ejecutar la función implementada. Por ejemplo, python311. Debe ser la misma versión del tiempo de ejecución de Python que hayas usado en tu entorno de desarrollo local.
- DIRECTORY:el nombre del directorio que contiene tus dependencias de proveedores
Para obtener más información sobre cómo usar paquetes de compilación, consulta Compilar una función con paquetes de compilación.
Usar dependencias privadas
Dependencias privadas de Artifact Registry
Un repositorio de Python de Artifact Registry puede alojar dependencias privadas de tu función de Python. Al desplegar funciones en Cloud Run, el proceso de compilación generará automáticamente credenciales de Artifact Registry para la cuenta de servicio de Cloud Build. Solo tiene que incluir la URL de Artifact Registry en su 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 el que pip busca en tus repositorios.
Dependencias privadas de otros repositorios
Las dependencias se instalan en un entorno de Cloud Build que no proporciona acceso a las claves SSH. Los paquetes alojados en repositorios que requieran autenticación basada en SSH deben incluirse y subirse junto con el código de tu proyecto, tal como se describe en la sección anterior.
Puedes usar el comando pip install con la marca -t DIRECTORY para copiar las dependencias privadas en un directorio local antes de implementar tu aplicación, como se indica a continuación:
Copia la dependencia en un directorio local:
pip install -t DIRECTORY DEPENDENCY
Añade 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 tu 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 tiempo de ejecución de Python incluye varios paquetes del sistema en el entorno de ejecución. Si tu función usa una dependencia que requiere un paquete del sistema que no aparece en la lista, puedes solicitar un paquete.