Ergebnis dieses Guides
Eine kleine öffentliche Schnittstelle
Arbeitsumgebung
Python mit festgehaltener Interpreterversion und isolierter Projektumgebung
Wann ist diese Entscheidung wichtig?
Module begrenzen Zuständigkeiten und Abhängigkeiten. Ihre öffentliche Schnittstelle sollte kleiner sein als ihre interne Umsetzung.
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.
Module: Schritt für Schritt.
- 01
Vorbereiten
Listen Sie benötigte Exporte und deren Verbraucher auf. Trennen Sie Bibliothekslogik von ausführbarem Startcode.
- 02
In Python umsetzen
Importieren Sie nur die ausdrücklich freigegebenen Funktionen. Vermeiden Sie Kreisabhängigkeiten und Seiteneffekte beim Laden eines Moduls.
- 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 Funktion wird aus einem zweiten Modul aufgerufen
- Erwartetes Ergebnis
- Der Import funktioniert mit der vorgesehenen Laufzeit und dem Projekt-Build.
- Fehler- oder Grenzfall
- Ein bloßer Import öffnet keine Datenbankverbindung und startet keine unerwartete Hintergrundarbeit.
Abnahme und typische Fehler.
- Eine Änderung hat einen überschaubaren Wirkungsbereich.
- Ein bloßer Import öffnet keine Datenbankverbindung und startet keine unerwartete Hintergrundarbeit.
- Abhängigkeiten und Laufzeitumgebung müssen reproduzierbar sein, besonders bei Datenjobs.
Typischer Fehler
Zirkuläre Importe und riesige Sammelmodule verwischen Grenzen.
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.
