Type hint for a function that returns only a specific set of values

by

You can do that with literal types.

from typing_extensions import Literal
# from typing import Literal  # Python 3.8 or higher

def fun(b: int) -> Literal["a", "b", "c"]:
    if b == 0:
        return "a"
    if b == 1:
        return "b"
    return "d"

mypy is able to detect the return "d" as a invalid statement:

error: Incompatible return value type (got "Literal['d']",
expected "Union[Literal['a'], Literal['b'], Literal['c']]")

Python 3.8

Thanks to the PEP 586, the Literal is already included by default in the Python 3.8 typing module.

More Related Contents:

  1. How do I type hint a method with the type of the enclosing class?
  2. What are variable annotations?
  3. How to specify multiple return types using type-hints
  4. How can I specify the function type in my type hints?
  5. Type hinting a collection of a specified type
  6. What are type hints in Python 3.5?
  7. Using the class as a type hint for arguments in its methods [duplicate]
  8. How to use type hints in python 3.6?
  9. How to specify “nullable” return type with type hints
  10. How should I use the Optional type hint?
  11. Type hints when unpacking a tuple?
  12. Exclude type in Python typing annotation
  13. Python type hinting with exceptions
  14. Type hinting / annotation (PEP 484) for numpy.ndarray
  15. Can I omit Optional if I set default to None?
  16. Name not defined in type annotation [duplicate]
  17. Python 3.5 type hinting does not result in an error
  18. Type annotations for Enum attribute
  19. How to annotate function that takes a tuple of variable length? (variadic tuple type annotation)
  20. Recursive Typing in Python 3.5+ [duplicate]
  21. What is the type hint for a (any) python module?
  22. Type annotations for *args and **kwargs
  23. How can I tell PyCharm what type a parameter is expected to be?
  24. What’s the difference between a constrained TypeVar and a Union?
  25. Using List/Tuple/etc. from typing vs directly referring type as list/tuple/etc
  26. “TypeError: ‘type’ object is not subscriptable” in a function signature
  27. typing.Any vs object?
  28. How to type hint a dictionary with values of different types
  29. Weird MRO result when inheriting directly from typing.NamedTuple
  30. How to annotate a type that’s a class object (instead of a class instance)?

Leave a Comment