Każdy programista pracujący w języku z dynamicznym systemem typowania słyszał pewnie ten żart: “chodzi jak kaczka, kwacze jak kaczka, rzuca wyjątki podczas działania programu jak kaczka - to musi być kaczka!”. Możemy zarzekać się, że to nieprawda, ale niech pierwszy rzuci kamień ten, kto nigdy nie pomylił typu argumentów przekazanych do funkcji czy też nie wywołał metody, której dany obiekt nie posiada i... przekonał się o swojej pomyłce dopiero “na produkcji”. Oczywiście przy małych projektach lub takich, które mają 100% pokrycie testami, problem braku typów może zejść na drugi plan. Jednak rzeczywistość wygląda najczęściej inaczej - piszemy duże projekty, a pokrycie staramy się utrzymać na sensownym, ale nie fanatycznie wysokim poziomie. W mojej prezentacji przedstawię mechanizm type hints jako technikę ułatwiającą rozwijanie i utrzymywanie projektów w języku Python. Podczas wystąpienia zaprezentuję techniczną stronę tego rozwiązania oraz dostępne narzędzia. Opowiem także o moim doświadczeniu we wprowadzaniu type hints w projektach, w których brałem udział. Ponadto pokażę jak type hinting otwierają drogę dla technik, które wcześniej nie były popularne w świecie języka Python - np wstrzykiwanie zależności.

1. Type hints w języku Python
Konrad Hałas
4Developers 2018

6. Plan
type hints
dlaczego?
składnia
narzędzia
biblioteki
projekty legacy

7. def notify_everyone(items):
for item in items:
item.owner.notify()

8. def cancel_all(items):
notify_everyone(items)
...

9. Rozwiązania
dokumentacja zewnętrzna
dokumentacja w kodzie (RST, epytext, NumPy, Google)
przepisać wszystko do języka statycznie typowanego

11. def count_unique_words(text, case_sensitive):
...

12. def count_unique_words(text: str, case_sensitive: bool) ‑> int:
...

13. def median(values: list) ‑> float:
...

14. from typing import List
def median(values: List[float]) ‑> float:
...

15. from typing import Dict
def count_chars(text: str) ‑> Dict[str, int]:
...

16. from typing import List
class Point:
...
def calculate_area(vertices: List[Point]) ‑> float:
...

17. from typing import Optional
def total_amount(order: Order, discount: Optional[Discount]) ‑> Money:
...

18. from typing import List, Union
def send_confirmation(email: Union[str, List[str]]) ‑> None:
...

19. from typing import Any
def get_most_frequent(items: list) ‑> Any:
...

20. from typing import List, TypeVar
T = TypeVar('T')
def get_most_frequent(items: List[T]) ‑> T:
...

22. from typing import List
class Item:
...
class Basket:
def __init__(self):
self.items: List[Item] = []
def add_item(self, item: Item):
self.items.append(item)

23. Narzędzia
mypy
PyCharm
...

24. def total_price(items: List[Item], discount: Optional[float] = None) ‑> float:
...

25. def total_price(items: List[Item], discount: Optional[float] = None) ‑> float:
result = 0.0
for item in items:
result += item.count * item.product.price
result ‑= discount
return result

26. def total_price(items: List[Item], discount: Optional[float] = None) ‑> float:
result = 0.0
for item in items:
result += item.count * item.product.price
result ‑= discount
return result
$ mypy ‑‑strict example.py
example.py:9: error: "Item" has no attribute "count"
example.py:10: error: Unsupported operand types for ‑ ("float" and "Optional[float]")

27. def total_price(items: List[Item], discount: Optional[float] = None) ‑> float:
result = 0.0
for item in items:
result += item.quantity * item.product.price
if discount:
result ‑= discount
return result
$ mypy ‑‑strict example.py

30. Biblioteki
injector
dacite
...

31. def register_user(user_details: UserDetails):
...

32. from users.repositories import UsersRepository
def register_user(user_details: UserDetails):
...
repository = UsersRepository()
repository.create_user(...)

33. class UsersService:
def __init__(self, repository: UsersRepository):
self.repository = repository
def register_user(self, user_details: UserDetails):
...
self.repository.create_user(...)

34. class UsersRepository:
def __init__(self, data_base: DataBase):
self.data_base = data_base
def create_user(self, user: User):
...
self.data_base.insert(...)

35. class DataBase:
def __init__(self, session: DataBaseSession):
self.session = session
...

36. session = DataBaseSession(...)
data_base = DataBase(session)
users_repository = UsersRepository(data_base)
users_service = UsersService(users_repository)

37. class DataBaseSession:
...
class DataBase:
def __init__(self, session: DataBaseSession):
...
class UsersRepository:
def __init__(self, database: DataBase):
...
class UsersService:
def __init__(self, repository: UsersRepository):
...

38. from injector import inject
class DataBaseSession:
...
class DataBase:
@inject
def __init__(self, session: DataBaseSession):
...
class UsersRepository:
@inject
def __init__(self, database: DataBase):
...
class UsersService:
@inject
def __init__(self, repository: UsersRepository):
...

39. from injector import Injector
users_service = Injector().get(UsersService)

40. from dataclasses import dataclass
@dataclass
class User:
name: str
age: int
is_active: bool
user = User(name='John', age=30, is_active=True)

41. import dacite
data = {
'name': 'John',
'age': 30,
'is_active': True,
}
user = dacite.from_dict(data_class=User, data=data)
assert user == User(name='John', age=30, is_active=True)

42. Type hints w projekcie legacy
gradual typing
statyczna analiza uruchamiana w ramach CI
wymuszanie type annotations dla:
kluczowych modułów
interfejsów

43. Podsumowanie
zrozumiały kod
mniej błędów
nowe możliwości

44. Dziękuję!
@konradhalas / konradhalas.pl

45. Zdjęcia
Jacek Kołodziej ‑ http://kolodziejj.info/
Korsan Studio ‑ http://facebook.com/korsanstudio

46. Narzędzia/biblioteki
mypy ‑ http://mypy‑lang.org
PyCharm ‑ https://www.jetbrains.com/pycharm
dacite ‑ https://github.com/konradhalas/dacite
injector ‑ https://github.com/alecthomas/injector