Як зрозуміти підказки для функцій та методів
Цей допис йде як доповнення до відео про підказки для функцій та методів
Тут немає детальних пояснень, тільки вивід підказок.
Розбираємося з тим, що показує у підказках ipython та редактори/IDE.
Залежно від того, як було створено метод або функцію, ipython/editor/IDE може відображати різні типи підказок. Крім того, підказки можуть відрізнятися між ipython і редактором.
Приклад створення функції та відображення підказки для неї:
def sum_numbers(num1, num2):
"""
Функція обчислює суму двох чисел
"""
return num1 + num2
In [3]: sum_numbers(100, 42)
Out[3]: 142
In [4]: sum_numbers?
Signature: sum_numbers(num1, num2) # (1)
Docstring: Функція обчислює суму двох чисел # (2)
File: ~/repos/.../<ipython-input-2> # (3)
Type: function # (4)
- Опис функції зазвичай дорівнює рядку, за допомогою якого була створена функція.
- Рядок документації функції. Опис роботи функції зазвичай створений людиною.
- Де була створена функція (в якому файлі).
- Тип об'єкту: function для функцій, method для методів, builtin_function_or_method для деяких вбудованих функцій