Catatan: Python 2.7 telah mencapai akhir dukungan pada 31 Januari 2024. Aplikasi Python 2.7 Anda yang sudah ada akan terus berjalan dan menerima traffic. Namun, App Engine mungkin memblokir deployment ulang aplikasi yang menggunakan runtime setelah akhir tanggal dukungannya. Sebaiknya migrasikan ke Python versi terbaru yang didukung.

Fungsi Modul Definisi

Paket protorpc.definition menyediakan fungsi berikut:

define_enum(enum_descriptor, module_name)

Menentukan class Enum untuk deskripsi.

Argumen

enum_descriptor: EnumDescriptor yang akan digunakan untuk membangun class Enum.
module_name: Nama modul untuk memberikan class deskripsi baru.

Menampilkan subclass messages.Enum baru seperti yang dijelaskan oleh enum_descriptor.

define_field(field_descriptor)

Menentukan instance Kolom dari deskripsi yang diberikan.

Argumen

field_descriptor: Class FieldDescriptor yang akan digunakan untuk membangun instance Kolom.

Menampilkan instance kolom baru seperti yang dijelaskan oleh field_descriptor.

define_message(message_descriptor, module_name)

Menentukan class Pesan dari deskripsi yang diberikan.

Argumen

message_descriptor: MessageDescriptor yang akan digunakan untuk mendeskripsikan class pesan.
module_name: Nama modul yang akan diberikan class deskriptor baru.

Menampilkan messages.Message sub-class seperti yang dijelaskan oleh message_descriptor.

define_service(service_descriptor, modul)

Menentukan proxy layanan baru.

Argumen

service_descriptor: Class ServiceDescriptor yang mendeskripsikan layanan.
modul: Modul tempat menambahkan layanan. Jenis permintaan dan respons dibandingkan dengan modul ini.

Menampilkan proxy class yang mampu berkomunikasi dengan server jarak jauh.

define_file(file_descriptor, module=None)

Menentukan modul dari deskriptor file yang diberikan.

Argumen

file_descriptor: Instance FileDescriptor yang akan digunakan untuk mendeskripsikan modul.
module=None: Modul tempat untuk menambahkan objek yang ditampung. Nama modul mengganti nilai dalam file_descriptor.package. Definisi ditambahkan ke modul yang sudah ada jika disediakan.

Jika tidak ada modul yang disediakan, buat modul baru dengan nama yang ditetapkan ke paket deskriptor file. Jika modul disediakan, modul yang sama akan ditampilkan.

Fungsi Utilitas

import_file(file_descriptor, modules=None)

Mengimpor FileDescriptor ke ruang modul. Mirip dengan define_file(), kecuali bahwa modul baru dan modul induk yang diperlukan akan dibuat dan ditambahkan ke parameter modul, atau sys.modules jika tidak disediakan.

Argumen

file_descriptor: Instance FileDescriptor yang akan digunakan untuk mendeskripsikan modul.
modulesmodules=None: Kamus modul yang akan diperbarui. Modul dan induknya yang tidak ada akan dibuat. Jika ditemukan modul yang ada dan cocok dengan file_descriptor.package, modul tersebut akan diperbarui dengan konten FileDescriptor.

Menampilkan kecocokan dengan argumen modules, atau modul baru jika tidak ditemukan kecocokan.

import_file_set(file_set, modules=None)

Argumen

file_set: Entah string atau instance FileSet. Jika sebuah string, import_file_set() membuka file dan membaca FileSet yang diserialisasi. Jika instance FileSet, mengimpor definisi dari instance ini.
modul: Kamus modul yang akan diperbarui. Modul dan induknya yang tidak ada akan dibuat. Jika ditemukan modul yang cocok dengan file_descriptor.package, modul tersebut akan diperbarui dengan konten FileDescriptor.