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.

Module google.appengine.api.modules.modules

Résumé

Expose les méthodes permettant de contrôler les services (modules) et les versions d'une application.

Les services étaient anciennement appelés modules, et les méthodes d'API reflètent toujours ce nom. Pour obtenir plus d'informations et pour obtenir des exemples de code, consultez la page Utiliser l'API Modules.

Contenus

exception google.appengine.api.modules.modules.Errorsource

Bases : exceptions.Exception

Classe de base pour les exceptions dans ce module.

exception google.appengine.api.modules.modules.InvalidModuleErrorsource

Bases : google.appengine.api.modules.modules.Error

Le module donné n'est pas connu du système.

exception google.appengine.api.modules.modules.InvalidVersionErrorsource

Bases : google.appengine.api.modules.modules.Error

La version de module donnée n'est pas connue du système.

exception google.appengine.api.modules.modules.InvalidInstancesErrorsource

Bases : google.appengine.api.modules.modules.Error

La valeur des instances données n'est pas valide.

exception google.appengine.api.modules.modules.UnexpectedStateErrorsource

Bases : google.appengine.api.modules.modules.Error

Un état actuel inattendu a été découvert lors du démarrage/de l'arrêt d'un module.

exception google.appengine.api.modules.modules.TransientErrorsource

Bases : google.appengine.api.modules.modules.Error

Une erreur temporaire s'est produite, réessayez l'opération.

google.appengine.api.modules.modules.get_current_module_name()source

Renvoie le nom de module de l'instance actuelle.

S'il s'agit de la version "v1" du module "module5" pour l'application "my-app", cette fonction renvoie "module5".

google.appengine.api.modules.modules.get_current_version_name()source

Renvoie la version de l'instance actuelle.

S'il s'agit de la version "v1" du module "module5" pour l'application "my-app", cette fonction renvoie "v1".

google.appengine.api.modules.modules.get_current_instance_id()source

Renvoie l'ID de l'instance actuelle.

S'il s'agit de l'instance 2 de la version "v1" du module "module5" pour l'application "my-app", cette fonction renvoie "2".

Cela n'est valide que pour les modules avec scaling automatique. Sinon, cette fonction renvoie "None".

Renvoie

Chaîne contenant l'ID de l'instance, ou la valeur "None" s'il ne s'agit pas d'un module avec scaling automatique.

google.appengine.api.modules.modules.get_modules()source

Renvoie la liste de tous les modules de l'application.

Renvoie

Liste de chaînes contenant les noms des modules associés à cette: application. Le module "default" est inclus s'il existe, de même que le nom du module associé à l'instance qui appelle cette fonction.

google.appengine.api.modules.modules.get_versions(module=None)source

Renvoie une liste de versions pour un module donné.

Paramètres

module : module pour lequel récupérer la version. Si aucune valeur n'est spécifiée, le module actuel est utilisé.

Renvoie

Liste de chaînes contenant les noms des versions associées au module. La version actuelle sera également incluse dans cette liste.

Génère

InvalidModuleError si le module donné n'est pas valide, TransientError en cas de
problème pour récupérer les informations.

google.appengine.api.modules.modules.get_default_version(module=None)source

Renvoie le nom de la version par défaut du module.

Paramètres

module : module pour lequel récupérer la version par défaut. Si la valeur est "None", le module actuel est utilisé.

Renvoie

Chaîne contenant le nom de la version par défaut du module.

Génère

InvalidModuleError si le module donné n'est pas valide, InvalidInvalidError si
aucune version par défaut n'a été trouvée.

google.appengine.api.modules.modules.get_num_instances(module=None, version=None)source

Affiche le nombre d'instances définies pour la version de module donnée.

Cela n'est valide que pour les modules fixes. Une erreur est générée pour les modules avec scaling automatique. La compatibilité des modules avec scaling automatique pourrait être ajoutée ultérieurement.

Paramètres

module : chaîne contenant le nom du module pour lequel les informations sont extraites. Si la valeur est "None", le module de l'instance actuelle sera utilisé.
version : chaîne contenant le nom de la version pour laquelle les informations sont récupérées. Si la valeur est "None", la version de l'instance actuelle sera utilisée. Si cette version n'existe pas dans l'autre module, une erreur InvalidVersionError est générée.

