Type Hints machen mgpy-Reports praeziser, weil oeffentliche API-Grenzen, Rueckgabewerte und Datenmodelle klarer pruefbar werden.
Kernpunkte
- CLI: Unter Windows zeigen die Beispiele den empfohlenen Aufruf via
py -3.12 -m <modul> ...(z.B.py -3.12 -m manifestguard ...). Auf Linux/macOS entspricht das in der Regelpython3.12 -m .... - Annotiere zuerst oeffentliche Funktionen, Datenmodelle und Rueckgabeobjekte.
- Kombiniere Type Hints mit klaren Docstrings statt dieselbe Information doppelt und widerspruechlich zu pflegen.
- Wenn ein Paket typsicher genutzt werden soll, gehoeren
py.typedund stabile Imports zur Gesamtloesung.
Empfohlener MG-Python-Workflow
- Mit den wichtigsten Ein- und Ausstiegspunkten der Bibliothek beginnen.
- Nach jeder Annotierungsrunde MyPy oder aehnliche Typpruefung gegen die echten Nutzungspfade laufen lassen.
- Danach mgpy erneut ausfuehren, damit Packaging- und API-Kontrakte konsistent bleiben.
Schnellstart
python -m mypy src
py -3.12 -m manifestguard check --extended
py -3.12 -m manifestguard schema --output openapi.json