Python type hint for classes that support __getitem__

by

If you’re willing to install a not-quite-offical extension to typing, typing-extensions, you can use a Protocol, which should be an implementation of PEP-0544:

from typing_extensions import Protocol
from typing import Any

class GetItem(Protocol):
    def __getitem__(self: 'Getitem', key: Any) -> Any: pass

class BadGetItem:
    def __getitem__(self, a: int, b: int) -> Any: pass

def do_thing(arg: GetItem):
    pass

do_thing(dict())  # OK
do_thing(BadGetItem())  # Fails with explanation of correct signature
do_thing(1)  # Fails

More Related Contents:

  1. How to specify multiple return types using type-hints
  2. Type hinting a collection of a specified type
  3. What are type hints in Python 3.5?
  4. Using the class as a type hint for arguments in its methods [duplicate]
  5. How to use type hints in python 3.6?
  6. Type annotations for *args and **kwargs
  7. Subclass in type hinting
  8. How can I tell PyCharm what type a parameter is expected to be?
  9. How should I use the Optional type hint?
  10. What’s the difference between a constrained TypeVar and a Union?
  11. typing: Dynamically Create Literal Alias from List of Valid Values
  12. Exclude type in Python typing annotation
  13. Can you annotate return type when value is instance of cls?
  14. Python 3 dictionary with known keys typing
  15. Specify length of Sequence or List with Python typing module
  16. Defining a recursive type hint in Python?
  17. Can I omit Optional if I set default to None?
  18. Using List/Tuple/etc. from typing vs directly referring type as list/tuple/etc
  19. How do I annotate types in a for-loop?
  20. mypy, type hint: Union[float, int] -> is there a Number type?
  21. Name not defined in type annotation [duplicate]
  22. Python 3.5 type hinting does not result in an error
  23. Type hints in namedtuple
  24. How to annotate function that takes a tuple of variable length? (variadic tuple type annotation)
  25. typing.Any vs object?
  26. Python typing for module type
  27. Recursive Typing in Python 3.5+ [duplicate]
  28. How to type hint a dictionary with values of different types
  29. What is the type hint for a (any) python module?
  30. How to annotate a type that’s a class object (instead of a class instance)?

Leave a Comment