Annotation de type Python pour le type de canard personnalisé

Question

Le module typing de Python définit un nombre de types de canard, par exemple, typing.SupportsAbs pour représenter tout type qui implémente la méthode spéciale __abs__.

Est-il possible de définir des types de canard personnalisés d'une manière telle que je puisse les utiliser comme des annotations de type valides?

Par exemple, je voudrais pouvoir annoter qu'un argument doit être un équivalent de type canard d'un threading.Lock, à savoir, tout objet qui implémente acquire et release méthodes. Idéalement, je pourrais annoter un tel argument comme SupportsAcquireAndRequire ou DuckLock, plutôt que object.

Answer 1

Vous pouvez définir un abstract base class (ABC) pour spécifier l'interface:

from abc import ABCMeta, abstractmethod 

class SupportsAcquireAndRequire(metaclass=ABCMeta): 
    @abstractmethod 
    def acquire(self): 
     pass 

    @abstractmethod 
    def release(self): 
     pass 

    @classmethod 
    def __subclasshook__(cls, C): 
     for method in ('release', 'acquire'): 
      for B in C.__mro__: 
       if method in B.__dict__: 
        if B.__dict__[method] is None: 
         return NotImplemented 
        break 
      else: 
       return NotImplemented 
     return True 

C'est fondamentalement la façon dont les protocoles (comme typing.SupportsAbs) sont mises en œuvre, mais sans directement à l'aide ABCMeta.

En donnant l'ABC un __subclasshook__ method, vous pouvez l'utiliser dans isinstance() et issubclass() tests, ce qui est plus assez bon pour des outils tels que mypy:

>>> from threading import Lock 
>>> isinstance(Lock(), SupportsAcquireAndRequire) 
True