SDK Python: gestire i file dell'app

Il file manager si trova su client.apps.files. Ogni metodo accetta prima l’id dell’app, poi un percorso all’interno dell’app. I percorsi hanno al massimo 256 caratteri. Gli esempi usano il client di Creare il client. app_id è l’id di una delle tue app: client.account.me() le elenca.

Elencare una directory

files.list(app_id, path=None) elenca una directory (la radice dell’app quando path è omesso). A differenza degli altri modificatori facoltativi, path può essere passato per posizione.

for entry in client.apps.files.list(app_id, "/src"):
    print(entry["type"], entry["name"], entry.get("size"), entry.get("lastModified"))

Campo	Tipo	Descrizione
`name`	`str`	Nome della voce
`type`	`"file" \| "directory"`	Tipo di voce
`size`	`int`, facoltativo	Dimensione in byte. Assente in alcune voci di directory
`lastModified`	`float \| None`, facoltativo	ms Unix (può includere una parte frazionaria); `None` quando non leggibile

Una directory che non esiste produce 404 FILE_NOT_FOUND. Un percorso che il file manager non espone produce 403 BLOCKED_PATH.

Leggere un file

files.read(app_id, path) restituisce il contenuto del file come bytes. I file sono limitati a 10 MB: uno più grande produce 413 FILE_TOO_LARGE.

import json

data = client.apps.files.read(app_id, "/config.json")
text = data.decode()

print(json.loads(text))

Scrivere un file

files.write(app_id, path, content) crea o sovrascrive un file.

Una str viene inviata come testo semplice.
I bytes vengono inviati in base64, quindi qualsiasi contenuto binario arriva intatto.
Un contenuto vuoto ('' o b'') crea un file vuoto.

import json
import urllib.request

# Text
client.apps.files.write(app_id, "/config.json", json.dumps({"debug": False}))

# Binary
with urllib.request.urlopen(image_url) as response:
    image = response.read()
client.apps.files.write(app_id, "/assets/logo.png", image)

Un contenuto oltre i 10 MB fallisce localmente con FILE_TOO_LARGE (status 0) prima che venga inviato qualsiasi cosa. Un contenuto oltre 1 MiB viene inviato senza timeout una volta connessi, come un upload. Per file più grandi, usa apps.commit().

La scrittura non riavvia l’app. Chiama apps.restart() per applicare la modifica.

Spostare o rinominare un file

client.apps.files.move(app_id, "/config.json", "/config.old.json")

Eliminare un file

client.apps.files.delete(app_id, "/config.old.json")

Errori

Status	Codice	Quando
0	`FILE_TOO_LARGE`	Contenuto di `write` oltre 10 MB (verificato localmente)
400	`INVALID_PATH`	Il percorso non supera la validazione (attraversamento, caratteri non validi, troppo lungo), oppure `move` verso lo stesso percorso
400	`DELETE_FAILED`, `RENAME_FAILED`	Il cluster non è riuscito a eliminare o rinominare il file
403	`BLOCKED_PATH`	Il percorso non è esposto dal file manager
403	`PERMISSION_DENIED`	Il tuo ruolo nel workspace non può toccare un file riservato (come `.env`)
404	`FILE_NOT_FOUND`	Il file o la directory non esiste
413	`FILE_TOO_LARGE`	`read` di un file oltre 10 MB
429	`KEEP_CALM`	Più di 10 scritture in 5 secondi

Vedi Errori per i codici che qualsiasi chiamata può restituire.

Prossimi passi

Variabili d'ambiente

Leggi e modifica le variabili di un’app.

Riferimento API del file manager

Gli endpoint REST dietro questi metodi.

Gestire i file dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK Python: gestire i file dell'app

Elencare una directory

Leggere un file

Scrivere un file

Spostare o rinominare un file

Eliminare un file

Errori

Prossimi passi

Variabili d'ambiente

Riferimento API del file manager

Gestire i file dalla CLI

​Elencare una directory

​Leggere un file

​Scrivere un file

​Spostare o rinominare un file

​Eliminare un file

​Errori

​Prossimi passi

Variabili d'ambiente

Riferimento API del file manager

Gestire i file dalla CLI

Elencare una directory

Leggere un file

Scrivere un file

Spostare o rinominare un file

Eliminare un file

Errori

Prossimi passi