Python SDK: ファイルのアップロードと commit

サンプルでは、クライアントの作成で作成した client を使います。app_id はあなたのアプリの ID で、client.account.me() で一覧できます。

受け付ける入力

apps.create() と apps.commit() は次のものを受け取ります:

入力	備考
ファイルパス (`str` または `os.PathLike`)	ディスクからストリーミングされ、メモリに読み込まれることはありません。ファイル名にはそのファイルの名前が使われます
`bytes` (または `bytearray`、`memoryview`)	メモリから送信されます
バイナリファイルオブジェクト (`open(path, "rb")`、`io.BytesIO` など)	シーク可能なファイルは現在の位置からストリーミングされ、`name` があればファイル名として使われます。シークできないもの (パイプ) は、先にメモリに読み込まれます

アップロードは 100 MB に制限されています。それより大きいファイルは、何も送信する前にローカルで FILE_TOO_LARGE (ステータス 0) として失敗します。アップロードはストリーミングされ、接続後はタイムアウトがありません (タイムアウトを参照)。

アプリケーションの作成

apps.create(file) は、ルートに squarecloud.app 設定ファイルを含む .zip を deploy します。bytes と名前のないファイルオブジェクトは app.zip として送信されます。

app = client.apps.create("./bot.zip")

print(app["id"], app["name"], app["ram"], app["cpu"], app["language"]["name"], app["language"]["version"])
print(app.get("domain"))  # "<subdomain>.squareweb.app" for web apps, absent otherwise
print(app.get("cluster"))  # the cluster the app was placed on

フィールド	説明
`id`	新しいアプリの ID
`name`	設定ファイルに記載された名前
`description`	設定されている場合のみ存在
`domain`	完全な `<subdomain>.squareweb.app` ホスト。Web 以外のアプリでは存在しません
`cluster`	アプリが配置されたクラスター
`ram` / `cpu`	割り当てられたリソース
`language`	`{ name, version }`

アプリケーションへの commit

apps.commit(app_id, file, path=None, filename=None) は、既存のアプリにファイルをアップロードします。path と filename はキーワード専用です。

.zip は path (デフォルトはアプリのルート) に展開されます。
それ以外のファイルは path/<filename> に配置されます。

ファイル名は filename、なければファイル自体の名前 (パスまたはファイルオブジェクト)、それもなければ commit.zip になります。

# Unpack a zip at the root
client.apps.commit(app_id, "./build.zip")

# Unpack a zip into /src
client.apps.commit(app_id, "./patch.zip", path="/src")

# A single file from memory: /src/index.js
client.apps.commit(app_id, code.encode(), path="/src", filename="index.js")

commit してもアプリは再起動されません。反映するには apps.restart() を呼び出してください。

アップロードのキャンセル

Python のアップロードは、送信後にキャンセルできません。apps.create() と apps.commit() には signal やキャンセル用の引数がなく、接続後のタイムアウトもありません。接続自体は timeout で制限されます。長時間のアップロード中もプログラムの他の部分が応答できるようにするには、AsyncSquareCloud (ワーカースレッドで実行されます) または独自のスレッドで実行してください:

async with AsyncSquareCloud(os.environ["SQUARECLOUD_API_KEY"]) as client:
    app = await client.apps.create("./bot.zip")

エラー

ステータス	コード	発生条件
0	`FILE_TOO_LARGE`	ファイルが 100 MB を超えている (ローカルでチェック)
400	`INVALID_FILE`, `INVALID_FILENAME`	ファイルがない、またはファイル名にパス区切り文字、`..`、制御文字が含まれている
400	`INVALID_PATH`	`path` にトラバーサルやシェルのメタ文字が含まれている (commit)
400	`INSUFFICIENT_MEMORY`	プランの利用可能なメモリが 256 MB 未満 (create)
400	`COMMIT_FAILED`	commit を適用できなかった (commit)
400	`UPLOAD_FAILED`, `STORAGE_UPLOAD_FAILED`, `CLUSTER_SELECTION_FAILED`	アップロードを処理できなかった (create)
503	`CLUSTER_MAINTENANCE_TRY_LATER`	メンテナンスのためプロビジョニングが一時停止している (create)
503	`UPLOAD_BUSY`	進行中のアップロードが多すぎる: 自動的にリトライされます

開けないローカルパス (またはアップロード中に読み取れなくなったファイル) は、SquareCloudAPIError ではなく OSError を送出します。存在しないパスは、何も送信する前に失敗します。完全な一覧はエラーを参照してください。

次のステップ

ファイルの管理

アプリのファイルを一覧、読み取り、書き込み、移動、削除します。

アップロード API リファレンス

これらのメソッドが呼び出す REST endpoint。

CLI からアップロード

同じ操作をターミナルから行います。

CLI

VS Code

SDKs

Python SDK: ファイルのアップロードと commit

受け付ける入力

アプリケーションの作成

アプリケーションへの commit

アップロードのキャンセル

エラー

次のステップ

ファイルの管理

アップロード API リファレンス

CLI からアップロード

​受け付ける入力

​アプリケーションの作成

​アプリケーションへの commit

​アップロードのキャンセル

​エラー

​次のステップ

ファイルの管理

アップロード API リファレンス

CLI からアップロード

受け付ける入力

アプリケーションの作成

アプリケーションへの commit

アップロードのキャンセル

エラー

次のステップ