Specifica le dipendenze in Python (1ª generazione.)
Esistono due modi per specificare le dipendenze per le funzioni Cloud Run scritte in
Python: utilizzando il file requirements.txt del gestore dei pacchetti pip o impacchettando le dipendenze locali insieme alla funzione.
La specifica delle dipendenze che utilizza lo standard Pipfile/Pipfile.lock non è supportata. Il 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
chiamata
requirements.txt
Questo file deve trovarsi nella stessa directory del file main.py che contiene le tue
della funzione.
Quando esegui il deployment o il nuovo deployment della funzione, le funzioni Cloud Run
utilizzano pip per scaricare e installare la versione più recente delle tue
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 ulteriori dettagli, vedi
requirements.txt
riferimento.
Per evitare che la compilazione venga interessata dalle modifiche alle versioni delle dipendenze, prendi in considerazione la possibilità di bloccare i pacchetti delle dipendenze su una versione specifica.
Di seguito è riportato un file requirements.txt di esempio:
functions-framework requests==2.20.0 numpy
Functions Framework è una dipendenza obbligatoria per tutte le funzioni. Sebbene Cloud Run funzioni lo installi per tuo conto quando viene creata la funzione, ti consigliamo includerla come dipendenza esplicita per maggiore chiarezza.
Se la funzione si basa su dipendenze private, ti consigliamo di
esegui il mirroring di functions-framework nel tuo registro privato. Includi functions-framework sottoposto a mirroring come dipendenza della funzione per evitare di installare il pacchetto dalla rete internet pubblica.
Pacchettizzazione delle dipendenze locali
Puoi anche creare pacchetti e implementare le dipendenze insieme alla funzione. Questo è utile se la dipendenza non è disponibile tramite il pip gestore di pacchetti o se il tuo ambiente Cloud Run Functions l'accesso è limitato.
Ad esempio, puoi utilizzare 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 quanto segue
Dichiarazione import.
# Code in main.py from localpackage import script
Tieni presente che questo approccio non esegue alcun file setup.py. Pacchetti con questi
i file possono ancora essere in bundle, ma potrebbero non essere eseguiti correttamente nelle funzioni di Cloud Run.
Dipendenze del fornitore
Le dipendenze del fornitore sono dipendenze la cui origine è inclusa direttamente nel tuo pacchetto di codice sorgente, e ricreati insieme al tuo codice. Utilizza la variabile di ambiente di compilazione GOOGLE_VENDOR_PIP_DEPENDENCIES per creare dipendenze pip del fornitore ed evitare di installarle durante il deployment.
Crea dipendenze del fornitore
Assicurati che python3 sia installato sul tuo sistema di sviluppo.
Dichiara le dipendenze dell'applicazione in un file
requirements.txtnella directory principale dell'albero di sviluppo.Dichiara il framework di Functions come requisito includendo
functions-frameworksu una riga separata nel filerequirements.txt.Scarica le dipendenze della funzione nella tua 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 è un pacchetto Python (*.whl), scaricala nella directory radice dell'albero di sviluppo con questo comando pip:
python3 -m pip download -r requirements.txt --only-binary=:all: \ -d DIRECTORY \ --python-version PYTHON_RUNTIME_VERSION \ --platform manylinux2014_x86_64 \ --implementation cpSostituisci:
- DIRECTORY: il nome della directory locale in cui eseguire il download
- PYTHON_RUNTIME_VERSION: la versione Python da utilizzare per
e controlli di compatibilità. Ad esempio
311per Python 3.11.
Questa versione deve corrispondere a una delle piattaforme di runtime Python supportate
La struttura di directory risultante dovrebbe essere simile alla 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, utilizza pip per scaricarla:
python3 -m pip download -r requirements.txt \ -d DIRECTORYSe una dipendenza è costituita da codice scritto in C o C++, devi scaricarla e compilarla separatamente.
Esegui il deployment della funzione e delle sue dipendenze fornite dal fornitore:
gcloud functions deploy FUNCTION_NAME \ --runtime PYTHON_RUNTIME_NAME \ --set-build-env-vars GOOGLE_VENDOR_PIP_DEPENDENCIES=DIRECTORYSostituisci:
- FUNCTION_NAME: il nome delle funzioni di Cloud Run funzione di cui esegui il deployment
- PYTHON_RUNTIME_NAME: il nome di uno dei runtime Python supportati in cui eseguire la funzione di cui è stato eseguito il deployment, ad esempio python311. Deve essere la stessa versione del runtime Python che hai utilizzato in dell'ambiente di sviluppo locale.
- DIRECTORY: il nome della directory contenente le dipendenze del fornitore
Per maggiori dettagli sull'uso dei buildpack, vedi Crea una funzione con i buildpack.
Usa dipendenze private
Dipendenze private da Artifact Registry
Un repository Python di Artifact Registry può ospitare dipendenze private per la tua funzione Python. Quando esegui il deployment nelle funzioni Cloud Run, il processo di compilazione genera automaticamente le credenziali di Artifact Registry per l'account di servizio Cloud Build. Devi eseguire
devi includere l'URL di Artifact Registry in requirements.txt senza
generando credenziali aggiuntive. Ad esempio:
--index-url REPOSITORY_URL
sampleapp
Flask==0.10.1
google-cloud-storage
Se la tua build ha bisogno di più repository, utilizza un'istanza Repository virtuale Artifact Registry per controllare in modo sicuro l'ordine con cui pip cerca nei repository.
Dipendenze private da altri repository
Le dipendenze vengono installate in un ambiente Cloud Build che che forniscono l'accesso alle chiavi SSH. I pacchetti ospitati in repository che richiedono l'autenticazione basata su SSH devono essere forniti dal fornitore e caricati insieme al codice del progetto, come descritto nella sezione precedente.
Puoi utilizzare il comando pip install con il
Flag -t DIRECTORY in cui copiare le dipendenze private
una directory locale prima di eseguire il deployment dell'app, come segue:
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 nella tua
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 una serie di pacchetti nell'esecuzione completamente gestito di Google Cloud. Se la tua funzione utilizza una dipendenza che richiede un pacchetto di sistema non elencato, puoi richiedere un pacchetto.