Hinweis: Python 2.7 hat am 31. Januar 2024 das Ende des Supports erreicht. Ihre vorhandenen Python 2.7-Anwendungen werden weiterhin ausgeführt und erhalten Traffic. App Engine kann die erneute Bereitstellung von Anwendungen, die Laufzeiten verwenden, jedoch nach dem Enddatum des Supports blockieren. Wir empfehlen die Migration zur neuesten unterstützten Version von Python.

Funktionen des Moduls "Definition"

Das protorpc.definition-Paket bietet folgende Funktionen:

define_enum(enum_descriptor, module_name)

Definiert eine Enumerationsklasse für eine Beschreibung.

Argumente

enum_descriptor: Beim Erstellen der Enumerationsklasse zu verwendender EnumDescriptor.
module_name: Modulname zur Angabe der neuen Deskriptorklasse.

Gibt wie in enum_descriptor beschrieben eine neue abgeleitete messages.Enum-Klasse zurück.

define_field(field_descriptor)

Definiert eine Feldinstanz aus der angegebenen Beschreibung.

Argumente

field_descriptor: Zum Erstellen der Feldinstanz verwendete FieldDescriptor-Klasse.

Gibt eine neue Feldinstanz wie durch field_descriptor beschrieben zurück.

define_message(message_descriptor, module_name)

Definiert eine Message-Klasse aus der angegebenen Beschreibung.

Argumente

message_descriptor: Zum Beschreiben der Message-Klasse verwendeter MessageDescriptor.
module_name: Modulname zur Angabe der neuen Deskriptorklasse.

Gibt eine neue abgeleitete messages.Message-Klasse gemäß der Beschreibung durch message_descriptor zurück.

define_service(service_descriptor, module)

Definiert einen neuen Dienstproxy.

Argumente

service_descriptor: ServiceDescriptor-Klasse, die den Dienst beschreibt.
module: Das Modul, zu dem der Dienst hinzugefügt werden soll. Anforderungs- und Antworttypen werden relativ zu diesem Modul ermittelt.

Gibt einen Klassenproxy aus, der mit einem Remote-Server kommunizieren kann.

define_file(file_descriptor, module=None)

Definiert ein Modul aus der angegebenen Dateibeschreibung.

Argumente

file_descriptor: FileDescriptor-Instanz, aus der das Modul beschrieben wird.
module=None: Modul, dem enthaltene Objekte hinzugefügt werden sollen. Der Modulname überschreibt den Wert in "file_descriptor.package". Definitionen werden dem vorhandenen Modul hinzugefügt, falls dies angegeben wurde.

Wenn kein Modul bereitgestellt wurde, wird ein neues Modul mit dem Namen des Pakets der Dateibeschreibung erstellt. Falls ein Modul angegeben wurde, wird dieses Modul zurückgegeben.

Hilfsfunktionen

import_file(file_descriptor, modules=None)

Importiert einen FileDescriptor in einen Modulbereich. Ähnlich wie define_file(), nur mit dem Unterschied, dass ein neues Modul und alle erforderlichen übergeordneten Module erstellt und dem "modules"-Parameter hinzugefügt werden – oder "sys.modules", falls nicht angegeben.

Argumente

file_descriptor: FileDescriptor-Instanz, aus der das Modul beschrieben wird.
modulesmodules=None: Wörterbuch der zu aktualisierenden Module. Module und fehlende übergeordnete Elemente werden erstellt. Wird ein vorhandenes Modul gefunden, das dem file_descriptor.package entspricht, wird dieses Modul mit den FileDescriptor-Inhalten aktualisiert.

Gibt Übereinstimmungen für das modules-Argument oder ein neues Modul zurück, falls keine Übereinstimmungen gefunden wurden.

import_file_set(file_set, modules=None)

Argumente

file_set: Entweder ein String oder eine FileSet-Instanz. Bei einem String wird die Datei mit "import_file_set()" geöffnet und das serialisierte FileSet gelesen. Bei einer FileSet-Instanz werden Definitionen aus dieser Instanz importiert.
modules: Wörterbuch der zu aktualisierenden Module. Module und fehlende übergeordnete Elemente werden erstellt. Wird ein vorhandenes Modul gefunden, das dem file_descriptor.package entspricht, wird dieses Modul mit den FileDescriptor-Inhalten aktualisiert.