Módulo google.appengine.api.files.file

Resumo

Files API.

Uso suspenso desde a versão 1.8.1: use a biblioteca de cliente do Google Cloud Storage.

Índice

exception google.appengine.api.files.file.ApiTemporaryUnavailableErrorsource

Bases: google.appengine.api.files.file.Error

A Files API está temporariamente indisponível. A solicitação precisa ser repetida em breve.

exception google.appengine.api.files.file.Errorsource

Bases: exceptions.Exception

Classe de erro base para esse módulo.

exception google.appengine.api.files.file.ExclusiveLockFailedErrorsource

Bases: google.appengine.api.files.file.Error

O bloqueio exclusivo não pode ser recebido.

exception google.appengine.api.files.file.ExistenceErrorsource

Bases: google.appengine.api.files.file.Error

O arquivo está no estado de existência errado.

exception google.appengine.api.files.file.FileNotOpenedErrorsource

Bases: google.appengine.api.files.file.Error

O arquivo não foi aberto.

exception google.appengine.api.files.file.FileTemporaryUnavailableErrorsource

Bases: google.appengine.api.files.file.Error

O arquivo está temporariamente indisponível. A solicitação precisa ser repetida em breve.

exception google.appengine.api.files.file.FinalizationErrorsource

Bases: google.appengine.api.files.file.Error

O arquivo está no estado de finalização errado.

exception google.appengine.api.files.file.InvalidArgumentErrorsource

Bases: google.appengine.api.files.file.Error

O argumento da função tem valor inválido.

exception google.appengine.api.files.file.InvalidFileNameErrorsource

Bases: google.appengine.api.files.file.Error

O nome do arquivo é inválido.

exception google.appengine.api.files.file.InvalidParameterErrorsource

Bases: google.appengine.api.files.file.Error

O parâmetro especificado na chamada Create() é inválido.

exception google.appengine.api.files.file.OperationNotSupportedErrorsource

Bases: google.appengine.api.files.file.Error

Modo de abertura do arquivo incorreto.

exception google.appengine.api.files.file.PermissionDeniedErrorsource

Bases: google.appengine.api.files.file.Error

O aplicativo não tem permissões para executar a operação.

exception google.appengine.api.files.file.ReadOnlyErrorsource

Bases: google.appengine.api.files.file.Error

O arquivo está no modo somente leitura.

exception google.appengine.api.files.file.SequenceKeyOutOfOrderError(last_sequence_key, cause=None)source

Bases: google.appengine.api.files.file.Error

A chave de sequência especificada está fora de ordem.

last_sequence_key

Última chave de sequência gravada no arquivo.

exception google.appengine.api.files.file.UnknownErrorsource

Bases: google.appengine.api.files.file.Error

Ocorreu um erro desconhecido e inesperado de E/S.

exception google.appengine.api.files.file.UnsupportedContentTypeErrorsource

Bases: google.appengine.api.files.file.Error

O tipo de conteúdo de arquivo especificado não é compatível com esta API.

exception google.appengine.api.files.file.UnsupportedOpenModeErrorsource

Bases: google.appengine.api.files.file.Error

O modo de abertura de arquivo não compatível foi especificado.

exception google.appengine.api.files.file.WrongContentTypeErrorsource

Bases: google.appengine.api.files.file.Error

O arquivo tem um tipo de conteúdo diferente.

exception google.appengine.api.files.file.WrongOpenModeErrorsource

Bases: google.appengine.api.files.file.Error

Modo de abertura do arquivo incorreto.

google.appengine.api.files.file.delete(*filenames)source

Exclua arquivos permanentemente.

A exclusão em arquivos não finalizados/inexistentes é um ambiente autônomo.

Parâmetros

filenames: nomes de arquivo finalizados como strings. filename precisa ter o formato “/gs/bucket/filename” ou “/blobstore/blobkey”.

