Flask Anwendungsglobale - g Object API

gist ein globaler Namensraum auf Anfrageebene, der verwendet wird, um Daten zwischen mehreren Funktionen innerhalb derselben Anfrage zu teilen.

Durch den Import vonfrom flask import g; nur verfügbar, wenn der Anwendungskontext aktiv ist.


g-Objekt-Beschreibung

Funktionen Beschreibung
Type flask.ctx._AppCtxGlobals-Instanz
Lebenszyklus Wird mit dem Anwendungskontext erstellt, mit dem Anwendungskontext zerstört.
Threadsicherheit Jede Anfrage bzw. jeder Kontext hat ein eigenes unabhängiges g-Objekt.
Nutzung Eigenschaften wie bei gewöhnlichen Objekten lesen und schreiben: g.user = ..., g.db = ...

_AppCtxGlobals-Methoden

Methoden Beschreibung
get(name, default=None) Den Attributwert abrufen; den Standardwert zurückgeben, wenn das Attribut nicht vorhanden ist.
pop(name, default=None) Attributwert entfernen und zurückgeben.
setdefault(name, default=None) Wenn das Attribut nicht vorhanden ist, den Standardwert festlegen und ihn zurückgeben.
__contains__(name) Unterstützt hasattr(g, "name") oder "name" in g

Typische Nutzungsmuster

Beispiel

from flask import Flask, g

app = Flask(__name__)

def get_db():
    """Die Datenbankverbindung wird nur einmal erstellt und zur Wiederverwendung in g gespeichert."""
    if "db" not in g:
        g.db = connect_to_database()
    return g.db

@app.before_request
def load_user():
    """Benutzerinformationen vor Beginn der Anfrage in g laden"""
    user_id = session.get("user_id")
    if user_id:
        g.user = query_user(user_id)  # g.user kann direkt in der View-Funktion verwendet werden
    else:
        g.user = None

@app.route("/profile")
def profile():
    if g.user is None:
        return "Nicht angemeldet"
    return f"Hallo, {g.user.name}"

@app.teardown_appcontext
def close_db(error):
    """Ressourcen am Ende der Anfrage aufräumen"""
    db = g.pop("db", None)
    if db is not None:
        db.close()

Grundprinzipien: Das g-Objekt wird nur für die Datenfreigabe innerhalb derselben Anfrage verwendet. Speichern Sie keine anfrageübergreifenden Daten in g und speichern Sie keine Informationen, die persistiert werden müssen, in g.

Weitere Erweiterungen