Як дізнатися тип повернення функції та типи аргументів?

Хоча я знаю концепцію набору тексту качки в Python, іноді я боюся з типом аргументів функцій або типом поверненого значення функції.

Тепер, якщо я написав функцію самостійно, Я ДІЯ знаю типи. Але що, якщо хтось хоче використовувати і викликати мої функції, як він / вона очікує знати типи? Зазвичай я ввожу інформацію про тип у документацію функції (наприклад: "...the id argument should be an integer..."and "... the function will return a (string, [integer]) tuple.")

Але чи шукати інформацію в документі (і розміщувати її там як кодер) справді так, як це передбачається робити?

Редагувати: Хоча, мабуть, більшість відповідей спрямовують на "так, документ!" Я вважаю, що це не завжди дуже просто для `` складних '' типів.
Наприклад: як коротко описати в документі, що функція повертає список кортежів із кожним кортежем форми (node_id, node_name, uptime_minutes) і що елементами є відповідно рядок, рядок і ціле число?
Документація PEP-документації не містить жодних вказівок щодо цього.
Я думаю, контраргументом буде те, що в такому випадку слід використовувати класи, але я вважаю python дуже гнучким, оскільки він дозволяє передавати ці речі за допомогою списків та кортежів, тобто без класів.

Ну, з 2011 року все трохи змінилося! Тепер у Python 3.5 є підказки щодо типів, за допомогою яких можна анотувати аргументи та повертати тип вашої функції. Наприклад це:

def greeting(name):
  return 'Hello, {}'.format(name)

тепер можна записати так:

def greeting(name: str) -> str:
  return 'Hello, {}'.format(name)

Як тепер ви можете бачити типи, існує якась необов’язкова перевірка статичного типу, яка допоможе вам та вашому засобу перевірки типу дослідити ваш код.

для більш детального пояснення я пропоную поглянути на публікацію в блозі про підказки щодо типу в блозі PyCharm .

Ось як працюють динамічні мови. Однак це не завжди добре, особливо якщо документація погана - хтось намагався використовувати погано задокументований фреймворк python? Іноді доводиться повертатися до читання джерела.

Ось кілька стратегій, щоб уникнути проблем із набором качок:

• створити мову для проблемного домену
• це допоможе вам правильно називати речі
• використовувати типи для представлення концепцій мовою вашого домену
• параметри функції імені, використовуючи словниковий запас мови домену

Крім того, один з найважливіших моментів:

• зберігайте дані якомога локальнішими!

Потрібно передавати лише кілька чітко визначених та задокументованих типів. Все інше повинно бути очевидним, дивлячись на код: Не майте дивних типів параметрів здалеку, які ви не зможете зрозуміти, подивившись поблизу коду ...

Пов’язаний (і також пов’язаний із документами) у пітоні існує техніка, яка називається doctests. Використовуйте це, щоб задокументувати, як передбачається використовувати ваші методи - і одночасно мати гарне охоплення модульним тестом!

Так, вам слід використовувати docstrings, щоб зробити ваші класи та функції більш дружніми до інших програмістів:

Більше: http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring

Деякі редактори дозволяють бачити текстові рядки під час набору тексту, тому це справді полегшує роботу.

Я відвідував курс курсу, був урок, на якому нас навчали про дизайнерські рецепти.

Нижче формату документації я знайшов preety корисним.

захисна зона (основа, висота):
    '' '(число, число) -> номер # ** TypeContract **
    Повернення площі трінг з розмірами підстава # ** Опис **
    і висота

    >>> область (10,5) # ** Приклад **
    25,0
    >> площа (2,5,3)
    3.75
    ''
    повернення (основа * висота) / 2 

Думаю, якщо такі документи написані таким чином, це може дуже допомогти розробникам.

Посилання на відео [Перегляньте відео] : https://www.youtube.com/watch?v=QAPg6Vb_LgI

Так.

У Python функція не завжди повинна повертати змінну того самого типу (хоча ваш код буде більш читабельним, якщо ваші функції завжди повертають один і той же тип). Це означає, що ви не можете вказати єдиний тип повернення для функції.

Так само параметри не завжди повинні бути однотипними.

Наприклад: як коротко описати в документі, що функція повертає список кортежів, з кожним кортежем форми (node_id, node_name, uptime_minutes) і що елементами є відповідно рядок, рядок і ціле число?

Гм ... Немає "стислого" опису цього. Це складно. Ви спроектували його як складний. І це вимагає складної документації в документації.

Вибачте, але складність - ну - складна.

Так, оскільки це мова динамічного типу;)

Прочитайте це для довідки: PEP 257

Документи (та документація загалом). Python 3 вводить (необов’язкові) анотації функцій, як описано в PEP 3107 (але не залишайте рядки документації)