Gera
  • InvalidFileNameError: gerado quando qualquer nome de arquivo não é de formato válido ou não é um nome finalizado.

  • IOError: gerado caso algum problema ocorra ao entrar em contato com o sistema de back-end.

google.appengine.api.files.file.finalize(filename, content_type=0)source

Finalize um arquivo.

Parâmetros
  • filename: nome de arquivo como string.

  • content_type: tipo de conteúdo do arquivo. Valor de FileContentType.ContentType enum.

google.appengine.api.files.file.listdir(path, **kwargs)source

Retorne uma lista classificada de nomes de arquivo (correspondendo a um padrão) no caminho fornecido.

Somente caminhos do Google Cloud Storage são compatíveis na implementação atual.

Parâmetros
  • path: um caminho do Google Cloud Storage da forma “/gs/bucketname”.

  • kwargs: outros argumentos de palavra-chave a serem retransmitidos para o Google Cloud Storage. Pode ser usado para selecionar determinados arquivos com nomes correspondentes a um padrão. Consulte google.appengine.api.files.gs.listdir para detalhes.

Retorna

Uma lista contendo nomes de arquivo (correspondentes a um padrão) do caminho fornecido. Classificado por String do Python.

google.appengine.api.files.file.open(filename, mode='r', content_type=0, exclusive_lock=False, buffering=0)source

Abra um arquivo.

Parâmetros
  • filename: um nome do arquivo como string.

  • mode: modo de abertura do arquivo. "a" ou "r".

  • content_type: tipo de conteúdo do arquivo. Valor de FileContentType.ContentType enum.

  • exclusive_lock: se o arquivo precisa ser bloqueado exclusivamente. Todas as outras tentativas de bloqueio exclusivas serão arquivadas até que o arquivo seja fechado corretamente.

  • buffering: argumento opcional semelhante à abertura do Python. Ele especifica o tamanho do buffer desejado do arquivo: 0 significa sem buffer, valor positivo significa usar um buffer desse tamanho, qualquer valor negativo significa o tamanho padrão. Somente o buffer de leitura é compatível.

Retorna

Objeto de arquivo.

Gera

InvalidArgumentError: gerado quando um valor ou um tipo de argumento inválido é fornecido.

google.appengine.api.files.file.stat(filename)source

Receba o status de um arquivo finalizado, dado o nome de arquivo do caminho completo.

Retorna

Um objeto _FileStat semelhante ao retornado por os.stat(path) do Python.

Gera:

FinalizationError caso o arquivo não seja finalizado.

class google.appengine.api.files.file.BufferedFile(filename, buffer_size=524288)source

Bases: object

BufferedFile é um objeto semelhante ao arquivo que lê o arquivo subjacente em blocos.

close()source
read(size=None)source

Dados de leitura do arquivo RAW.

Parâmetros

size: número de bytes para leitura como inteiro. O número real de bytes lidos é sempre igual ao tamanho, a menos que o final do arquivo tenha sido alcançado.

Retorna

Uma string com dados lidos.

readline(size=-1)source

Leia uma linha delimitada por ‘ ‘ pelo arquivo.

Um caractere de nova linha à direita é mantido na string. Pode estar ausente quando um arquivo termina com uma linha incompleta. Se não for negativo, o argumento size especificará o tamanho máximo da string (contando a nova linha) a ser retornado. Uma string vazia só é retornada quando EOF é encontrado imediatamente.

Argumentos:
size: número máximo de bytes a ser lido. Se não for especificada, a linha de leitura vai parar

apenas em ‘

‘ ou EOF.

Retorna:

Os dados lidos como uma string.

seek(offset, whence=0)source

Define a posição atual do arquivo.

Parâmetros
  • offset: procura o deslocamento como número.

  • whence: modo de procura. Os modos compatíveis são os.SEEK_SET (procura absoluta), os.SEEK_CUR (procura relativa à posição atual) e os.SEEK_END (procura relativa à extremidade, o deslocamento precisa ser negativo).

tell()source

Retorna a posição atual do arquivo.

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

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2