Python-SDK: Dateien hochladen und committen

Die Beispiele verwenden den client aus Client erstellen. app_id ist die ID einer deiner Apps: client.account.me() listet sie auf.

Akzeptierte Eingaben

apps.create() und apps.commit() akzeptieren:

Eingabe	Hinweise
Ein Dateipfad (`str` oder `os.PathLike`)	Wird von der Festplatte gestreamt, nie in den Speicher gelesen. Der Name der Datei wird als Dateiname verwendet
`bytes` (oder `bytearray`, `memoryview`)	Wird aus dem Speicher gesendet
Ein binäres Dateiobjekt (`open(path, "rb")`, `io.BytesIO`, …)	Eine Datei mit Seek-Unterstützung wird ab ihrer aktuellen Position gestreamt; ihr `name`, falls vorhanden, wird als Dateiname verwendet. Eine ohne Seek-Unterstützung (eine Pipe) wird zuerst in den Speicher gelesen

Uploads sind auf 100 MB begrenzt. Eine größere Datei schlägt lokal mit FILE_TOO_LARGE (Status 0) fehl, bevor etwas gesendet wird. Uploads werden gestreamt und haben nach dem Verbindungsaufbau kein Timeout (siehe Timeouts).

Eine Anwendung erstellen

apps.create(file) deployt eine .zip, die im Stammverzeichnis eine Konfigurationsdatei squarecloud.app enthält. bytes und Dateiobjekte ohne Namen werden als app.zip gesendet.

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

Feld	Beschreibung
`id`	Die ID der neuen App
`name`	Name aus der Konfigurationsdatei
`description`	Nur vorhanden, wenn gesetzt
`domain`	Vollständiger Host `<subdomain>.squareweb.app`; fehlt bei Nicht-Web-Apps
`cluster`	Cluster, auf dem die App platziert wurde
`ram` / `cpu`	Zugewiesene Ressourcen
`language`	`{ name, version }`

Commit in eine Anwendung

apps.commit(app_id, file, path=None, filename=None) lädt eine Datei in eine bestehende App hoch. path und filename sind reine Keyword-Argumente.

Eine .zip wird unter path entpackt (standardmäßig im Stammverzeichnis der App).
Jede andere Datei landet unter path/<filename>.

Der Dateiname ist filename, sonst der eigene Name der Datei (Pfad oder Dateiobjekt), sonst 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")

Ein Commit startet die App nicht neu. Rufe apps.restart() auf, um ihn anzuwenden.

Einen Upload abbrechen

Python-Uploads lassen sich nach dem Senden nicht abbrechen: apps.create() und apps.commit() haben kein signal- oder Abbruch-Argument und nach dem Verbindungsaufbau kein Timeout. Der Verbindungsaufbau selbst ist durch timeout begrenzt. Damit der Rest deines Programms während eines langen Uploads reaktionsfähig bleibt, führe ihn mit AsyncSquareCloud (er läuft in einem Worker-Thread) oder in einem eigenen Thread aus:

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

Fehler

Status	Code	Wann
0	`FILE_TOO_LARGE`	Die Datei ist größer als 100 MB (lokal geprüft)
400	`INVALID_FILE`, `INVALID_FILENAME`	Keine Datei, oder ein Dateiname mit Pfadtrennzeichen, `..` oder Steuerzeichen
400	`INVALID_PATH`	`path` enthält Traversal- oder Shell-Metazeichen (Commit)
400	`INSUFFICIENT_MEMORY`	Weniger als 256 MB verfügbarer Arbeitsspeicher im Plan (Erstellen)
400	`COMMIT_FAILED`	Der Commit konnte nicht angewendet werden (Commit)
400	`UPLOAD_FAILED`, `STORAGE_UPLOAD_FAILED`, `CLUSTER_SELECTION_FAILED`	Der Upload konnte nicht verarbeitet werden (Erstellen)
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Die Bereitstellung ist wegen Wartung pausiert (Erstellen)
503	`UPLOAD_BUSY`	Zu viele laufende Uploads: wird automatisch wiederholt

Ein lokaler Pfad, der sich nicht öffnen lässt (oder eine Datei, die während des Uploads unlesbar wird), wirft einen OSError, keinen SquareCloudAPIError. Ein fehlender Pfad schlägt fehl, bevor etwas gesendet wird. Die vollständige Liste findest du unter Fehler.

Nächste Schritte

Dateien verwalten

Dateien einer App auflisten, lesen, schreiben, verschieben und löschen.

API-Referenz für Uploads

Die REST-Endpunkte hinter diesen Methoden.

Upload über die CLI

Dieselben Aktionen im Terminal.

CLI

VS Code

SDKs

Python-SDK: Dateien hochladen und committen

Akzeptierte Eingaben

Eine Anwendung erstellen

Commit in eine Anwendung

Einen Upload abbrechen

Fehler

Nächste Schritte

Dateien verwalten

API-Referenz für Uploads

Upload über die CLI

​Akzeptierte Eingaben

​Eine Anwendung erstellen

​Commit in eine Anwendung

​Einen Upload abbrechen

​Fehler

​Nächste Schritte

Dateien verwalten

API-Referenz für Uploads

Upload über die CLI

Akzeptierte Eingaben

Eine Anwendung erstellen

Commit in eine Anwendung

Einen Upload abbrechen

Fehler

Nächste Schritte