Módulo google.appengine.api.request_info

Resumo

Permite que os stubs de API acessem a solicitação e o estado do sistema ao processar chamadas.

Determinados stubs de API precisam de acesso a informações sobre a solicitação que acionou a chamada de API (por exemplo, user_service_stub precisa saber o nome do host da solicitação para gerar URLs de continuação) ou o estado do sistema (por exemplo, modules_stub).

Outros stubs (por exemplo, taskqueue_stub, channel_stub) precisam ser capazes de despachar solicitações dentro do sistema.

Uma instância de uma subclasse RequestInfo é passada para os stubs que exigem esses recursos.

Índice

exception google.appengine.api.request_info.BackgroundThreadLimitReachedErrorsource

Bases: google.appengine.api.request_info.Error

A instância atingiu a capacidade de thread de segundo plano.

class google.appengine.api.request_info.Dispatchersource

Bases: object

Fornece informações sobre e despacha solicitações para módulos.

add_async_request(method, relative_url, headers, body, source_ip, module_name=None, version=None, instance_id=None)Fonte

Despacha uma solicitação HTTP de forma assíncrona.

Parâmetros

  • method: uma string contendo o método HTTP da solicitação.

  • relative_url: uma string contendo o caminho e a string de consulta da solicitação.

  • headers: uma lista de tuplas (chave, valor) em que chave e valor são string.

  • body: uma string contendo o corpo da solicitação.

  • source_ip: endereço IP de origem da solicitação.

  • module_name: uma string opcional que contém o nome do módulo que atenderá a essa solicitação. Se não definido, a solicitação será despachada para o módulo padrão.

  • version: uma string opcional que contém a versão para atender a essa solicitação. Se não definido, a solicitação será despachada para a versão padrão.

  • instance_id: uma string opcional que contém o instance_id da instância que atenderá a essa solicitação. Se não definido, a solicitação será despachada de acordo com o balanceamento de carga referente ao módulo e à versão.

add_event(runnable, eta, service=None, event_id=None)Fonte

Adiciona um chamável a ser executado no horário especificado.

Parâmetros

  • runnable: um objeto chamável a chamar no horário especificado.

  • eta: um inteiro contendo o horário em que executar o evento, em segundos, desde a época.

  • service: uma string contendo o nome do serviço que é proprietário desse evento. Precisará ser definido se event_id for definido.

  • event_id: uma string contendo o código do evento. Se definido, poderá ser passado para update_event para alterar o horário em que o evento precisa ser executado.

add_request(method, relative_url, headers, body, source_ip, module_name=None, version=None, instance_id=None)Fonte

Processa uma solicitação HTTP.

Parâmetros

  • method: uma string contendo o método HTTP da solicitação.

  • relative_url: uma string contendo o caminho e a string de consulta da solicitação.

  • headers: uma lista de tuplas (chave, valor) em que chave e valor são string.

  • body: uma string contendo o corpo da solicitação.

  • source_ip: endereço IP de origem da solicitação.

  • module_name: uma string opcional que contém o nome do módulo que atenderá a essa solicitação. Se não definido, a solicitação será despachada para o módulo padrão.

  • version: uma string opcional que contém a versão para atender a essa solicitação. Se não definido, a solicitação será despachada para a versão padrão.

  • instance_id: uma string opcional que contém o instance_id da instância que atenderá a essa solicitação. Se não definido, a solicitação será despachada de acordo com o balanceamento de carga referente ao módulo e à versão.

Retorna

Um ResponseTuple contendo as informações de resposta da solicitação HTTP.

get_default_version(module)Fonte

Retorna a versão padrão de um módulo.

Parâmetros

module: uma string contendo o nome do módulo.

Retorna

Uma string contendo a versão padrão do módulo especificado.

Gera

ModuleDoesNotExistError: o módulo não existe.

get_hostname(module, version, instance=None)Fonte

Retorna o nome do host de uma tupla (módulo, versão, instância).

Se instance for definido, isso retornará o nome do host dessas instâncias específicas. Caso contrário, retornará o nome do host para balanceamento de carga.

Parâmetros

  • module: uma string contendo o nome do módulo.

  • version: uma string contendo a versão.

  • instance: uma string opcional contendo o código da instância.

Retorna

Uma string contendo o nome do host.

Gera
get_module_names()Fonte

Retorna uma lista de nomes de módulos.

get_num_instances(module, version)Fonte

Recebe o número de instâncias em execução para uma versão de um módulo.

Parâmetros

  • module: uma string contendo o nome do módulo.

  • version: uma string contendo a versão.

Gera
get_versions(module)Fonte

