wshobson/python-type-safety

Que fait python-type-safety ?

Sécurité des types Python avec annotations, génériques, protocoles et vérification stricte. À utiliser lors de l’ajout d’annotations de type, de l’implémentation de classes génériques, de la définition d’interfaces structurelles ou de la configuration de mypy/pyright.

Vue d’ensemble

Ce skill vous aide à appliquer une sécurité de type rigoureuse dans vos projets Python. Il fournit des modèles et des bonnes pratiques pour :

• Ajouter des annotations de type complètes
• Implémenter des classes génériques et des fonctions
• Définir des protocoles pour des interfaces implicites
• Configurer mypy ou pyright pour une vérification stricte

Utilisation

1. Annoter les fonctions et les méthodes :

   • Utilisez -> Type pour les valeurs de retour.
   • Utilisez : Type pour chaque paramètre.
   • Exemple:

     def ajouter(a: int, b: int) -> int:
         return a + b
     

2. Implémenter des génériques :

   • Utilisez TypeVar pour les types paramétrés.
   • Exemple:

     from typing import TypeVar
     T = TypeVar('T')
     def premier_element(lst: list[T]) -> T | None:
         return lst[0] if lst else None
     

3. Définir des protocoles :

   • Utilisez Protocol pour les interfaces structurelles.
   • Exemple:

     from typing import Protocol
     class Volant(Protocol):
         def voler(self) -> None: ...
     

4. Configurer mypy/pyright :

   • Ajoutez un fichier pyproject.toml ou mypy.ini avec des options strictes.
   • Exemple pour pyproject.toml :

     [tool.mypy]
     strict = true
     disallow_untyped_defs = true
     

Meilleures pratiques

• Annotations obligatoires pour les fonctions publiques.
• Utilisation de Optional[T] ou T | None pour les valeurs nulles.
• Éviter Any autant que possible.
• Tester régulièrement avec mypy ou pyright dans le pipeline CI.

Exemples

Classe générique

from typing import Generic, TypeVar

T = TypeVar('T')

class Boite(Generic[T]):
    def __init__(self, contenu: T) -> None:
        self._contenu = contenu

    def obtenir(self) -> T:
        return self._contenu

Protocole

from typing import Protocol

class Imprimable(Protocol):
    def imprimer(self) -> str: ...

def afficher(obj: Imprimable) -> None:
    print(obj.imprimer())

Ressources

• Documentation mypy
• Documentation pyright
• PEP 484 – Type Hints
• PEP 544 – Protocols