API des objets internes de Flask
Flask fournit plusieurs objets internes de bas niveau pour accéder au contexte d'application actif et à l'état d'enregistrement des blueprints. La plupart des applications n'ont pas besoin de les utiliser directement.
AppContext contexte d'application
| Méthodes/Attributs | Description |
|---|---|
| AppContext(app) | Créer une instance de contexte d'application. Généralement non créée manuellement ; utilisez app.app_context() |
| push() | Empiler sur la pile de contextes. Faire pointer les proxys tels que current_app et g vers ce contexte. |
| pop(error=None) | Dépiler la pile de contextes. Exécuter les callbacks de démontage. error est l'objet d'exception non gérée. |
| app | L'application Flask associée à ce contexte. |
| g | L'objet g de ce contexte (une instance de _AppCtxGlobals) |
| url_adapter | Adaptateur d'URL (MapAdapter), utilisé pour la construction d'URL |
| request | L’objet de requête actuel (Request). Disponible uniquement dans le contexte de requête. |
| session | L’objet Session actuel. Disponible uniquement dans le contexte de requête. |
proxy app_ctx
| Propriété | Description |
|---|---|
| flask.globals.app_ctx | Un proxy pointant vers l’AppContext actuellement actif. Pour usage interne ; dans la plupart des cas, current_app et g suffisent. |
BlueprintSetupState
L’objet d’état pour l’enregistrement du blueprint, disponible dans le callback record.
| Propriété | Description |
|---|---|
| app | L’application Flask à laquelle le blueprint est enregistré |
| blueprint | L’instance Blueprint enregistrée |
| url_prefix | Le préfixe d’URL du blueprint |
| subdomain | Le sous-domaine du blueprint |
| url_defaults | Les valeurs par défaut d’URL du blueprint |
| options | Options supplémentaires passées lors de l'enregistrement du blueprint |
RequestContext obsolète
Depuis Flask 3.2,RequestContexta été fusionné dansAppContext. Associérequest_ctxLes proxys ont également été fusionnés dansapp_ctxL'ancien nom sera supprimé dans Flask 4.0.
Exemples de code
Exemple
from flask import Flask
from flask.ctx import AppContext
app = Flask(__name__)
# Gérer manuellement le contexte d'application
ctx = app.app_context()
ctx.push()
# current_app et g sont maintenant disponibles
from flask import current_app, g
g.user = "example"
# Effectuer des opérations...
ctx.pop() # Déclencher le callback de teardown, g est nettoyé
# approche avec l'instruction with (recommandée)
with app.app_context():
g.temp_data = 42
# pop automatiquement après la sortie du with
from flask.ctx import AppContext
app = Flask(__name__)
# Gérer manuellement le contexte d'application
ctx = app.app_context()
ctx.push()
# current_app et g sont maintenant disponibles
from flask import current_app, g
g.user = "example"
# Effectuer des opérations...
ctx.pop() # Déclencher le callback de teardown, g est nettoyé
# approche avec l'instruction with (recommandée)
with app.app_context():
g.temp_data = 42
# pop automatiquement après la sortie du with