Flask-Fehlerbehandlung

Flask bietet einen flexiblen Fehlerbehandlungsmechanismus, der verschiedene Fehler in der Anwendung abfangen und behandeln kann.

Gute Fehlerbehandlung bedeutet nicht nur "keine Bugs" — sie bedeutet, Nutzern eine freundliche Erfahrung zu bieten, wenn doch Fehler auftreten.

Dieses Kapitel führt ein, wie man Fehlerseiten anpasst und Logs in Flask verwaltet.


Benutzerdefinierte Fehlerseite

Standardmäßig zeigt Flask für Fehler wie 404 eine einfache Seite mit schwarzem Hintergrund und weißem Text an.

Verwendung@app.errorhandlerDekoratoren können verwendet werden, um Fehlerseiten für bestimmte HTTP-Statuscodes anzupassen:

Beispiel

from flask import Flask, render_template

app = Flask(__name__)

# 404-Fehler behandeln – Seite nicht gefunden
@app.errorhandler(404)
def page_not_found(error):
    # Hinweis: Statuscode 404 muss explizit zurückgegeben werden
    return render_template("404.html"), 404

# 500-Fehler behandeln – interner Serverfehler
@app.errorhandler(500)
def internal_error(error):
    return render_template("500.html"), 500

# 403-Fehler behandeln – Zugriff verboten
@app.errorhandler(403)
def forbidden(error):
    return render_template("403.html"), 403

Die entsprechende 404-Vorlage:

Beispiel

