Structure du projet Flask

Une application Flask peut être aussi simple qu'un seul fichier.

Par exemple, le fichier hello.py suivant est une application Flask :

Exemple

from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'

Cependant, lorsque le projet devient plus volumineux, il n'est pas réaliste de mettre tout le code dans un seul fichier.

La structure du projet Flask peut varier en fonction de la taille et de la complexité de l'application.

Voici plusieurs structures de projet Flask courantes, adaptées respectivement aux applications simples et aux applications plus complexes.

  1. Structure de projet simple: Adaptée aux petites applications, avec tout le code concentré dans un seul fichier.
  2. Structure de projet intermédiaire: Divise l'application en plusieurs modules pour une gestion et une extension plus faciles.
  3. Structure de projet complexe: Prend en charge une modularité plus élevée, adaptée aux grandes applications, incluant les routes, les modèles, les templates et les répertoires de fichiers statiques.

1. Structure de projet simple

Pour une application Flask simple, la structure du projet peut être très concise :

my_flask_app/
│
├── app.py
└── requirements.txt
  • app.py: Le fichier principal de l'application Flask, contenant les définitions des routes et des fonctions de vue.
  • requirements.txt: Liste les dépendances du projet, utilisé pour enregistrer les informations de version pour Flask et d'autres paquets.

Code du fichier app.py dans le répertoire my_flask_app :

Exemple

from flask import Flask

app = Flask(__name__)

@app.route('/')
def home():
    return 'Hello, World!'

if __name__ == '__main__':
    app.run(debug=True)

Exemple de requirements.txt :

Flask==2.2.3

2. Structure de projet intermédiaire

Pour des applications légèrement plus complexes, le projet est généralement divisé en plusieurs modules et répertoires :

my_flask_app/
│
├── app/
│   ├── __init__.py
│   ├── routes.py
│   └── models.py
│
├── config.py
├── requirements.txt
└── run.py
  • app/: Contient le code principal de l'application Flask.
    • __init__.py: Initialise l'application Flask et configure les extensions.
    • routes.py: Définit les routes et les fonctions de vue de l'application.
    • models.py: Définit les modèles de données de l'application.
  • config.py: Fichier de configuration, contenant les informations de configuration de l'application.
  • requirements.txt: Liste les bibliothèques de dépendances du projet.
  • run.py: Utilisé pour démarrer l'application Flask.

app/__init__.py exemple :

Exemple

from flask import Flask

def create_app():
    app = Flask(__name__)
    app.config.from_object('config.Config')

    from . import routes
    app.register_blueprint(routes.bp)

    return app

app/routes.py exemple :

Exemple

from flask import Blueprint

bp = Blueprint('main', __name__)

@bp.route('/')
def home():
    return 'Hello, World!'

run.py exemple :

Exemple

from app import create_app

app = create_app()

if __name__ == '__main__':
    app.run(debug=True)

3. Structure de projet complexe

Pour les applications plus grandes, une structure de projet plus complexe peut être nécessaire pour prendre en charge une modularité et une extensibilité accrues :

my_flask_app/
│
├── app/
│   ├── __init__.py
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── main.py
│   │   └── auth.py
│   ├── models/
│   │   ├── __init__.py
│   │   └── user.py
│   ├── templates/
│   │   ├── layout.html
│   │   └── home.html
│   └── static/
│       ├── css/
│       └── js/
│
├── config.py
├── requirements.txt
├── migrations/
│   └── ...
└── run.py
  • app/routes/: Gère les routes pour différents modules fonctionnels séparément.
    • main.py: Routes pour le module principal.
    • auth.py: Routes liées à l'authentification.
  • app/models/: Gérer les modèles de données, généralement liés aux opérations de base de données.
    • user.py: Modèle utilisateur.
  • app/templates/: Stocker les fichiers de modèle HTML.
  • app/static/:Stocker des fichiers statiques, tels que CSS et JavaScript.
  • migrations/: Fichiers de migration de base de données, généralement liés à SQLAlchemy.

exemple app/routes/main.py :

Exemple

from flask import Blueprint, render_template

bp = Blueprint('main', __name__)

@bp.route('/')
def home():
    return render_template('home.html')

exemple app/models/user.py :

Exemple

from app import db

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(150), unique=True, nullable=False)
autres extensions