Specifica le dipendenze in Python
Esistono due modi per specificare le dipendenze per le funzioni Cloud Functions scritte in Python: utilizzando il file requirements.txt del gestore di pacchetti pip o pacchettizzando le dipendenze locali insieme alla funzione.
La specifica delle dipendenze mediante lo standard Pipfile/Pipfile.lock non è supportata. Il tuo progetto non deve includere questi file.
Specificare le dipendenze con pip
Le dipendenze in Python sono gestite con pip ed espresse in un file di metadati chiamato requirements.txt.
Questo file deve trovarsi nella stessa directory del file main.py che contiene il codice della funzione.
Quando esegui o riesegui il deployment della funzione, Cloud Functions utilizza pip per scaricare e installare la versione più recente delle dipendenze, come dichiarato nel file requirements.txt.
Il file requirements.txt contiene una riga per pacchetto. Ogni riga contiene il nome del pacchetto e, facoltativamente, la versione richiesta. Per maggiori dettagli, consulta il riferimento di requirements.txt.
Per evitare che la build sia interessata dalle modifiche alla versione delle dipendenze, valuta la possibilità di bloccare i pacchetti di dipendenze a una versione specifica.
Di seguito è riportato un esempio di file requirements.txt:
functions-framework requests==2.20.0 numpy
Il framework delle funzioni è una dipendenza obbligatoria per tutte le funzioni. Anche se Cloud Functions la installa per tuo conto al momento della creazione della funzione, ti consigliamo di includerla come dipendenza esplicita per maggiore chiarezza.
Se la tua funzione si basa su dipendenze private, ti consigliamo di eseguire il mirroring di functions-framework nel registro privato. Includi functions-framework con mirroring come dipendenza dalla funzione per evitare di installare il pacchetto dalla rete internet pubblica.
Pacchettizzazione delle dipendenze locali
Puoi anche pacchettizzare le dipendenze ed eseguirne il deployment insieme alla funzione. Questo approccio è utile se la dipendenza non è disponibile tramite il gestore di pacchetti pip o se l'accesso a internet dell'ambiente Cloud Functions è limitato.
Puoi usare una struttura di directory come la seguente:
myfunction/
├── main.py
└── localpackage/
├── __init__.py
└── script.py
Puoi quindi importare il codice come di consueto da localpackage utilizzando la seguente
istruzione import.
# Code in main.py from localpackage import script
Tieni presente che questo approccio non eseguirà file setup.py. I pacchetti con questi file possono comunque essere in bundle, ma potrebbero non essere eseguiti correttamente su Cloud Functions.
Dipendenze fornite dal fornitore
Le dipendenze fornite dal fornitore sono dipendenze la cui origine è inclusa direttamente nel pacchetto di codice sorgente e ricreate insieme al tuo codice. Utilizza la variabile di ambiente di build GOOGLE_VENDOR_PIP_DEPENDENCIES per creare dipendenze pip fornite dal fornitore ed evitare di installarle durante il deployment.
Crea dipendenze fornite dal fornitore
Assicurati che python3 sia installato sul tuo sistema di sviluppo.
Dichiara le dipendenze delle applicazioni in un file
requirements.txtnella directory radice della struttura di sviluppo.Dichiara il framework delle funzioni come requisito includendo
functions-frameworkin una riga separata nel filerequirements.txt.Scarica le dipendenze della funzione nella directory locale. I passaggi per eseguire questa operazione dipendono dal fatto che la dipendenza sia un file wheel Python (*.whl) o un file tar (*.tar.gz).
Se la dipendenza è una wheel Python (*.whl), scaricala nella directory radice del tuo albero di sviluppo con questo comando pip:
python3 -m pip download -r requirements.txt --only-binary=:all: \ -d DIRECTORY \ --python-version PYTHON_RUNTIME_NAME \ --platform manylinux2014_x86_64 \ --implementation cpSostituisci:
- DIRECTORY: il nome della directory locale in cui scaricare
- PYTHON_RUNTIME_NAME: la versione Python da utilizzare per i controlli di compatibilità
La struttura di directory risultante dovrebbe avere l'aspetto seguente:
myfunction/ ├── main.py └── requirements.txt └── DIRECTORY ├── dependency1.whl └── dependency2.whl
Se la dipendenza è un file tar (*.tar.gz):
Se la dipendenza è scritta in Python, usa pip per scaricarla:
python3 -m pip download -r requirements.txt \ -d DIRECTORYSe una dipendenza è composta da codice scritto in C o C++, devi scaricarla e compilarla separatamente.
Esegui il deployment della funzione e delle sue dipendenze fornitori:
gcloud functions deploy FUNCTION_NAME \ --runtime PYTHON_RUNTIME_NAME \ --set-build-env-vars GOOGLE_VENDOR_PIP_DEPENDENCIES=DIRECTORYSostituisci:
- FUNCTION_NAME: il nome della funzione Cloud Functions di cui stai eseguendo il deployment
- PYTHON_RUNTIME_NAME: il nome del runtime Python in cui eseguire la funzione di cui hai eseguito il deployment, ad esempio python311. Deve essere la stessa versione del runtime Python che hai utilizzato nel tuo ambiente di sviluppo locale.
- DIRECTORY:il nome della directory contenente le dipendenze fornite dal fornitore
Per maggiori dettagli sull'uso dei buildpack, consulta Creare una funzione con buildpack.
Utilizzo delle dipendenze private
Dipendenze private da Artifact Registry
Un repository Python
Artifact Registry può ospitare dipendenze private
per la funzione Python. Durante il deployment in Cloud Functions, il processo di compilazione genererà automaticamente le credenziali Artifact Registry per l'account di servizio Cloud Build. Devi solo includere l'URL Artifact Registry in requirements.txt senza generare ulteriori credenziali. Ad esempio:
--index-url REPOSITORY_URL
sampleapp
Flask==0.10.1
google-cloud-storage
Se la tua build ha bisogno di più repository, usa un repository virtuale di Artifact Registry per controllare in sicurezza l'ordine con cui pip effettua le ricerche nei repository.
Dipendenze private da altri repository
Le dipendenze vengono installate in un ambiente Cloud Build che non fornisce l'accesso alle chiavi SSH. I pacchetti ospitati in repository che richiedono l'autenticazione basata su SSH devono essere forniti tramite fornitore e caricati insieme al codice del progetto, come descritto nella sezione precedente.
Puoi utilizzare il comando pip install con il flag -t DIRECTORY per copiare le dipendenze private in una directory locale prima di eseguire il deployment dell'app, come indicato di seguito:
Copia la dipendenza in una directory locale:
pip install -t DIRECTORY DEPENDENCY
Aggiungi un file
__init__.pyvuoto alla directoryDIRECTORYper trasformarlo in un modulo.Importa da questo modulo per utilizzare la dipendenza:
import DIRECTORY.DEPENDENCY
Pacchetti preinstallati
I seguenti pacchetti Python vengono installati automaticamente insieme alla funzione durante il deployment. Se utilizzi uno di questi pacchetti nel codice della funzione, ti consigliamo di includere le seguenti versioni nel file requirements.txt:
Python 3.7
Python 3.8 e versioni successive
* `pip` (latest version)
* `setuptools` (latest version)
* `wheel` (determined by product requirements)
Inoltre, il runtime Python include un numero di pacchetti di sistema nell'ambiente di esecuzione. Se la funzione utilizza una dipendenza che richiede un pacchetto di sistema non in elenco, puoi richiedere un pacchetto.