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`……）	可 seek 的文件会从其当前位置开始流式传输；如果它有 `name`，则会被用作文件名。不可 seek 的文件（管道）会先被读入内存

上传限制为 100 MB。更大的文件会在发送任何内容之前于本地以 FILE_TOO_LARGE（状态 0）失败。上传采用流式传输，连接建立后没有超时（参见超时）。

创建应用

apps.create(file) 会 deploy 一个根目录包含 squarecloud.app 配置文件的 .zip。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` 包含路径穿越或 shell 元字符（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`	进行中的上传过多：会自动重试

无法打开的本地路径（或在上传过程中变得不可读的文件）会抛出 OSError，而不是 SquareCloudAPIError。不存在的路径会在发送任何内容之前失败。完整列表请参见错误。

后续步骤

管理文件

列出、读取、写入、移动和删除应用文件。

上传 API 参考

这些方法背后的 REST 端点。

用 CLI 上传

在终端中完成同样的操作。

CLI

VS Code

SDKs

Python SDK：上传与 commit 文件

接受的输入

创建应用

向应用提交 commit

取消上传

错误

后续步骤

管理文件

上传 API 参考

用 CLI 上传

​接受的输入

​创建应用

​向应用提交 commit

​取消上传

​错误

​后续步骤

管理文件

上传 API 参考

用 CLI 上传

接受的输入

创建应用

向应用提交 commit

取消上传

错误

后续步骤