Módulo google.appengine.api.blobstore.blobstore

Resumo

Blobstore API.

Este módulo contém métodos que pode usar para interagir com a Blobstore API. O módulo define uma classe como db.Key que representa uma chave de blob.

Conteúdo

exception google.appengine.api.blobstore.blobstore.BlobFetchSizeTooLargeErrorsource

Bases: google.appengine.api.blobstore.blobstore.Error

Não foi possível buscar o bloco porque ele era muito grande.

class google.appengine.api.blobstore.blobstore.BlobKey(blob_key)source

Bases: object

Chave usada para identificar um blob no Blobstore.

Esse objeto encapsula uma string usada internamente pela Blobstore API para identificar blobs de aplicativo. O BlobKey corresponde ao nome da entidade BlobReference subjacente.

Essa classe é exposta na API em google.appengine.ext.db e google.appengine.ext.blobstore.

ToXml()source
exception google.appengine.api.blobstore.blobstore.BlobNotFoundErrorsource

Bases: google.appengine.api.blobstore.blobstore.Error

O blob não existe.

exception google.appengine.api.blobstore.blobstore.DataIndexOutOfRangeErrorsource

Bases: google.appengine.api.blobstore.blobstore.Error

Não foi possível acessar os índices.

Os índices especificados estavam fora do intervalo ou na ordem errada.

exception google.appengine.api.blobstore.blobstore.PermissionDeniedErrorsource

Bases: google.appengine.api.blobstore.blobstore.Error

A operação não foi concluída. Examine as permissões obrigatórias.

exception google.appengine.api.blobstore.blobstore.Errorsource

Bases: exceptions.Exception

Tipo de erro do blobstore de base.

exception google.appengine.api.blobstore.blobstore.InternalErrorsource

Bases: google.appengine.api.blobstore.blobstore.Error

Ocorreu um erro interno.

google.appengine.api.blobstore.blobstore.create_rpc(deadline=None, callback=None)source

Cria um objeto RPC a ser usado com a Blobstore API.

Parâmetros
  • deadline: prazo opcional em segundos para a operação. O valor padrão é um prazo específico do sistema, geralmente de 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.blobstore.blobstore.create_upload_url(success_path, max_bytes_per_blob=None, max_bytes_total=None, rpc=None, gs_bucket_name=None)source

Cria o URL de upload para uma forma POST.

Parâmetros
  • success_path: caminho dentro do aplicativo a ser chamado quando uma chamada POST for bem-sucedida e o upload for concluído

  • max_bytes_per_blob: tamanho máximo em bytes que qualquer blob no upload pode ter ou None para nenhum tamanho máximo

  • max_bytes_total: tamanho máximo em bytes que os tamanhos agregados de todos os blobs no upload podem ter ou None para nenhum tamanho máximo

  • rpc: um objeto UserRPC opcional

  • gs_bucket_name: nome do intervalo do Google Cloud Storage que será o destino dos blobs enviados. A conta de serviço do aplicativo precisa ter as permissões corretas para gravar nesse intervalo. O nome do intervalo pode ser do formato bucket/path/, quando o caminho incluído será pré-anexado ao nome do objeto enviado.

Retorna

O URL de upload.

Gera
  • TypeError: caso max_bytes_per_blob ou max_bytes_total não sejam tipos integrais;

  • ValueError: caso max_bytes_per_blob ou max_bytes_total não sejam valores positivos.

google.appengine.api.blobstore.blobstore.create_upload_url_async(success_path, max_bytes_per_blob=None, max_bytes_total=None, rpc=None, gs_bucket_name=None)source

Cria de maneira assíncrona o URL de upload para um formulário POST.

