v5 への移行

​

概要

​

初期化とオプション

​

メソッドごとの対応

​

型

​

エラー

​

動作の変更

• 省略可能な修飾引数はキーワード専用です: account.snapshots(scope=)、apps.status_all(workspace_id=)、apps.status(id, raw=)、databases.status(id, raw=)、apps.commit(id, file, path=, filename=)、apps.network.errors(..., include_4xx=)、apps.network.analytics(...) のフィルター、databases.update(id, name=, ram=)、databases.create(name, type=, version=, memory=)。apps.files.list の省略可能な path は位置引数のままです。
• 2xx の {"status": "error"} ボディは例外を送出します。アプリとデータベースの起動・停止の拒否は、コードのみを持つ 409 です (CONTAINER_ALREADY_STARTED、ACTION_FAILED など)。202 SNAPSHOT_PROCESSING は例外を送出せずに {'pending': True} を返します: list をポーリングし、create を再度呼び出さないでください。
• 設定されていない省略可能なクエリ値 (および '') は、送信されずに省かれます。
• 文字列の結果が None になることはありません: reset_credentials(id, 'certificate') と削除された webhook は '' を返します。
• apps.files.write は str をテキストとして、bytes を base64 エンコードで送信します。空の内容は空のファイルを作成し、1 MiB を超える内容はタイムアウトなしで送信されます。apps.files.read は常に base64 を要求し、デコードされた bytes を返します。
• 存在しないディレクトリに対する apps.files.list は 404 FILE_NOT_FOUND を送出します。
• 503 DATABASE_UNAVAILABLE は変更が適用された後に発生することがあるため、GET でのみリトライされます。冪等な変更をリトライするかどうかは呼び出し側に委ねられます。
• リアルタイムのストリームは {'event', 'data', 'id', ...} のイベントを返し、5.5 秒に 1 回のオープンで連続最大 3 回まで再オープンし、オープンに失敗すると例外を送出します。

​

非同期

client = squarecloud.Client(key)
status = await client.app_status(app_id)
print(status.ram)
async for data in client.realtime(app_id):
    print(data)

async with squarecloud.AsyncSquareCloud(key) as client:
    status = await client.apps.status(app_id)
    print(status['ram'])
    async with client.apps.realtime(app_id) as stream:
        async for event in stream:
            print(event['data'])