Remarque : Python 2.7 n'est plus compatible à partir du 31 janvier 2024. Vos applications Python 2.7 existantes continueront à fonctionner et à recevoir du trafic. Toutefois, App Engine peut bloquer le redéploiement des applications qui utilisent des environnements d'exécution après leur date de fin de compatibilité. Nous vous recommandons de migrer vers la dernière version compatible de Python.

Fonctions du module de définition

Le package protorpc.definition comprend les fonctions suivantes :

define_enum(enum_descriptor, module_name)

Définit une classe Enum pour un descripteur.

Arguments

enum_descriptor: EnumDescriptor à utiliser pour créer la classe Enum.
module_name: Nom du module pour la nouvelle classe du descripteur.

Renvoie une nouvelle sous-classe messages.Enum, telle que décrite par enum_descriptor.

define_field(field_descriptor)

Définit une instance Field depuis le descripteur fourni.

Arguments

field_descriptor: La classe FieldDescriptor permet de créer l'instance de champ.

Renvoie une nouvelle instance Field comme décrit par field_descriptor.

define_message(message_descriptor, module_name)

Définit une classe Message depuis le descripteur fourni.

Arguments

message_descriptor: MessageDescriptor à utiliser pour décrire la classe Message.
module_name: Nom du module pour la nouvelle classe du descripteur.

Renvoie une nouvelle sous-classe messages.Message, telle que décrite par message_descriptor.

define_service(service_descriptor, module)

Définit un nouveau proxy de service.

Arguments

service_descriptor: Classe ServiceDescriptor qui décrit le service.
module: Module auquel ajouter le service. Les types de requêtes et de réponses sont recherchés par rapport à ce module.

Renvoie un proxy de classe capable de communiquer avec un serveur distant.

define_file(file_descriptor, module=None)

Définit un module depuis un descripteur de fichier donné.

Arguments

file_descriptor: Instance FileDescriptor à partir de laquelle décrire le module.
module=None: Module auquel ajouter les objets contenus. Le nom du module remplace la valeur de file_descriptor.package. Des définitions sont ajoutées au module existant, le cas échéant.

Si aucun module n'est fourni, crée un module dont le nom est défini sur le package du descripteur de fichier. Si un module est fourni, renvoie le même module.

Fonctions de l'utilitaire

import_file(file_descriptor, modules=None)

Importe une instance FileDescriptor dans l'espace d'un module. Identique à define_file(), à la différence qu'un module et tous les modules parents requis sont créés et ajoutés au paramètre des modules ou à sys.modules si non fourni.

Arguments

file_descriptor: Instance FileDescriptor à partir de laquelle décrire le module.
modulesmodules=None: Dictionnaire de modules à mettre à jour. Les modules et leurs parents qui n'existent pas seront créés. Si un module existant qui correspond à file_descriptor.package est trouvé, il est mis à jour avec le contenu FileDescriptor.

Renvoie les correspondances à l'argument modules ou un nouveau module s'il n'y a aucune correspondance.

import_file_set(file_set, modules=None)

Arguments

file_set: Soit une chaîne, soit une instance FileSet. S'il s'agit d'une chaîne, import_file_set() ouvre le fichier et lit l'instance FileSet sérialisée. S'il s'agit d'une instance FileSet, importe les définitions depuis cette instance.
modules: Dictionnaire de modules à mettre à jour. Les modules et leurs parents qui n'existent pas seront créés. Si un module existant qui correspond à file_descriptor.package est trouvé, il est mis à jour avec le contenu FileDescriptor.