Cramnurbel

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.

====== Configuration ======

Doc: [[https://flask.palletsprojects.com/en/2.0.x/config/]]

===== Structure du projet =====

Les fichiers **.env** et **config.py** sont positionnées à la racine
du projet :

<code>
/home/marc/flaskapp
├── .env
├── app
│   ├── __init__.py
│   └── ...
├── config.py
└── ...
</code>

:!: Les fichiers **.env** et **config.py** doivent être dans le **.gitignore**
sinon ils seront publiés sur le dépôt en même temps que le code :!:

===== Installation des dépendances =====

Pour charger le fichier **.env**, il faut que le module **python-dotenv**
soit installé.

<code bash>
source venv/bin/activate
(venv)$ pip install python-dotenv
</code>

===== Écrire le fichier .env =====

Contient la configuration de base de **Flask**

En **développement** :

<code bash .env>
FLASK_APP = run.py
FLASK_ENV = development
DEBUG     = True
</code>

En **production** :

<code bash .env>
FLASK_ENV = production
DEBUG     = False
</code>

===== Écrire le fichier config.py =====

C'est ici que je place toute la configuration spécifique à l'application
(qui n'est pas propre à Flask).

<code python config.py>
import os

SECRET_KEY  = "...(clé secrète)..."

BASE_DIR    = os.path.abspath(os.path.dirname(__file__))
PATH_UPLOAD = os.path.join(BASE_DIR, 'data/upload/')
</code>

Pour générer la clé secrète, voir la page [[python:generer_secret_key]]

===== Lecture de la configuration =====

Les valeurs lues par **Flask** depuis le fichier **.env** se trouvent déjà
dans l'objet **app.config**

Nous allons y intégrer les valeurs lues depuis le fichier **config.py** :

<code python __init.py__>
from flask import Flask

app = Flask(__name__)

# ceci va intégrer les valeurs de "config.py"
app.config.from_object('config')
</code>

===== Accéder à la configuration =====

<code python>
base_dir = app.config['BASE_DIR']
</code>

Depuis un Blueprint, utiliser l'objet **current_app** :

<code python>
from flask import current_app

base_dir = current_app.config['BASE_DIR']
</code>

===== Afficher le contenu de la configuration =====

Ceci sort la liste des valeurs vers la console:

<code python>
for item in app.config.items():
    print("%-30s => %s" % item)
</code>

Cramnurbel

Outils pour utilisateurs

Outils du site

Outils de la page