How can I specify the function type in my type hints?
I want to use type hints in my current Python 3.5 project. My function should receive a function as parameter.
How can I specify the type function in my type hints?
import typing def my_function(name:typing.AnyStr, func: typing.Function) -> None: # However, typing.Function does not exist. # How can I specify the type function for the parameter `func`? # do some processing pass
I checked PEP 483, but could not find a function type hint there.
from typing import AnyStr, Callable def my_function(name: AnyStr, func: Callable) -> None:
Callable on it's own is translated to
Callable[..., Any] which means:
A callable takes any number of/type of arguments and returns a value of any type. In most cases, this isn't what you want since you'll allow pretty much any function to be passed. You want the function parameters and return types to be hinted too.
That's why many
typing have been overloaded to support sub-scripting which denotes these extra types. So if, for example, you had a function
sum that takes two
ints and returns an
def sum(a: int, b: int) -> int: return a+b
Your annotation for it would be:
Callable[[int, int], int]
that is, the parameters are sub-scripted in the outer subscription with the return type as the second element in the outer subscription. In general:
Callable[[ParamType1, ParamType2, .., ParamTypeN], ReturnType]