App Storage Python SDK

Documentation Index

Fetch the complete documentation index at: https://docs.replit.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Client

from replit.object_storage import Client

client = Client()

​

__init__

def __init__(bucket_id: Optional[str] = None)

• bucket_id (Optional[str]): クライアントが管理するバケットのID。省略した場合、ClientはReplit AppまたはDeploymentに関連付けられたデフォルトのバケットを使用します。

​

copy

def copy(object_name: str, dest_object_name: str) -> None

• object_name (str) - ソースオブジェクトのフルパス。
• dest_object_name (str) - オブジェクトのコピー先フルパス。

• ObjectNotFoundError - 指定したパスにソースオブジェクトが存在しないことを示します。

​

delete

def delete(object_name: str, ignore_not_found: bool = False) -> None

• object_name (str) - 削除するオブジェクトの名前。
• ignore_not_found (bool) - True の場合、オブジェクトが存在しなくてもエラーを抑制します。

• ObjectNotFoundError - オブジェクトが存在しないことを示します。

​

download_as_bytes

def download_as_bytes(object_name: str) -> bytes

• object_name (str) - ダウンロードするオブジェクトの名前。

• bytes - オブジェクトの内容の生のバイト表現。

• ObjectNotFoundError - オブジェクトが存在しないことを示します。

​

download_as_text

def download_as_text(object_name: str) -> str

• object_name (str) - 取得するソースオブジェクト名。

• str: UTF-8エンコードされた文字列としてのオブジェクトの内容。

• ObjectNotFoundError - オブジェクトが存在しないことを示します。

​

download_to_filename

def download_to_filename(object_name: str, dest_filename: str) -> None

• object_name (str) - App Storageから取得するソースオブジェクト名。
• dest_filename (str) - ローカルディスク上の保存先ファイル名。

• ObjectNotFoundError - オブジェクトが存在しないことを示します。

​

exists

def exists(object_name: str) -> bool

• object_name (str) - 存在を確認するオブジェクトの名前。

• bool: オブジェクトが存在する場合は True、そうでない場合は False。

​

list

def list(end_offset: Optional[str] = None,
         match_glob: Optional[str] = None,
         max_results: Optional[int] = None,
         prefix: Optional[str] = None,
         start_offset: Optional[str] = None) -> List[Object]

• end_offset(Optional[str]) - end_offset より辞書順で前の名前を持つオブジェクトに結果をフィルタします。start_offset が定義されている場合、リストされるオブジェクトの名前は start_offset（含む）から end_offset（含まない）の間になります。
• match_glob (Optional[str]) - 結果をフィルタするためのglobパターン。例: “foo*bar” は “footbar”、“foo baz bar”、“foobar” にマッチします。
• max_results (Optional[int]) - レスポンスで返す結果の最大数。
• prefix (Optional[str]) - 指定したプレフィックスを持つ名前のオブジェクトに結果をフィルタします。
• start_offset (Optional[str]) - start_offset と辞書順で等しいか後の名前のオブジェクトに結果をフィルタします。end_offset が設定されている場合、リストされるオブジェクトの名前は start_offset（含む）から end_offset（含まない）の間になります。

• List(Object): 指定したクエリパラメーターに一致するオブジェクトのリスト。

​

upload_from_filename

def upload_from_filename(dest_object_name: str, src_filename: str) -> None

• dest_object_name(str) - アップロードするファイルの名前。
• src_filename(str) - アップロードするソースファイル。

​

upload_from_bytes

def upload_from_bytes(dest_object_name: str, src_data: bytes) -> None

• dest_object_name(str) - アップロードするオブジェクトの名前。
• src_data(str) - アップロードする bytes データ。

​

upload_from_text

def upload_from_text(dest_object_name: str, src_data: Union[bytes, str]) -> None

• dest_object_name(str) - アップロードするオブジェクトの名前。
• src_data(str) - アップロードするテキストデータ。

​

例外タイプ

• Client を使用してReplit App Storageとやり取りする際、次のいずれかのエラーが返される可能性があります：
  • BucketNotFoundError: 設定されたバケット名がApp Storageのどのバケットとも一致しないことを示します。
  • DefaultBucketError: デフォルトのバケット設定が欠如していることを示します。
  • ForbiddenError: バケットへのアクセス権限が不足していることを示します。
  • TooManyRequestsError: 過剰なリクエストによりオペレーションがレート制限されていることを示します。
  • UnauthorizedError: 認証によりオペレーションへのアクセスが制限されていることを示します。

​

クラスメソッドの例

​

ファイルをテキストとして取得する

client.download_as_text("file.json")

​

ファイルの生バイトを取得する

client.download_as_bytes("file.png")

​

ファイルをローカルファイルシステムにダウンロードする

client.download_to_filename("file.json", dest_filename)

​

バケット内のオブジェクトを一覧表示する

client.list()

​

テキストからファイルをアップロードする

client.upload_from_text("file.json", data)

​

バイトとしてファイルをアップロードする

client.upload_from_bytes("file.png", data)

​

ファイルシステムからオブジェクトをアップロードする

client.upload_from_filename("file.json", src_filename)

​

バケットからオブジェクトを削除する

client.delete("file.json")