SDK Python: upload e commit di file

Gli esempi usano il client di Creare il client. app_id è l’id di una delle tue app: client.account.me() le elenca.

Input accettati

apps.create() e apps.commit() accettano:

Input	Note
Un percorso di file (`str` o `os.PathLike`)	Trasmesso in streaming dal disco, mai caricato in memoria. Il nome del file viene usato come nome del file inviato
`bytes` (o `bytearray`, `memoryview`)	Inviato dalla memoria
Un file object binario (`open(path, "rb")`, `io.BytesIO`, …)	Un file con seek viene trasmesso in streaming dalla sua posizione corrente; il suo `name`, se presente, viene usato come nome del file. Uno senza seek (una pipe) viene prima letto in memoria

Gli upload sono limitati a 100 MB. Un file più grande fallisce localmente con FILE_TOO_LARGE (status 0) prima che venga inviato qualsiasi cosa. Gli upload vengono trasmessi in streaming e non hanno timeout una volta connessi (vedi Timeout).

Creare un’applicazione

apps.create(file) effettua il deploy di un .zip che contiene un file di configurazione squarecloud.app nella sua radice. I bytes e i file object senza nome vengono inviati come 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

Campo	Descrizione
`id`	L’id della nuova app
`name`	Nome preso dal file di configurazione
`description`	Presente solo se impostata
`domain`	Host completo `<subdomain>.squareweb.app`; assente per le app non web
`cluster`	Cluster su cui è stata collocata l’app
`ram` / `cpu`	Risorse allocate
`language`	`{ name, version }`

Fare il commit su un’applicazione

apps.commit(app_id, file, path=None, filename=None) carica un file in un’app esistente. path e filename sono solo keyword.

Un .zip viene estratto in path (per impostazione predefinita la radice dell’app).
Qualsiasi altro file finisce in path/<filename>.

Il nome del file è filename, altrimenti il nome del file stesso (percorso o file object), altrimenti 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")

Un commit non riavvia l’app. Chiama apps.restart() per applicarlo.

Annullare un upload

In Python gli upload non possono essere annullati una volta inviati: apps.create() e apps.commit() non hanno un argomento signal o di annullamento, e nessun timeout una volta connessi. La connessione in sé è limitata da timeout. Per mantenere reattivo il resto del programma durante un upload lungo, eseguilo con AsyncSquareCloud (gira in un worker thread) o in un tuo thread:

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

Errori

Status	Codice	Quando
0	`FILE_TOO_LARGE`	Il file supera i 100 MB (verificato localmente)
400	`INVALID_FILE`, `INVALID_FILENAME`	Nessun file, o un nome di file con separatori di percorso, `..` o caratteri di controllo
400	`INVALID_PATH`	`path` contiene attraversamenti di percorso o metacaratteri della shell (commit)
400	`INSUFFICIENT_MEMORY`	Meno di 256 MB di memoria disponibile nel piano (create)
400	`COMMIT_FAILED`	Non è stato possibile applicare il commit (commit)
400	`UPLOAD_FAILED`, `STORAGE_UPLOAD_FAILED`, `CLUSTER_SELECTION_FAILED`	Non è stato possibile elaborare l’upload (create)
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Il provisioning è sospeso per manutenzione (create)
503	`UPLOAD_BUSY`	Troppi upload in corso: ripetuto automaticamente

Un percorso locale che non può essere aperto (o un file che diventa illeggibile durante l’upload) solleva un OSError, non un SquareCloudAPIError. Un percorso inesistente fallisce prima che venga inviato qualsiasi cosa. Vedi Errori per l’elenco completo.

Prossimi passi

Gestire i file

Elenca, leggi, scrivi, sposta ed elimina i file di un’app.

Riferimento API dell'upload

Gli endpoint REST dietro questi metodi.

Upload dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK Python: upload e commit di file

Input accettati

Creare un’applicazione

Fare il commit su un’applicazione

Annullare un upload

Errori

Prossimi passi

Gestire i file

Riferimento API dell'upload

Upload dalla CLI

​Input accettati

​Creare un’applicazione

​Fare il commit su un’applicazione

​Annullare un upload

​Errori

​Prossimi passi

Gestire i file

Riferimento API dell'upload

Upload dalla CLI

Input accettati

Creare un’applicazione

Fare il commit su un’applicazione

Annullare un upload

Errori

Prossimi passi