Ergebnis dieses Guides
Eine Funktion mit eindeutigem Vertrag
Arbeitsumgebung
Python mit festgehaltener Interpreterversion und isolierter Projektumgebung
Wann ist diese Entscheidung wichtig?
Eine Funktion sollte aus ihren Parametern und ihrem Rückgabewert verständlich werden. Versteckte globale Abhängigkeiten erschweren Tests und Wiederverwendung.
Trennen Sie Datenverarbeitung von Datei-, Netzwerk- und Konsolenzugriffen. Behandeln Sie veränderliche Listen und Dictionaries bewusst; Typannotationen unterstützen Werkzeuge, erzwingen aber keine automatische Laufzeitvalidierung.
Funktionen: Schritt für Schritt.
- 01
Vorbereiten
Beschreiben Sie Eingaben, Ergebnis und Fehlerfall in einem Satz. Bestimmen Sie, ob ein Seiteneffekt wirklich zur Aufgabe gehört.
- 02
In Python umsetzen
Implementieren Sie eine kleine Funktion und testen Sie Grenzwerte getrennt von Netzwerk oder Datenbank.
- 03
Im tatsächlichen Projekt prüfen
Starten Sie die Prüfung mit demselben Interpreter wie die Anwendung. Kontrollieren Sie fehlende Schlüssel, leere Sammlungen und erwartete Exceptions sowie die verwendeten Paketversionen.
Beispiel zur Überprüfung
So lässt sich das Ergebnis prüfen.
Als Projektkontext dient einen Dienst, der eingehende Dokumente verarbeitet. Der folgende Prüffall ist eine Vorlage für diese Aufgabe und kein Bericht über eine Kundenmessung.
- Eingabe / Auslöser
- Eine normalisierte E-Mail-Adresse und ein leerer Eingabewert
- Erwartetes Ergebnis
- Die Funktion liefert einen dokumentierten Wert oder einen ausdrücklich behandelten Fehler.
- Fehler- oder Grenzfall
- Ein Aufruf verändert keine unbeteiligten Daten oder globalen Einstellungen.
Python · begrenztes Beispiel
def normalize_email(value: str) -> str:
return value.strip().lower()
print(normalize_email(' TEAM@EXAMPLE.ORG '))Die Typannotation beschreibt die erwartete Eingabe, erzwingt aber keine automatische Laufzeitprüfung. Externe Daten und die fachliche Gültigkeit der Adresse müssen gesondert geprüft werden.
Abnahme und typische Fehler.
- Jede Funktion lässt sich mit konkreten Fällen prüfen.
- Ein Aufruf verändert keine unbeteiligten Daten oder globalen Einstellungen.
- Abhängigkeiten und Laufzeitumgebung müssen reproduzierbar sein, besonders bei Datenjobs.
Typischer Fehler
Eine Funktion mit vielen versteckten Nebenwirkungen ist schwer wartbar.
Quellen und Versionshinweis
Die Anleitung beschreibt das Vorgehen; konkrete APIs, Produktfunktionen und Laufzeitgrenzen müssen zur eingesetzten Version passen. Halten Sie Version, Konfiguration und Prüfergebnis im Projekt fest und vergleichen Sie die verlinkte Dokumentation bei Änderungen.
