SDK Python : envoyer et commiter des fichiers

Les exemples utilisent le client présenté dans Créer le client. app_id est l’identifiant de l’une de vos applications : client.account.me() les liste.

Entrées acceptées

apps.create() et apps.commit() acceptent :

Entrée	Remarques
Un chemin de fichier (`str` ou `os.PathLike`)	Diffusé en flux depuis le disque, jamais chargé en mémoire. Le nom du fichier est utilisé comme nom de fichier
`bytes` (ou `bytearray`, `memoryview`)	Envoyé depuis la mémoire
Un objet fichier binaire (`open(path, "rb")`, `io.BytesIO`, …)	Un fichier avec accès aléatoire (seekable) est diffusé en flux depuis sa position actuelle ; son `name`, s’il existe, est utilisé comme nom de fichier. Un fichier sans accès aléatoire (un pipe) est d’abord chargé en mémoire

Les envois sont limités à 100 Mo. Un fichier plus volumineux échoue localement avec FILE_TOO_LARGE (statut 0) avant tout envoi. Les envois sont diffusés en flux et n’ont aucun timeout une fois connectés (voir Timeouts).

Créer une application

apps.create(file) déploie un .zip qui contient un fichier de configuration squarecloud.app à sa racine. Les bytes et les objets fichier sans nom sont envoyés sous le nom 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

Champ	Description
`id`	L’identifiant de la nouvelle application
`name`	Nom issu du fichier de configuration
`description`	Présent uniquement s’il est défini
`domain`	Hôte complet `<subdomain>.squareweb.app` ; absent pour les applications non web
`cluster`	Cluster sur lequel l’application a été placée
`ram` / `cpu`	Ressources allouées
`language`	`{ name, version }`

Faire un commit sur une application

apps.commit(app_id, file, path=None, filename=None) envoie un fichier dans une application existante. path et filename sont uniquement nommés (keyword-only).

Un .zip est décompressé dans path (la racine de l’application par défaut).
Tout autre fichier est placé dans path/<filename>.

Le nom du fichier est filename, à défaut le nom propre du fichier (chemin ou objet fichier), à défaut 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 ne redémarre pas l’application. Appelez apps.restart() pour l’appliquer.

Annuler un envoi

Les envois Python ne peuvent pas être annulés une fois lancés : apps.create() et apps.commit() n’ont pas d’argument signal ni d’annulation, et aucun timeout une fois connectés. La connexion elle-même est bornée par timeout. Pour que le reste de votre programme reste réactif pendant un long envoi, exécutez-le avec AsyncSquareCloud (il s’exécute dans un thread de travail) ou dans votre propre thread :

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

Erreurs

Statut	Code	Quand
0	`FILE_TOO_LARGE`	Le fichier dépasse 100 Mo (vérifié localement)
400	`INVALID_FILE`, `INVALID_FILENAME`	Aucun fichier, ou un nom de fichier contenant des séparateurs de chemin, `..` ou des caractères de contrôle
400	`INVALID_PATH`	`path` contient une traversée de répertoire ou des métacaractères du shell (commit)
400	`INSUFFICIENT_MEMORY`	Moins de 256 Mo de mémoire disponible sur le plan (create)
400	`COMMIT_FAILED`	Le commit n’a pas pu être appliqué (commit)
400	`UPLOAD_FAILED`, `STORAGE_UPLOAD_FAILED`, `CLUSTER_SELECTION_FAILED`	L’envoi n’a pas pu être traité (create)
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Le provisionnement est suspendu pour maintenance (create)
503	`UPLOAD_BUSY`	Trop d’envois en cours : nouvelle tentative automatique

Un chemin local qui ne peut pas être ouvert (ou un fichier qui devient illisible pendant l’envoi) lève une OSError, et non une SquareCloudAPIError. Un chemin inexistant échoue avant tout envoi. Voir Erreurs pour la liste complète.

Prochaines étapes

Gérer les fichiers

Listez, lisez, écrivez, déplacez et supprimez les fichiers d’une application.

Référence de l'API d'envoi

Les endpoints REST derrière ces méthodes.

Envoyer depuis la CLI

Les mêmes actions depuis le terminal.

CLI

VS Code

SDKs

SDK Python : envoyer et commiter des fichiers

Entrées acceptées

Créer une application

Faire un commit sur une application

Annuler un envoi

Erreurs

Prochaines étapes

Gérer les fichiers

Référence de l'API d'envoi

Envoyer depuis la CLI

​Entrées acceptées

​Créer une application

​Faire un commit sur une application

​Annuler un envoi

​Erreurs

​Prochaines étapes

Gérer les fichiers

Référence de l'API d'envoi

Envoyer depuis la CLI

Entrées acceptées

Créer une application

Faire un commit sur une application

Annuler un envoi

Erreurs

Prochaines étapes