Parâmetros
  • success_path: caminho dentro do aplicativo a ser chamado quando uma chamada POST for bem-sucedida e o upload for concluído

  • max_bytes_per_blob: tamanho máximo em bytes que qualquer blob no upload pode ter ou None para nenhum tamanho máximo

  • max_bytes_total: tamanho máximo em bytes que os tamanhos agregados de todos os blobs no upload podem ter ou None para nenhum tamanho máximo

  • rpc: um objeto UserRPC opcional

  • gs_bucket_name: nome do intervalo do Google Cloud Storage que será o destino dos blobs enviados. A conta de serviço do aplicativo precisa ter as permissões corretas para gravar nesse intervalo. O nome do intervalo pode ser do formato bucket/path/, quando o caminho incluído será pré-anexado ao nome do objeto enviado.

Retorna

Um UserRPC com um resultado que será o URL de upload.

Gera
  • TypeError: caso max_bytes_per_blob ou max_bytes_total não sejam tipos integrais;

  • ValueError: caso max_bytes_per_blob ou max_bytes_total não sejam valores positivos.

google.appengine.api.blobstore.blobstore.delete(blob_keys, rpc=None, _token=None)source

Exclui um blob do Blobstore.

Parâmetros
  • blob_keys: uma instância de BlobKey única ou uma lista de chaves de blob (uma chave de blob pode ser uma string ou uma instância de BlobKey)

  • rpc: um objeto UserRPC opcional

Retorna

Nenhum.

google.appengine.api.blobstore.blobstore.delete_async(blob_keys, rpc=None, _token=None)source

Exclui de maneira assíncrona um blob do Blobstore.

Parâmetros
  • blob_keys: uma instância de BlobKey única ou uma lista de chaves de blob (uma chave de blob pode ser uma string ou uma instância de BlobKey)

  • rpc: um objeto UserRPC opcional

Retorna

Um UserRPC com um resultado que será None.

google.appengine.api.blobstore.blobstore.fetch_data(blob_key, start_index, end_index, rpc=None)source

Busca os dados de um blob.

Parâmetros
  • blob_key: BlobKey, string ou representação Unicode de um BlobKey do blob de que você quer buscar dados.

  • start_index: o valor do índice inicial dos dados de blob a ser buscado. Esse argumento não pode ser definido como um valor negativo.

  • end_index: o valor do índice final (exclusivo) dos dados de blob a ser buscado. Esse argumento precisa ser maior que ou igual ao valor start_index.

  • rpc: um objeto UserRPC opcional

Retorna

Uma string que contém dados parciais do blob.

google.appengine.api.blobstore.blobstore.fetch_data_async(blob_key, start_index, end_index, rpc=None)source

Busca de maneira assíncrona os dados de um blob.

Parâmetros
  • blob_key: BlobKey, string ou representação Unicode de um BlobKey do blob de que você quer buscar dados.

  • start_index: o valor do índice inicial dos dados de blob a ser buscado. Esse argumento não pode ser definido como um valor negativo.

  • end_index: o valor do índice final (exclusivo) dos dados de blob a ser buscado. Esse argumento precisa ser maior que ou igual ao valor start_index.

  • rpc: um objeto UserRPC opcional

Retorna

Um UserRPC com um resultado que será uma string conforme retornado por fetch_data().

google.appengine.api.blobstore.blobstore.create_gs_key(filename, rpc=None)source

Cria uma chave codificada para um arquivo do Google Cloud Storage.

É seguro manter essa chave para uso futuro.

Parâmetros
  • filename: nome de arquivo do objeto do Google Cloud Storage referente à chave que será criada

  • rpc: um objeto UserRPC opcional

Retorna

Uma string de BlobKey criptografada.

google.appengine.api.blobstore.blobstore.create_gs_key_async(filename, rpc=None)source

Cria, de maneira assíncrona, uma chave codificada para um arquivo do Google Cloud Storage.

É seguro manter essa chave para uso futuro.

Parâmetros
  • filename: nome de arquivo do objeto do Google Cloud Storage referente à chave que será criada

  • rpc: um objeto UserRPC opcional

Retorna

Um UserRPC com um resultado que será uma string conforme retornado por create_gs_key().

Gera
  • TypeError: se filename não for uma string;

  • ValueError: se filename não estiver no formato /gs/bucket_name/object_name.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2