Beta
Product

Annotations de type

Ajouter et valider des annotations de type Python pour ameliorer la couverture de l analyse statique.

Retour

Les annotations de type rendent les rapports mgpy plus precis, car les frontieres de l API publique, les valeurs de retour et les modeles de donnees deviennent plus faciles a verifier.

Points cles

  • CLI: Sous Windows, les exemples utilisent la forme recommandee py -3.12 -m <module> ... (par ex. py -3.12 -m manifestguard ...). Sous Linux/macOS, cela correspond generalement a python3.12 -m ....
  • Annoter d abord les fonctions publiques, les modeles de donnees et les objets de retour.
  • Associer annotations de type et docstrings clairs au lieu de maintenir deux sources contradictoires.
  • Si le package doit etre consomme comme code type, py.typed et des imports stables font partie de la solution.

Workflow mgpy recommande

  1. Commencer par les principaux points d entree et de sortie de la bibliotheque.
  2. Apres chaque lot d annotations, lancer MyPy ou un verificateur equivalent sur les chemins d usage reels.
  3. Executer ensuite mgpy pour garder alignes packaging et contrats d API.

Demarrage rapide

python -m mypy src
py -3.12 -m manifestguard check --extended
py -3.12 -m manifestguard schema --output openapi.json