Menetapkan dependensi di Python

Ada dua cara untuk menentukan dependensi untuk fungsi Cloud Run yang ditulis dalam Python: menggunakan file requirements.txt pengelola paket pip atau memaketkan dependensi lokal dengan fungsi Anda.

Spesifikasi dependensi yang menggunakan standar Pipfile/Pipfile.lock tidak didukung. Project Anda tidak boleh menyertakan file ini.

Functions Framework adalah dependensi wajib untuk semua fungsi. Meskipun Cloud Run menginstalnya untuk Anda saat fungsi dibuat, sebaiknya sertakan sebagai dependensi eksplisit.

Menentukan dependensi dengan pip

Dependensi pada Python dikelola dengan pip dan dinyatakan dalam file metadata yang disebut requirements.txt. File ini harus berada di direktori yang sama dengan file main.py yang berisi kode fungsi Anda.

Saat Anda men-deploy atau men-deploy ulang fungsi, Cloud Run menggunakan pip untuk mendownload dan menginstal versi terbaru dependensi Anda, seperti yang dideklarasikan dalam file requirements.txt. File requirements.txt berisi satu baris per paket. Setiap baris berisi nama paket, dan secara opsional, versi yang diminta. Untuk detail selengkapnya, lihat requirements.txt referensi.

Agar build Anda tidak terpengaruh oleh perubahan versi dependensi, pertimbangkan untuk memasang pin pada paket dependensi ke versi tertentu.

Berikut adalah contoh file requirements.txt:

functions-framework
requests==2.20.0
numpy

Mengemas dependensi lokal

Anda juga dapat mengemas dan men-deploy dependensi bersama fungsi Anda. Pendekatan ini berguna jika dependensi Anda tidak tersedia menggunakan pengelola paket pip atau jika akses internet lingkungan Cloud Run Anda dibatasi.

Misalnya, Anda dapat menggunakan struktur direktori seperti berikut:

myfunction/
├── main.py
└── localpackage/
    ├── __init__.py
    └── script.py

Kemudian, Anda dapat mengimpor kode seperti biasa dari localpackage menggunakan pernyataan import berikut.

# Code in main.py
from localpackage import script

Perhatikan bahwa pendekatan ini tidak akan menjalankan file setup.py apa pun. Paket yang berisi file tersebut masih dapat dipaketkan, tetapi mungkin tidak berjalan dengan benar di fungsi Cloud Run.

Dependensi yang disalin

Dependensi yang disalin adalah dependensi yang sumbernya disertakan langsung dalam paket kode sumber Anda dan di-build ulang bersama kode Anda sendiri. Gunakan variabel lingkungan build GOOGLE_VENDOR_PIP_DEPENDENCIES untuk membuat dependensi pip yang disalin dan hindari menginstalnya selama deployment.

Membuat dependensi yang disalin

  1. Pastikan python3 diinstal di sistem pengembangan Anda.

  2. Deklarasikan dependensi aplikasi Anda dalam file requirements.txt di direktori utama hierarki pengembangan Anda.

  3. Deklarasikan Framework Fungsi sebagai persyaratan dengan menyertakan functions-framework di baris terpisah dalam file requirements.txt Anda.

  4. Download dependensi fungsi Anda ke direktori lokal. Langkah-langkah untuk melakukannya bergantung pada apakah dependensi tersebut adalah file roda Python (*.whl) atau file tar (*.tar.gz).

    1. Jika dependensi adalah wheel Python (*.whl), download ke direktori root hierarki pengembangan Anda dengan perintah pip ini:

      python3 -m pip download -r requirements.txt --only-binary=:all: \
   -d DIRECTORY \
   --python-version PYTHON_RUNTIME_VERSION \
   --platform manylinux2014_x86_64 \
   --implementation cp

      Ganti:

      • DIRECTORY: nama direktori lokal tempat file akan didownload.
      • PYTHON_RUNTIME_VERSION: versi Python yang akan digunakan untuk pemeriksaan kompatibilitas. Misalnya, 311 untuk Python 3.11.
        Versi ini harus cocok dengan salah satu runtime Python yang didukung.

      Struktur direktori yang dihasilkan akan terlihat seperti ini:

      myfunction/
