Módulo google.appengine.api.urlfetch

Resumo

URL downloading API.

Índice

google.appengine.api.urlfetch.Fetch(url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, deadline=None, validate_certificate=None)source

Busca o URL HTTP fornecido, bloqueando até que o resultado seja retornado.

Os URLs são buscados com um dos seguintes métodos HTTP:

  • GET

  • POST

  • HEAD

  • PUT

  • DELETE

  • PATCH

Para buscar o resultado, um proxy compatível com HTTP/1.1 é usado.

Parâmetros

  • method: as constantes GET, POST, HEAD, PUT, DELETE ou PATCH ou os mesmos métodos HTTP que as strings.

  • payload: POST, PUT ou PATCH payload (implica que o método não é GET, HEAD ou DELETE). Esse argumento é ignorado se o método não é POST, PUT ou PATCH.

  • headers: dicionário de cabeçalhos HTTP a enviar com a solicitação.

  • allow_truncated: definido como True, vai truncar grandes respostas e as retornar sem gerar erro. Caso contrário, um ResponseTooLargeError será gerado quando uma resposta for truncada.

  • follow_redirects: se definido como True (padrão), os redirecionamentos são feitos de maneira transparente, e a resposta, se houver menos de 5, contém o destino final do payload. O status da resposta é 200. Você perderá, no entanto, as informações da cadeia de redirecionamento. Se definido como False, você consegue ver a resposta HTTP, incluindo o cabeçalho "Localização", e os redirecionamentos não são feitos.

  • deadline: prazo da operação, em segundos.

  • validate_certificate: se definido como True, as solicitações não são enviadas ao servidor, a menos que o certificado seja válido, assinado por uma autoridade de certificação (CA, na sigla em inglês) e o nome do host corresponda ao certificado. Um valor de None indica que o comportamento vai ser escolhido pela implementação do urlfetch.

Retorna

Um objeto contendo os seguintes campos:

  • content: uma string que contém a resposta do servidor.

  • status_code: código de status HTTP que foi retornado pelo servidor.

  • headers: dicionário de cabeçalhos que foi retornado pelo servidor.

Tipo de retorno

objeto

Gera

urlfetch_errors.Error: se ocorrer um erro. Consulte o módulo urlfetch_errors para mais informações.

google.appengine.api.urlfetch.create_rpc(deadline=None, callback=None)Fonte

Cria um objeto RPC para uso com a urlfetch API.

Parâmetros

  • deadline: prazo opcional da operação, em segundos. O padrão é um prazo específico do sistema, geralmente cinco segundos.

  • callback: chamável opcional a ser invocado na conclusão.

Retorna

Um objeto apiproxy_stub_map.UserRPC especializado para este serviço.

google.appengine.api.urlfetch.fetch(url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, deadline=None, validate_certificate=None)Fonte

Busca o URL HTTP fornecido, bloqueando até que o resultado seja retornado.

Os URLs são buscados com um dos seguintes métodos HTTP:

  • GET

  • POST

  • HEAD

  • PUT

  • DELETE

  • PATCH

Para buscar o resultado, um proxy compatível com HTTP/1.1 é usado.

Parâmetros

  • method: as constantes GET, POST, HEAD, PUT, DELETE ou PATCH ou os mesmos métodos HTTP que as strings.

  • payload: POST, PUT ou PATCH payload (implica que o método não é GET, HEAD ou DELETE). Esse argumento é ignorado se o método não é POST, PUT ou PATCH.

  • headers: dicionário de cabeçalhos HTTP a enviar com a solicitação.

  • allow_truncated: definido como True, vai truncar grandes respostas e as retornar sem gerar erro. Caso contrário, um ResponseTooLargeError será gerado quando uma resposta for truncada.

  • follow_redirects: se definido como True (padrão), os redirecionamentos são feitos de maneira transparente, e a resposta, se houver menos de 5, contém o destino final do payload. O status da resposta é 200. Você perderá, no entanto, as informações da cadeia de redirecionamento. Se definido como False, você consegue ver a resposta HTTP, incluindo o cabeçalho "Localização", e os redirecionamentos não são feitos.

  • deadline: prazo da operação, em segundos.

  • validate_certificate: se definido como True, as solicitações não são enviadas ao servidor, a menos que o certificado seja válido, assinado por uma autoridade de certificação (CA, na sigla em inglês) e o nome do host corresponda ao certificado. Um valor de None indica que o comportamento vai ser escolhido pela implementação do urlfetch.

Retorna

Um objeto contendo os seguintes campos:

  • content: uma string que contém a resposta do servidor.

  • status_code: código de status HTTP que foi retornado pelo servidor.

  • headers: dicionário de cabeçalhos que foi retornado pelo servidor.

Tipo de retorno

objeto

Gera

urlfetch_errors.Error: se ocorrer um erro. Consulte o módulo urlfetch_errors para mais informações.

google.appengine.api.urlfetch.get_default_fetch_deadline()Fonte

Recebe o valor padrão do parâmetro de prazo de create_rpc().

google.appengine.api.urlfetch.make_fetch_call(rpc, url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, validate_certificate=None)Fonte

Executa a chamada RPC para buscar um determinado URL HTTP.

O primeiro argumento é uma instância de UserRPC. Consulte urlfetch.fetch para ver uma descrição detalhada dos argumentos restantes.

Gera

  • InvalidMethodError: se o método solicitado não estiver em _VALID_METHODS.

  • ResponseTooLargeError: se o payload da resposta for muito grande.

  • InvalidURLError: se houver problemas com o conteúdo ou o tamanho do URL solicitado.

Retorna

Objeto RPC que foi passado para a função.

google.appengine.api.urlfetch.set_default_fetch_deadline(value)Fonte

Define o valor padrão para o parâmetro deadline de create_rpc().

Essa configuração é específica do segmento, o que significa que é armazenada em um segmento local. Esta função não verifica o tipo ou o intervalo do valor. O valor padrão é None.

Consulte também: create_rpc() e fetch()

Parâmetros

value: o valor padrão que você quer usar para o parâmetro deadline de create_rpc().