SDK de Python: subir archivos y hacer commit

Los ejemplos usan el client de Crear el cliente. app_id es el id de una de tus aplicaciones: client.account.me() las lista.

Entradas aceptadas

apps.create() y apps.commit() aceptan:

Entrada	Notas
Una ruta de archivo (`str` u `os.PathLike`)	Se transmite desde el disco, nunca se carga en memoria. El nombre del archivo se usa como nombre de archivo
`bytes` (o `bytearray`, `memoryview`)	Se envía desde la memoria
Un objeto de archivo binario (`open(path, "rb")`, `io.BytesIO`, …)	Un archivo con `seek` se transmite desde su posición actual; su `name`, si lo tiene, se usa como nombre de archivo. Uno sin `seek` (un pipe) se carga antes en memoria

Las subidas están limitadas a 100 MB. Un archivo más grande falla localmente con FILE_TOO_LARGE (estado 0) antes de enviar nada. Las subidas se transmiten en streaming y no tienen timeout una vez conectadas (consulta Timeouts).

Crear una aplicación

apps.create(file) despliega un .zip que contiene un archivo de configuración squarecloud.app en su raíz. Los bytes y los objetos de archivo sin nombre se envían como 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	Descripción
`id`	El id de la nueva aplicación
`name`	Nombre del archivo de configuración
`description`	Presente solo cuando está definido
`domain`	Host completo `<subdomain>.squareweb.app`; ausente en aplicaciones que no son web
`cluster`	Clúster en el que se colocó la aplicación
`ram` / `cpu`	Recursos asignados
`language`	`{ name, version }`

Hacer commit a una aplicación

apps.commit(app_id, file, path=None, filename=None) sube un archivo a una aplicación existente. path y filename son solo por palabra clave.

Un .zip se descomprime en path (la raíz de la aplicación por defecto).
Cualquier otro archivo se guarda en path/<filename>.

El nombre del archivo es filename, si no el propio nombre del archivo (ruta u objeto de archivo), y si no 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 no reinicia la aplicación. Llama a apps.restart() para aplicarlo.

Cancelar una subida

En Python, las subidas no se pueden cancelar una vez enviadas: apps.create() y apps.commit() no tienen ningún argumento signal ni de cancelación, ni timeout una vez conectadas. La propia conexión está limitada por timeout. Para que el resto de tu programa siga respondiendo durante una subida larga, ejecútala con AsyncSquareCloud (se ejecuta en un hilo de trabajo) o en tu propio hilo:

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

Errores

Estado	Código	Cuándo
0	`FILE_TOO_LARGE`	El archivo supera los 100 MB (se comprueba localmente)
400	`INVALID_FILE`, `INVALID_FILENAME`	No hay archivo, o el nombre de archivo contiene separadores de ruta, `..` o caracteres de control
400	`INVALID_PATH`	`path` contiene traversal o metacaracteres de shell (commit)
400	`INSUFFICIENT_MEMORY`	Menos de 256 MB de memoria disponible en el plan (create)
400	`COMMIT_FAILED`	No se pudo aplicar el commit (commit)
400	`UPLOAD_FAILED`, `STORAGE_UPLOAD_FAILED`, `CLUSTER_SELECTION_FAILED`	No se pudo procesar la subida (create)
503	`CLUSTER_MAINTENANCE_TRY_LATER`	El aprovisionamiento está en pausa por mantenimiento (create)
503	`UPLOAD_BUSY`	Demasiadas subidas en curso: se reintenta automáticamente

Una ruta local que no se puede abrir (o un archivo que deja de poder leerse a mitad de la subida) lanza un OSError, no un SquareCloudAPIError. Una ruta inexistente falla antes de enviar nada. Consulta Errores para ver la lista completa.

Próximos pasos

Gestión de archivos

Lista, lee, escribe, mueve y elimina los archivos de una aplicación.

Referencia de la API de subida

Los endpoints REST detrás de estos métodos.

Subir desde la CLI

Las mismas acciones desde la terminal.

CLI

VS Code

SDKs

SDK de Python: subir archivos y hacer commit

Entradas aceptadas

Crear una aplicación

Hacer commit a una aplicación

Cancelar una subida

Errores

Próximos pasos

Gestión de archivos

Referencia de la API de subida

Subir desde la CLI

​Entradas aceptadas

​Crear una aplicación

​Hacer commit a una aplicación

​Cancelar una subida

​Errores

​Próximos pasos

Gestión de archivos

Referencia de la API de subida

Subir desde la CLI

Entradas aceptadas

Crear una aplicación

Hacer commit a una aplicación

Cancelar una subida

Errores

Próximos pasos