google.appengine.api.files.file モジュール

概要 

Files API

バージョン 1.8.1 移行サポート終了: Google Cloud Storage クライアント ライブラリを使用してください。

内容

exception google.appengine.api.files.file.ApiTemporaryUnavailableErrorソース

ベース: google.appengine.api.files.file.Error

Files API が一時的に利用不可になっています。リクエストはすぐに再試行されます。

exception google.appengine.api.files.file.Errorソース

ベース: exceptions. Exception

このモジュールのベース エラー クラス。

exception google.appengine.api.files.file.ExclusiveLockFailedErrorソース

ベース: google.appengine.api.files.file.Error

排他ロックは取得できません。

exception google.appengine.api.files.file.ExistenceErrorソース

ベース: google.appengine.api.files.file.Error

ファイルは不適切な存在状態にあります。

exception google.appengine.api.files.file.FileNotOpenedErrorソース

ベース: google.appengine.api.files.file.Error

ファイルが開けませんでした。

exception google.appengine.api.files.file.FileTemporaryUnavailableErrorソース

ベース: google.appengine.api.files.file.Error

ファイルが一時的に利用不可になっています。リクエストはすぐに再試行されます。

exception google.appengine.api.files.file.FinalizationErrorソース

ベース: google.appengine.api.files.file.Error

ファイルは不適切なファイナライズ状態にあります。

exception google.appengine.api.files.file.InvalidArgumentErrorソース

ベース: google.appengine.api.files.file.Error

関数の引数の値が無効です

exception google.appengine.api.files.file.InvalidFileNameErrorソース

ベース: google.appengine.api.files.file.Error

ファイル名が無効です。

exception google.appengine.api.files.file.InvalidParameterErrorソース

ベース: google.appengine.api.files.file.Error

Create() 呼び出しで指定されたパラメータが無効です。

exception google.appengine.api.files.file.OperationNotSupportedErrorソース

ベース: google.appengine.api.files.file.Error

ファイルを開くモードが誤っています。

exception google.appengine.api.files.file.PermissionDeniedErrorソース

ベース: google.appengine.api.files.file.Error

アプリケーションはオペレーションを実行する権限を持ちません。

exception google.appengine.api.files.file.ReadOnlyErrorソース

ベース: google.appengine.api.files.file.Error

ファイルは読み取り専用モードになっています。

exception google.appengine.api.files.file.SequenceKeyOutOfOrderError(last_sequence_key, cause=None)ソース

ベース: google.appengine.api.files.file.Error

指定されたシーケンスキーは使用できません。

last_sequence_key

ファイルに書き込まれた最後のシーケンスキー。

exception google.appengine.api.files.file.UnknownErrorソース

ベース: google.appengine.api.files.file.Error

不明な予期せぬ IO エラーが発生しました。

exception google.appengine.api.files.file.UnsupportedContentTypeErrorソース

ベース: google.appengine.api.files.file.Error

指定されたファイルのコンテンツ タイプは、この API ではサポートされていません。

exception google.appengine.api.files.file.UnsupportedOpenModeErrorソース

ベース: google.appengine.api.files.file.Error

サポートされていないファイルを開くモードが指定されました。

exception google.appengine.api.files.file.WrongContentTypeErrorソース

ベース: google.appengine.api.files.file.Error

ファイルには異なるコンテンツ タイプがあります。

exception google.appengine.api.files.file.WrongOpenModeErrorソース

ベース: google.appengine.api.files.file.Error

ファイルを開くモードが誤っています。

google.appengine.api.files.file.delete(*filenames)ソース

永久にファイルを削除します。

ファイナライズされていない / 存在しないファイルは削除されません。

パラメータ

filenames - 文字列としてファイナライズされたファイル名。ファイル名は「/gs/bucket/filename」または「/blobstore/blobkey」形式になります。

発生するエラー
  • InvalidFileNameError - ファイル名が有効な形式ではない場合や、ファイナライズされた名前ではない場合に発生します。

  • IOError - バックエンド システムへの接触で問題が起きた場合に発生します。

google.appengine.api.files.file.finalize(filename, content_type=0)ソース

ファイルをファイナライズします。

パラメータ
  • filename - 文字列のファイル名。

  • content_type - ファイルのコンテンツ タイプ。Value from FileContentType.ContentType 列挙型の値。

google.appengine.api.files.file.listdir(path, **kwargs)ソース

特定のパスでファイル名が並べ替えられたリスト(パターンに一致)を返します。

現在の実装では Google Cloud Storage のパスのみサポートされています。

パラメータ
  • path - 「/gs/bucketname」形式の Google Cloud Storage パス。

  • kwargs - Google Cloud Storage に送られるその他のキーワード引数。これはパターンに名前が一致する特定のファイルを選択するために使用されます。詳細については、google.appengine.api.files.gs.listdir をご覧ください。

戻り値

特定のパスでファイル名(パターンに一致する)を含むリスト。Python の文字列によって並べ替えられます。

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

ファイルを開く

パラメータ
  • filename - 文字列のファイル名。

  • mode - ファイルを開くモード。「a」または「r」のいずれかです。

  • content_type - ファイルのコンテンツ タイプ。Value from FileContentType.ContentType 列挙型の値。

  • exclusive_lock - ファイルの排他ロックが必要な場合に使用します。その他の排他ロックの試みはすべて、ファイルが適切に閉じられるまで保存されます。

  • buffering - Python の open に似たオプションの引数。ファイルの希望のバッファサイズ指定します。0 はバッファされていない、正の値はそのサイズのバッファを使用する、負の値はデフォルトのサイズを意味します。バッファリングの読み取りのみサポートされています。

戻り値

File オブジェクトを返します。

発生するエラー

InvalidArgumentError - 違法な引数の値または型が入力された場合に発生します。

google.appengine.api.files.file.stat(filename)ソース

フルパスのファイル名を前提として、ファイナライズされたファイルのステータスを取得します。

戻り値

Python の os.stat(path) が返すものと似た _FileStat オブジェクト。

スロー:

ファイルがファイナライズされない場合の FinalizationError。

class google.appengine.api.files.file.BufferedFile(filename, buffer_size=524288)ソース

ベース: オブジェクト

BufferedFile は、基盤のファイルをチャンク形式で読み取るファイルのようなオブジェクトです。

close()ソース
read(size=None)ソース

RAW ファイルからデータを読み取ります。

パラメータ

size - 整数として読み取られるバイト数。読み取られる実際のバイト数は、ファイルの終わりに到達しない限り、size と常に同じです。

戻り値

データ読み取りの文字列。

readline(size=-1)ソース

ファイルから ‘ ‘ で区切られた 1 行を読み取ります。

末尾の改行文字は文字列に保持されます。ファイルが不完全な行で終了した場合、改行は存在しない可能性があります。サイズの引数が負の値でない場合、返す文字列の最大サイズ(改行をカウント)を表します。空の文字列は EOF に達した直後にのみ返されます。

引数:
size: 読み込む最大のバイト数。指定されない場合、readline は

'

' または EOF でのみ中断します。

戻り値:

データは文字列として読み取られます。

seek(offset, whence=0)ソース

ファイルの現在位置を設定します。

パラメータ
  • offset - オフセットを数字としてシークします。

  • whence - モードをシークします。サポートされているモードは os.SEEK_SET(絶対的なシーク)、os.SEEK_CUR(現在位置と相対的なシーク)、および os.SEEK_END(終了と相対的なシーク、オフセットは負の値)です。

tell()ソース

ファイルの現在位置を返します。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境