Flask-Projektstruktur

Eine Flask-Anwendung kann so einfach wie eine einzelne Datei sein.

Zum Beispiel ist die folgende Datei hello.py eine Flask-Anwendung:

Beispiel

from flask import Flask

app = Flask(__name__)


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

Wenn das Projekt jedoch größer wird, ist es unrealistisch, den gesamten Code in eine einzige Datei zu packen.

Die Flask-Projektstruktur kann je nach Größe und Komplexität der Anwendung variieren.

Im Folgenden werden mehrere gängige Flask-Projektstrukturen vorgestellt, die sich jeweils für einfache Anwendungen und komplexere Anwendungen eignen.

  1. Einfache Projektstruktur: Geeignet für kleine Anwendungen, bei denen der gesamte Code in einer einzigen Datei konzentriert ist.
  2. Mittlere Projektstruktur: Teilt die Anwendung in mehrere Module auf, um Verwaltung und Erweiterung zu erleichtern.
  3. Komplexe Projektstruktur: Unterstützt eine höhere Modularität, geeignet für große Anwendungen, einschließlich Routen, Modelle, Templates und Verzeichnisse für statische Dateien.

1. Einfache Projektstruktur

Für eine einfache Flask-Anwendung kann die Projektstruktur sehr knapp ausfallen:

my_flask_app/
│
├── app.py
└── requirements.txt
  • app.py: Die Hauptdatei der Flask-Anwendung, die Definitionen der Routen und View-Funktionen enthält.
  • requirements.txt: Listet die Abhängigkeiten des Projekts auf und dient zur Aufzeichnung von Versionsinformationen für Flask und andere Pakete.

Code für die Datei app.py im Verzeichnis my_flask_app:

Beispiel

from flask import Flask

app = Flask(__name__)

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

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

Beispiel für requirements.txt:

Flask==2.2.3

2. Mittlere Projektstruktur

Für etwas komplexere Anwendungen wird das Projekt üblicherweise in mehrere Module und Verzeichnisse aufgeteilt:

my_flask_app/
│
├── app/
│   ├── __init__.py
│   ├── routes.py
│   └── models.py
│
├── config.py
├── requirements.txt
└── run.py
  • app/: Enthält den Hauptcode der Flask-Anwendung.
    • __init__.py: Initialisiert die Flask-Anwendung und konfiguriert Erweiterungen.
    • routes.py: Definiert die Routen und View-Funktionen der Anwendung.
    • models.py: Definiert die Datenmodelle der Anwendung.
  • config.py: Konfigurationsdatei, die die Konfigurationsinformationen der Anwendung enthält.
  • requirements.txt: Listet die Abhängigkeitsbibliotheken des Projekts auf.
  • run.py: Wird zum Starten der Flask-Anwendung verwendet.

app/__init__.py Beispiel:

Beispiel

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 Beispiel:

Beispiel

from flask import Blueprint

bp = Blueprint('main', __name__)

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

run.py Beispiel:

Beispiel

from app import create_app

app = create_app()

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

3. Komplexe Projektstruktur

Für größere Anwendungen kann eine komplexere Projektstruktur erforderlich sein, um höhere Modularität und Erweiterbarkeit zu unterstützen:

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/: Verwaltet Routen für verschiedene Funktionsmodule getrennt.
    • main.py: Routen für das Hauptmodul.
    • auth.py: Routen für die Authentifizierung.
  • app/models/: Datenmodelle verwalten, normalerweise im Zusammenhang mit Datenbankoperationen.
    • user.py: Benutzermodell.
  • app/templates/: HTML-Vorlagendateien speichern.
  • app/static/:Statische Dateien wie CSS und JavaScript speichern.
  • migrations/: Datenbank-Migrationsdateien, normalerweise im Zusammenhang mit SQLAlchemy.

app/routes/main.py Beispiel:

Beispiel

from flask import Blueprint, render_template

bp = Blueprint('main', __name__)

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

app/models/user.py Beispiel:

Beispiel

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)
Weitere Erweiterungen