<!-- Dateipfad: templates/404.html -->
<!DOCTYPE html>
<html>
<head>
    <title>404 - Seite nicht gefunden</title>
    <style>
        body { text-align: center; padding-top: 60px; font-family: Arial; }
        h1 { font-size: 72px; color: #e74c3c; margin: 0; }
        p { color: #666; font-size: 18px; }
        a { color: #3498db; }
    </style>
</head>
<body>
    <h1>404</h1>
    <p>Entschuldigung, die von Ihnen besuchte Seite existiert nicht.</p>
    <p><a href="/">Zurück zur Startseite</a></p>
</body>
</html>

InerrorhandlerIn der dekorierten Funktion,returnSie müssen den Statuscode explizit angeben. Wenn Sie ihn nicht angeben, 404, Flask gibt standardmäßig den Statuscode 200 zurück, und Browser und Suchmaschinen werden ihn nicht als Fehlerseite behandeln.


Registrierung von Exception-Klassen

Neben dem Statuscode können Sie mit@app.errorhandlerauch direkt Exception-Klassen registrieren:

Beispiel

from werkzeug.exceptions import HTTPException

@app.errorhandler(HTTPException)
def handle_http_exception(error):
    """Behandelt alle HTTP-Ausnahmen einheitlich (z. B. 400, 401, 403, 404 usw.)"""
    return f"""
<h1>HTTP-Fehler {error.code}</h1>
    <p>{error.description}</p>
<p><a href="/">Zurück zur EXAMPLE-Startseite</a></p>
    """
, error.code

Fehler mit abort auslösen

In Ihrer View-Funktion verwenden Sieabort(), um aktiv einen HTTP-Fehler auszulösen:

Beispiel

from flask import abort

# Simuliere eine Artikeldatenbank
articles = {
    1: {"title": Flask-Tutorial},
    2: {"title": "Python-Grundlagen"},
}

@app.get("/article/<int:article_id>")
def view_article(article_id):
    article = articles.get(article_id)

    if article is None:
        # Artikel existiert nicht, 404 zurückgeben
        # Der Parameter description wird an errorhandler übergeben
        abort(404, description=f"Artikel-ID {article_id} existiert nicht")

    return f"<h1>{article['title']}</h1>"

@app.get("/admin")
def admin_panel():
    # Benutzer ohne Administratorberechtigungen greift auf das Admin-Backend zu
    abort(403, description="Sie haben keine Administratorberechtigungen")

Protokollierung

Flask verwendet das Modulloggingder Python-Standardbibliothek, überapp.loggerkönnen Sie dann Datensätze protokollieren.

Protokollierung ist entscheidend für die Fehlersuche – verwenden Sie nicht nurprint(), da Protokolle mehr Kontext und bessere Kontrolle bieten.

Beispiel

from flask import Flask, request

app = Flask(__name__)

@app.route("/")
def index():
    # Verschiedene Log-Level
    app.logger.debug("Zugriff auf Startseite")                    # Debug-Informationen, normalerweise nicht in der Produktion ausgegeben
    app.logger.info("Benutzer von IP: %s", request.remote_addr)  # Allgemeine Informationen
    app.logger.warning("Ungewöhnliches Zugriffsmuster erkannt")         # Warnung: erfordert Aufmerksamkeit, beeinträchtigt den Betrieb aber nicht
    app.logger.error("Datenbankverbindung fehlgeschlagen")               # Fehler: Funktionalität ist beeinträchtigt
    app.logger.critical("Nicht genügend Speicherplatz, Dienst wird in Kürze beendet")  # Kritischer Fehler: Dienst könnte beendet werden
    return "OK"

Log-Level (von niedrig bis hoch):

Stufe Anwendungsfall
DEBUG Detaillierte Informationen beim Debuggen während der Entwicklung werden in der Produktionsumgebung standardmäßig nicht ausgegeben.
INFO Allgemeine Laufzeitinformationen, wie z. B. Anfrageprotokolle und Dienststart
WARNING Warnmeldungen, potenzielle Probleme, die den aktuellen Betrieb nicht beeinträchtigen
ERROR Fehlermeldungen, eine Funktion ist fehlgeschlagen, aber der Dienst läuft weiter
CRITICAL Kritische Fehler, können dazu führen, dass der Dienst beendet wird

Im Debug-Modus wird der Log-Level von Flask automatisch aufDEBUGgesetzt. In Produktionsumgebungen setzen Sie ihn nach Bedarf aufINFOoderWARNING, um die Ausgabe zu vieler nutzloser Informationen zu vermeiden.


Protokollausgabe konfigurieren

Protokolle in eine Datei schreiben, um spätere Analysen und die Fehlerbehebung zu erleichtern:

Beispiel

import logging
from logging.handlers import RotatingFileHandler

# Datei-Log-Handler konfigurieren: nach Erreichen von 10MB in der Logdatei rotieren
handler = RotatingFileHandler(
    "example_app.log",     # Pfad zur Logdatei
    maxBytes=10 * 1024 * 1024,  # Maximale Größe einer einzelnen Datei 10MB
    backupCount=5          # Die letzten 5 Backups behalten
)

# Logformat festlegen
handler.setFormatter(logging.Formatter(
    "[%(asctime)s] %(levelname)s in %(module)s: %(message)s"
))

# Handler zum Logger von Flask hinzufügen
app.logger.addHandler(handler)
app.logger.setLevel(logging.INFO)

Unbehandelte Ausnahmen abfangen

Verwendungapp.errorhandler(500)Sie können unbehandelte Ausnahmen abfangen und in Logs aufzeichnen:

Beispiel

import traceback

@app.errorhandler(500)
def internal_error(error):
    # Den vollständigen Stacktrace der Ausnahme protokollieren
    app.logger.error("Interner Serverfehler:\n%s", traceback.format_exc())

    # Dem Benutzer eine benutzerfreundliche Fehlerseite anzeigen
    return """
<h1>500 - Interner Serverfehler</h1>
<p>Entschuldigung, auf dem Server ist ein unerwarteter Fehler aufgetreten. Wir haben das Problem aufgezeichnet. Bitte versuchen Sie es später erneut.</p>
<p>Wenn das Problem weiterhin besteht, wenden Sie sich bitte an den technischen Support von EXAMPLE.</p>
    """
, 500

Kurzübersicht für gängige HTTP-Fehlercodes

Statuscode Bedeutung Häufige Ursachen
400 Ungültige Anfrage Fehlerhafte Anfrageparameter, fehlende Pflichtfelder
401 Nicht autorisiert Benutzer ist nicht angemeldet oder Authentifizierung fehlgeschlagen
403 Verboten Benutzer ist angemeldet, hat aber keine Zugriffsberechtigung
404 Nicht gefunden Ressource (Artikel, Benutzer usw.) existiert nicht
405 Methode nicht zulässig Verwendung der falschen HTTP-Methode (z. B. GET zum Zugriff auf einen POST-Endpunkt)
500 Interner Serverfehler Unbehandelte Fehler wie Code-Ausnahmen und Datenbankverbindungsfehler
Weitere Erweiterungen