Das Schreiben effektiven Ausnahmebehandlungscodes ist für die Erstellung robuster und wartbarer Anwendungen unerlässlich.
Nachfolgend finden Sie einige Best Practices zum Schreiben von Ausnahmebehandlungscode in Python:

1. Fangen Sie nur, was Sie bewältigen können

Seien Sie genau:

• Fangen Sie bestimmte Ausnahmen ab, anstatt eine breite Ausnahmeklausel zu verwenden.
• Dadurch wird sichergestellt, dass nur die Ausnahmen abgefangen werden, die Sie erwarten und mit denen Sie umgehen können.

try:
    # Code that might raise an exception
except ValueError as e:
    print(f"Value error occurred: {e}")

2. Vermeiden Sie Bare-außer:-Klauseln

Bestimmte Ausnahmen abfangen:

• Vermeiden Sie die Verwendung von „exclusive:“, ohne einen Ausnahmetyp anzugeben.
• Dies kann unerwartete Fehler abfangen und das Debuggen erschweren.

try:
    # Code that might raise an exception
except Exception as e:  # Catch all exceptions if necessary
    print(f"An error occurred: {e}")

3. Verwenden Sie try-exclusive-else-finally-Blöcke

• Versuchen Sie: Platzieren Sie hier den Code, der eine Ausnahme auslösen könnte.
• außer: Ausnahmen in diesem Block behandeln.
• sonst: Führen Sie diesen Block aus, wenn im try-Block keine Ausnahme ausgelöst wurde.
• schließlich: Führen Sie diesen Block aus, unabhängig davon, ob eine Ausnahme ausgelöst wurde, die häufig zur Bereinigung verwendet wird.

try:
    # Code that might raise an exception
except ValueError as e:
    print(f"Value error: {e}")
else:
    print("No exceptions occurred.")
finally:
    print("This will always be executed.")

4. Ausnahmen protokollieren

• Verwenden Sie das Protokollierungsmodul, um Ausnahmen zu protokollieren.
• Die Protokollierung hilft bei der Diagnose von Problemen in der Produktion, ohne den Endbenutzern Fehler aufzudecken.

import logging

logging.basicConfig(level=logging.ERROR)

try:
    # Code that might raise an exception
except Exception as e:
    logging.error(f"An error occurred: {e}")

5. Ausnahmen bei Bedarf erneut auslösen

• Wenn Sie eine Ausnahme abfangen, diese aber nicht vollständig verarbeiten können, sollten Sie erwägen, sie erneut auszulösen, damit sie an anderer Stelle behandelt werden kann.

try:
    # Code that might raise an exception
except ValueError as e:
    logging.error(f"Value error: {e}")
    raise  # Re-raise the exception

6. Verwenden Sie Kontextmanager für das Ressourcenmanagement

• Verwenden Sie Kontextmanager (mit Anweisung), um Ressourcen wie Dateien, Sockets oder Datenbankverbindungen zu verwalten.
• Dadurch wird sichergestellt, dass Ressourcen auch dann ordnungsgemäß freigegeben werden, wenn eine Ausnahme ausgelöst wird.

with open('file.txt', 'r') as file:
    content = file.read()

7. Würdevolle Erniedrigung

– Anstatt zuzulassen, dass Ihre Anwendung abstürzt, stellen Sie Fallback-Mechanismen oder benutzerfreundliche Fehlermeldungen bereit.

• Wenn beispielsweise eine Konfigurationsdatei fehlt, können Sie stattdessen Standardeinstellungen verwenden.

try:
    with open('config.json', 'r') as file:
        config = json.load(file)
except FileNotFoundError:
    print("Config file not found, using defaults.")
    config = {"default": "value"}

8. Vermeiden Sie das Verschlucken von Ausnahmen

• Fangen Sie keine Ausnahmen ab, ohne etwas zu unternehmen.
• Das Ignorieren von Ausnahmen kann Fehler verbergen und dazu führen, dass sich die Anwendung unvorhersehbar verhält.

try:
    # Code that might raise an exception
except Exception as e:
    pass  # Bad practice - you're ignoring the error

9. Dokumentausnahmen

• Verwenden Sie Dokumentzeichenfolgen, um die Ausnahmen zu dokumentieren, die Ihre Funktionen auslösen können.
• Dies hilft anderen Entwicklern zu verstehen, welche Ausnahmen zu erwarten sind und wie sie damit umgehen.

def divide(a, b):
    """
    Divides two numbers.

    :param a: Numerator.
    :param b: Denominator.
    :return: The result of the division.
    :raises ZeroDivisionError: If the denominator is zero.
    """
    if b == 0:
        raise ZeroDivisionError("Cannot divide by zero.")
    return a / b

10. Verwenden Sie bei Bedarf benutzerdefinierte Ausnahmen

• Erstellen Sie benutzerdefinierte Ausnahmen, um bestimmte Fehlerbedingungen in Ihrer Anwendung darzustellen.
• Dadurch kann Ihr Code besser lesbar und einfacher zu warten sein.

class InvalidInputError(Exception):
    """Exception raised for invalid inputs."""
    pass

def process_input(value):
    if not isinstance(value, int):
        raise InvalidInputError("Input must be an integer.")
    return value * 2

11. Ausnahmebehandlung testen

• Schreiben Sie Tests, um sicherzustellen, dass Ihre Ausnahmebehandlung wie erwartet funktioniert.
• Verwenden Sie Frameworks wie Unittest oder Pytest, um sowohl Normal- als auch Ausnahmefälle zu testen.

def test_divide():
    assert divide(10, 2) == 5
    with pytest.raises(ZeroDivisionError):
        divide(10, 0)

12. Vermeiden Sie die übermäßige Verwendung von Ausnahmen

Ausnahmen für Ausnahmefälle verwenden:

• Ausnahmen sollten für unerwartete Bedingungen verwendet werden, nicht als regulärer Kontrollflussmechanismus.
• Vermeiden Sie beispielsweise die Verwendung von Ausnahmen, um vorhersehbare Bedingungen wie das Ende einer Schleife zu behandeln.

# Bad practice: using exceptions for control flow
try:
    while True:
        value = next(iterator)
except StopIteration:
    pass  # End of iteration

13. Kettenausnahmen für den Kontext

• Python ermöglicht das Verketten von Ausnahmen, um den ursprünglichen Kontext beizubehalten, wenn eine neue Ausnahme ausgelöst wird.
• Verwenden Sie von, um verwandte Ausnahmen zu verknüpfen.

try:
    result = process_input(input_value)
except InvalidInputError as e:
    raise ValueError("Failed to process input") from e

Durch Befolgen dieser Best Practices können Sie robusteren, wartbareren und lesbareren Ausnahmebehandlungscode schreiben, der Fehler elegant verwaltet und die Zuverlässigkeit Ihrer Anwendung erhöht.

Ressourcen

• Pythons offizielle Dokumentation zur Ausnahmebehandlung
• Dokumentation zum Python-Protokollierungsmodul
• PEP 8 – Style Guide für Python-Code (für allgemeine Codierungspraktiken einschließlich Ausnahmen)
• Echtes Python – Ausnahmebehandlung