Type annotations for *args and **kwargs

by

For variable positional arguments (*args) and variable keyword arguments (**kw) you only need to specify the expected value for one such argument.

From the Arbitrary argument lists and default argument values section of the Type Hints PEP:

Arbitrary argument lists can as well be type annotated, so that the definition:

def foo(*args: str, **kwds: int): ...

is acceptable and it means that, e.g., all of the following represent function calls with valid types of arguments:

foo('a', 'b', 'c')
foo(x=1, y=2)
foo('', z=0)

So you’d want to specify your method like this:

def foo(*args: int):

However, if your function can only accept either one or two integer values, you should not use *args at all, use one explicit positional argument and a second keyword argument:

def foo(first: int, second: Optional[int] = None):

Now your function is actually limited to one or two arguments, and both must be integers if specified. *args always means 0 or more, and can’t be limited by type hints to a more specific range.

More Related Contents:

  1. How do I type hint a method with the type of the enclosing class?
  2. What are variable annotations?
  3. Type hints: solve circular dependency [duplicate]
  4. Type hinting a collection of a specified type
  5. Using the class as a type hint for arguments in its methods [duplicate]
  6. How to use type hints in python 3.6?
  7. How to specify “nullable” return type with type hints
  8. How can I tell PyCharm what type a parameter is expected to be?
  9. Python type hinting without cyclic imports
  10. What’s the difference between a constrained TypeVar and a Union?
  11. Type hints when unpacking a tuple?
  12. typing: Dynamically Create Literal Alias from List of Valid Values
  13. Exclude type in Python typing annotation
  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. A way to subclass NamedTuple for purposes of typechecking
  18. How to annotate types of multiple return values?
  19. Using List/Tuple/etc. from typing vs directly referring type as list/tuple/etc
  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. How to annotate function that takes a tuple of variable length? (variadic tuple type annotation)
  24. typing.Any vs object?
  25. Python typing for module type
  26. Python type hint for classes that support __getitem__
  27. How to type hint a dictionary with values of different types
  28. Type Hinting for objects of type that’s being defined [duplicate]
  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