├── main.py
└── requirements.txt
└── DIRECTORY
   ├── dependency1.whl
   └── dependency2.whl

    2. Jika dependensi adalah file tar (*.tar.gz):

      1. Jika dependensi ditulis dalam Python, gunakan pip untuk mendownloadnya:

        python3 -m pip download -r requirements.txt \
   -d DIRECTORY

      2. Jika dependensi terdiri dari kode yang ditulis dalam C atau C++, Anda harus mendownload dan mengompilasi secara terpisah.

  5. Deploy fungsi dan dependensi yang disalin:

    gcloud functions deploy FUNCTION_NAME \
  --runtime PYTHON_RUNTIME_NAME \
  --set-build-env-vars GOOGLE_VENDOR_PIP_DEPENDENCIES=DIRECTORY

    Ganti:

    • FUNCTION_NAME: nama fungsi Cloud Run yang Anda deploy.
    • PYTHON_RUNTIME_NAME: nama salah satu runtime Python yang didukung untuk menjalankan fungsi yang di-deploy, misalnya python311. Versi ini harus sama dengan versi runtime Python yang Anda gunakan di lingkungan pengembangan lokal.
    • DIRECTORY: nama direktori yang berisi dependensi yang Anda salin.

Untuk mengetahui detail selengkapnya tentang penggunaan buildpack, lihat Mem-build fungsi dengan buildpack.

Menggunakan dependensi pribadi

Anda dapat menggunakan dependensi pribadi dari Artifact Registry atau dari repositori lain.

Dependensi pribadi dari Artifact Registry

Repositori Python Artifact Registry dapat menghosting dependensi pribadi untuk fungsi Python Anda. Saat melakukan deployment ke Cloud Run, proses build akan otomatis menghasilkan kredensial Artifact Registry untuk akun layanan Cloud Build. Anda hanya perlu menyertakan URL Artifact Registry di requirements.txt tanpa membuat kredensial tambahan. Contoh:

--index-url REPOSITORY_URL
sampleapp
Flask==0.10.1
google-cloud-storage

Jika build Anda memerlukan beberapa repositori, gunakan repositori virtual Artifact Registry untuk mengontrol urutan penelusuran pip di repositori Anda dengan aman.

Dependensi pribadi dari repositori lain

Dependensi diinstal di lingkungan Cloud Build yang tidak memberikan akses ke kunci SSH. Paket yang dihosting di repositori yang memerlukan autentikasi berbasis SSH harus disalin dan diupload bersama kode project Anda, seperti yang dijelaskan di bagian sebelumnya.

Anda dapat menggunakan perintah pip install dengan flag -t DIRECTORY untuk menyalin dependensi pribadi ke direktori lokal sebelum men-deploy aplikasi, seperti berikut:

  1. Salin dependensi Anda ke direktori lokal:

    pip install -t DIRECTORY DEPENDENCY

  2. Tambahkan file __init__.py kosong ke direktori DIRECTORY untuk mengubahnya menjadi modul.

  3. Impor dari modul ini untuk menggunakan dependensi Anda:

    import DIRECTORY.DEPENDENCY

Paket yang telah terpasang sebelumnya

Paket Python berikut akan otomatis diinstal bersama fungsi Anda selama deployment. Jika Anda menggunakan salah satu paket ini dalam kode fungsi, sebaiknya sertakan versi berikut dalam file requirements.txt:

Python 3.8 dan yang lebih baru 

click==8.1.7
cloudevents==1.11.0
deprecation==2.1.0
Flask==2.2.5
functions-framework==3.8.1
gunicorn==23.0.0
importlib-metadata==6.7.0
itsdangerous==2.1.2
jinja2==3.1.4
MarkupSafe==2.1.5
packaging==24.0
typing_extensions==4.7.1
watchdog==3.0.0
Werkzeug==2.2.3
zipp==3.15.0

Python 3.7 

aiohttp==3.8.1
aiosignal==1.2.0
async-timeout==4.0.2
attrs==21.4.0
cachetools==4.2.4
certifi==2021.10.8
chardet==4.0.0
charset-normalizer==2.0.10
click==8.0.3
Flask==2.0.2
frozenlist==1.2.0
google-api-core==2.3.2
google-api-python-client==2.34.0
google-auth==2.3.3
google-auth-httplib2==0.1.0
google-cloud-core==2.2.1
google-cloud-trace==1.5.1
googleapis-common-protos==1.54.0
grpcio==1.43.0
grpcio-status==1.43.0
httplib2==0.20.2
idna==3.3
itsdangerous==2.0.1
Jinja2==3.0.3
MarkupSafe==2.0.1
multidict==5.2.0
opencensus==0.8.0
opencensus-context==0.1.2
packaging==21.3
proto-plus==1.19.8
protobuf==3.19.1
pyasn1==0.4.8
pyasn1-modules==0.2.8
pyparsing==3.0.6
pytz==2021.3
PyYAML==6.0
requests==2.27.1
rsa==4.8
setuptools==60.3.1
six==1.16.0
uritemplate==4.1.1
urllib3==1.26.7
Werkzeug==2.0.2
wrapt==1.13.3
yarl==1.7.2


* `pip` (latest version)
* `setuptools` (latest version)
* `wheel` (determined by product requirements)

Selain itu, runtime Python menyertakan sejumlah paket sistem di lingkungan eksekusi.