Aviso: En los próximos meses, reorganizaremos el sitio de documentación de App Engine para facilitar la búsqueda de contenido y alinearlo mejor con el resto de los productos de Google Cloud. El mismo contenido estará disponible, pero la navegación ahora coincidirá con el resto de los productos de Cloud.

Python 2 ya no es compatible con la comunidad. Recomendamos que migres las apps de Python 2 a Python 3.

Funciones del módulo de definición

El paquete protorpc.definition proporciona las siguientes funciones:

define_enum(enum_descriptor, module_name)

Define una clase Enum para un descriptor.

Argumentos

enum_descriptor: EnumDescriptor para usar en la compilación de una clase Enum.
module_name: Nombre de módulo para asignar a la clase de descriptor nuevo.

Muestra una nueva subclase messages.Enum como se describe en enum_descriptor.

define_field(field_descriptor)

Define una instancia Field desde el descriptor proporcionado.

Argumentos

field_descriptor: La clase FieldDescriptor para usar en la compilación de la instancia Field.

Muestra una instancia de campo nueva como describe field_descriptor.

define_message(message_descriptor, module_name)

Define una clase Message desde el descriptor proporcionado.

Argumentos

message_descriptor: MessageDescriptor para usar en la descripción de la clase message.
module_name: El nombre de módulo para asignar a la clase de descriptor nuevo.

Muestra una nueva subclase messages.Message sub-class como se describe en message_descriptor.

define_service(service_descriptor, module)

Define un proxy de servicio nuevo.

Argumentos

service_descriptor: La clase ServiceDescriptor que describe el servicio.
module: El módulo en el que se agrega el servicio. Los tipos de solicitud y respuesta están relacionados con este módulo.

Muestra un proxy de clase capaz de comunicarse con un servidor remoto.

define_file(file_descriptor, module=None)

Define un módulo desde un descriptor de archivo dado.

Argumentos

file_descriptor: La instancia FileDescriptor desde la que se describe el módulo.
module=None: Los módulos a los que se agregan objetos contenidos. El nombre del módulo anula valores en file_descriptor.package. Las definiciones se agregan al módulo existente si se lo proporciona.

Si no se proporciona un módulo, crea un módulo nuevo con el nombre configurado en el paquete de descriptor del archivo. Si se proporciona un módulo, muestra el mismo módulo.

Funciones de utilidad

import_file(file_descriptor, modules=None)

Importa un FileDescriptor a un espacio de módulo. Es similar a define_file(), salvo que un módulo nuevo y cualquier módulo superior requerido se crean y agregan a los parámetros de módulo, o sys.modules si no se lo proporciona.

Argumentos

file_descriptor: La instancia FileDescriptor desde la que se describe el módulo.
modulesmodules=None: Diccionario de módulos para actualizar. Se crearán módulos y superiores que no existan. Si se encuentra un módulo existente que coincide con file_descriptor.package, ese módulo se actualiza con los contenidos de FileDescriptor.

Muestra coincidencias con el argumento modules o un módulo nuevo si no se encuentran coincidencias.

import_file_set(file_set, modules=None)

Argumentos

file_set: Es una string o una instancia de FileSet. Si es una string, import_file_set() abre el archivo y lee el FileSet serializado. Si es una instancia FileSet, importa definiciones desde esta instancia.
modules: Diccionario de módulos para actualizar. Se crearán módulos y superiores que no existan. Si se encuentra un módulo existente que coincide con file_descriptor.package, ese módulo se actualiza con los contenidos de FileDescriptor.