Renvoie

Le nombre d'instances définies pour la version de module donnée.

Génère

InvalidVersionError en cas d'entrée non valide.

google.appengine.api.modules.modules.set_num_instances(instances, module=None, version=None)source

Définit le nombre d'instances du module et de la version.

Paramètres

instances : le nombre d'instances à définir.
module : module pour lequel définir le nombre d'instances. Si la valeur est "None", le module actuel est utilisé.
version : la version définit le nombre d'instances pour lesquelles la version actuelle sera utilisée si la valeur est "None".

Génère

InvalidVersionError si la version de module donnée n'est pas valide, TransientError
en cas d'erreur persistant en dépit du changement.
TypeError si le type d'instance donné n'est pas valide.

google.appengine.api.modules.modules.set_num_instances_async(instances, module=None, version=None)source

Renvoie un objet UserRPC pour définir le nombre d'instances sur la version du module.

Paramètres

instances : le nombre d'instances à définir.
module : module pour lequel définir le nombre d'instances. Si la valeur est "None", le module actuel est utilisé.
version : la version définit le nombre d'instances pour lesquelles la version actuelle sera utilisée si la valeur est "None".

Renvoie

Renvoie un objet UserRPC pour définir le nombre d'instances sur la version du module.

google.appengine.api.modules.modules.start_version(module, version)source

Démarrer toutes les instances de la version donnée du module.

Paramètres

module : chaîne contenant le nom du module à affecter.
version : chaîne contenant le nom de la version du module à démarrer.

Génère

InvalidVersionError si la version de module indiquée n'est pas valide.
TransientError en cas d'erreur persistant en dépit du changement.

google.appengine.api.modules.modules.start_version_async(module, version)source

Renvoie un objet UserRPC pour démarrer toutes les instances de la version de module donnée.

Paramètres

module : chaîne contenant le nom du module à affecter.
version : chaîne contenant le nom de la version du module à démarrer.

Renvoie

Renvoie un objet UserRPC pour démarrer toutes les instances de la version de module donnée.

google.appengine.api.modules.modules.stop_version(module=None, version=None)source

Arrête toutes les instances de la version indiquée du module.

Paramètres

module : module à affecter. Si la valeur est "None", le module actuel est utilisé.
version : version du module donné à affecter. Si la valeur est "None", la version actuelle est utilisée.

Génère

InvalidVersionError si la version de module indiquée n'est pas valide.
TransientError en cas d'erreur persistant en dépit du changement.

google.appengine.api.modules.modules.stop_version_async(module=None, version=None)source

Renvoie un objet UserRPC pour arrêter toutes les instances de la version de module donnée.

Paramètres

module : module à affecter. Si la valeur est "None", le module actuel est utilisé.
version : version du module donné à affecter. Si la valeur est "None", la version actuelle est utilisée.

Renvoie

Renvoie un objet UserRPC pour arrêter toutes les instances de la version de module donnée.

google.appengine.api.modules.modules.get_hostname(module=None, version=None, instance=None)source

Renvoie un nom d'hôte à utiliser pour contacter le module.

Paramètres

module : nom du module. Si la valeur est "None", prend le module de l'instance actuelle.
version : nom de la version. Si la version est "None", utilise la version de l'instance actuelle, si cette version existe pour le module cible. Sinon, utilise la version par défaut du module cible.
instance : instance pour laquelle créer un nom d'hôte. Si la valeur d'instance est "None", renvoie un nom d'hôte avec équilibrage de charge pour le module. Si le module cible n'est pas un module fixe, l'instance n'est pas considérée comme valide.

Renvoie

Un nom d'hôte canonique valide pouvant être utilisé pour communiquer avec le module, la version et l'instance donnés. Par exemple : 0.v1.module5.myapp.appspot.com

Génère

InvalidModuleError : si la version de module indiquée n'est pas valide.
InvalidInstancesError : si la valeur d'instance donnée n'est pas valide.
TypeError : si le type d'instance donné n'est pas valide.