Umgebungsvariablen - Square Cloud

Umgebungsvariablen befinden sich unter client.apps.envs. Jede Methode nimmt zuerst die App-ID und gibt die Variablen der App als einfaches dict[str, str] zurück.

Statische Apps haben keine Umgebungsvariablen: Jede Methode antwortet mit 400 STATIC_APP_ENV_NOT_SUPPORTED. Eine Änderung wird beim nächsten Neustart wirksam.

Die Variablen lesen

envs = client.apps.envs.get(app_id)

print(envs.get("NODE_ENV"))

Variablen hinzufügen oder aktualisieren

envs.set(app_id, envs) fügt die angegebenen Schlüssel hinzu und überschreibt die bereits vorhandenen. Andere Variablen bleiben erhalten. Die Methode gibt alle Variablen nach der Änderung zurück.

envs = client.apps.envs.set(app_id, {
    "NODE_ENV": "production",
    "LOG_LEVEL": "info",
})

Alle Variablen ersetzen

envs.replace(app_id, envs) ersetzt alle Variablen durch die angegebene Menge. Schlüssel, die nicht im Dict enthalten sind, werden entfernt. {} löscht alle.

client.apps.envs.replace(app_id, {"NODE_ENV": "production"})

Variablen entfernen

envs.delete(app_id, keys) entfernt die angegebenen Schlüssel und gibt die verbleibenden Variablen zurück. keys ist eine Liste (ein beliebiges Iterable von Strings) oder ein einzelner Schlüssel.

remaining = client.apps.envs.delete(app_id, ["LOG_LEVEL"])

# A single key also works
remaining = client.apps.envs.delete(app_id, "LOG_LEVEL")

Limits und Fehler

Status	Code	Wann
400	`STATIC_APP_ENV_NOT_SUPPORTED`	Die App ist statisch
400	`INVALID_ENV_CONTENT`	Die Variablen sind kein gültiges Objekt (oder, bei `delete`, eine leere Liste)
400	`TOO_MANY_ENV_VARS`	Das Ergebnis hätte mehr als 256 Variablen
400	`ENV_NAME_TOO_LONG`	Ein Schlüssel ist länger als 1024 Zeichen
400	`ENV_CONTENT_TOO_LONG`	Ein Wert ist länger als 4096 Zeichen
400	`READ_FAILED`	Der Cluster konnte die Variablen nicht lesen