forked from trekhleb/learn-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_function_annotations.py
More file actions
32 lines (21 loc) · 1.24 KB
/
Copy pathtest_function_annotations.py
File metadata and controls
32 lines (21 loc) · 1.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
"""Function Annotations.
@see: https://docs.python.org/3/tutorial/controlflow.html#function-annotations
Function annotations are completely optional metadata information about the types used
by user-defined functions.
Annotations are stored in the __annotations__ attribute of the function as a dictionary and have no
effect on any other part of the function. Parameter annotations are defined by a colon after the
parameter name, followed by an expression evaluating to the value of the annotation. Return
annotations are defined by a literal ->, followed by an expression, between the parameter list and
the colon denoting the end of the def statement.
"""
def breakfast(ham: str, eggs: str = 'eggs') -> str:
"""Breakfast creator.
This function has a positional argument, a keyword argument, and the return value annotated.
"""
return ham + ' and ' + eggs
def dinner(name: str, place: str = 'restaurant', people_number: int = 5) -> str:
return name, ' and ', place, ' and ', people_number
def test_function_annotations():
"""Function Annotations."""
assert breakfast.__annotations__ == {'eggs': str, 'ham': str, 'return': str}
assert dinner.__annotations__ == {'name': str, 'place': str, 'people_number': int, 'return': str}