Retorna uma lista de versões de um módulo.

Parâmetros

module: uma string contendo o nome do módulo.

Retorna

Uma lista de strings contendo as versões do módulo especificado.

Gera

ModuleDoesNotExistError: o módulo não existe.

send_background_request(module_name, version, instance, background_request_id)Fonte

Despacha uma solicitação de thread de segundo plano.

Parâmetros

  • module_name: uma string contendo o nome do módulo que atenderá a essa solicitação.

  • version: uma string contendo a versão que atenderá a essa solicitação.

  • instance: instância que atenderá a essa solicitação.

  • background_request_id: uma string contendo o identificador de solicitação de thread de segundo plano.

Gera
set_num_instances(module, version, instances)Fonte

Define o número de instâncias a serem executadas para uma versão de um módulo.

Parâmetros

  • module: uma string contendo o nome do módulo.

  • version: uma string contendo a versão.

  • instances: um inteiro contendo o número de instâncias a executar.

Gera
start_version(module, version)Fonte

Inicia uma versão.

Parâmetros

  • module: uma string contendo o nome do módulo.

  • version: uma string contendo a versão.

Gera
stop_version(module, version)Fonte

Para uma versão.

Parâmetros

  • module: uma string contendo o nome do módulo.

  • version: uma string contendo a versão.

Gera
update_event(eta, service, event_id)Fonte

Atualiza o eta de um evento planejado.

Parâmetros

  • eta: um inteiro contendo o horário em que executar o evento, em segundos, desde a época.

  • service: uma string contendo o nome do serviço que é proprietário desse evento.

  • event_id: uma string contendo o código do evento a atualizar.

exception google.appengine.api.request_info.Errorsource

Bases: exceptions.Exception

exception google.appengine.api.request_info.InvalidInstanceIdErrorsource

Bases: google.appengine.api.request_info.Error

O código da instância fornecido é inválido.

exception google.appengine.api.request_info.ModuleDoesNotExistErrorsource

Bases: google.appengine.api.request_info.Error

O módulo fornecido não existe.

exception google.appengine.api.request_info.NotSupportedWithAutoScalingErrorsource

Bases: google.appengine.api.request_info.Error

A operação solicitada não é aceita em módulos de escalonamento automático.

class google.appengine.api.request_info.RequestInfosource

Bases: object

Permite que os stubs pesquisem o estado vinculado à solicitação que faz a chamada de API.

get_dispatcher()Fonte

Retorna o agente.

Retorna

Instância do agente.

get_instance(request_id)Fonte

Retorna a instância que disponibiliza essa solicitação.

Parâmetros

request_id: código de string da solicitação que faz a chamada de API.

Retorna

Uma representação opaca da instância que disponibiliza a essa solicitação. Só pode ser passado para métodos de agente que esperam uma instância.

get_module(request_id)Fonte

Retorna o nome do módulo que disponibiliza a essa solicitação.

Parâmetros

request_id: código de string da solicitação que faz a chamada de API.

Retorna

Uma string contendo o nome do módulo.

get_request_environ(request_id)Fonte

Retorna um dicionário contendo o ambiente WSGI da solicitação.

get_request_url(request_id)Fonte

Retorna o URL a solicitação, por exemplo: "http://localhost:8080/foo?bar=baz".

Parâmetros

request_id: código de string da solicitação que faz a chamada de API.

Retorna

URL da solicitação como uma string.

get_version(request_id)Fonte

Retorna a versão do módulo que disponibiliza a essa solicitação.

Parâmetros

request_id: código de string da solicitação que faz a chamada de API.

Retorna

Uma string contendo a versão.

register_request_id(environ, request_id)Fonte

Registra uma solicitação HTTP simulada proveniente de dev_appserver.

As subclasses não são obrigadas a fornecer uma implementação.

Parâmetros

  • environ: um dict de ambiente da solicitação, conforme definido no PEP-333.

  • request_id: código de string da solicitação que faz a chamada de API.

class google.appengine.api.request_info.ResponseTuple(status, headers, content)source

Bases: tuple

content

Alias do campo número 2

headers

Alias do campo número 1

status

Alias do campo número 0

exception google.appengine.api.request_info.VersionAlreadyStartedErrorsource

Bases: google.appengine.api.request_info.Error

A versão já foi iniciada.

exception google.appengine.api.request_info.VersionAlreadyStoppedErrorsource

Bases: google.appengine.api.request_info.Error

A versão já foi parada.

exception google.appengine.api.request_info.VersionDoesNotExistErrorsource

Bases: google.appengine.api.request_info.Error

A versão fornecida não existe.