関数の戻り値の型と引数の型を知る方法は？

Question 1

私はPythonのダックタイピングの概念を知っていますが、関数の引数のタイプや関数の戻り値のタイプに苦労することがあります。

さて、私が自分で関数を書いた場合、私はタイプを知っています。しかし、誰かが私の関数を使用して呼び出したい場合、その人はどのようにして型を知ることが期待されますか？私は通常、関数のdocstringに型情報を入れます（："...the id argument should be an integer..."や"... the function will return a (string, [integer]) tuple."）

しかし、docstring内の情報を検索する（そしてそれをコーダーとしてそこに置く）ことは、実際にそれが行われることになっている方法ですか？

編集：回答の大部分は「はい、文書化してください」に向けられているようですが。「複雑な」タイプの場合、これは必ずしも簡単ではないと思います。
例：関数がタプルのリストを返し、各タプルが形式（node_id、node_name、uptime_minutes）であり、要素がそれぞれ文字列、文字列、整数であることをdocstringで簡潔に説明するにはどうすればよいですか？
docstring PEPのドキュメントには、そのガイドラインはありません。
その場合はクラスを使用する必要があるという反論があると思いますが、Pythonはリストとタプルを使用して、つまりクラスなしでこれらを渡すことができるため、非常に柔軟です。

Question 2

さて、2011年から状況は少し変わりました！今すぐそこだタイプのヒントあなたは注釈の引数に使用し、あなたの関数の型を返すことができますPythonの3.5インチ例：これ：

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

これで次のように書くことができます：

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

これで型を確認できるように、ユーザーと型チェッカーがコードを調査するのに役立つ、ある種のオプションの静的型チェックがあります。

詳細については、PyCharmブログのタイプヒントに関するブログ投稿を参照することをお勧めします。

Question 3

これが動的言語の仕組みです。ただし、特にドキュメントが不十分な場合は、必ずしも良いことではありません。ドキュメントが不十分なPythonフレームワークを使用しようとした人はいますか？ソースの読み取りに戻らなければならない場合があります。

ダックタイピングの問題を回避するためのいくつかの戦略は次のとおりです。

問題のあるドメインの言語を作成する
これは、適切な名前を付けるのに役立ちます
タイプを使用してドメイン言語で概念を表す
ドメイン言語の語彙を使用した名前関数パラメーター

また、最も重要なポイントの1つ：

データを可能な限りローカルに保ちます！

明確に定義され、文書化されたタイプがいくつか渡されるだけです。コードを見れば、他のことは明らかです。コードの近くを見ても理解できないような、遠くから来る奇妙なパラメータタイプはありません...

関連して（そしてdocstringにも関連して）、Pythonにはdoctests。と呼ばれるテクニックがあります。これを使用して、メソッドがどのように使用されると予想されるかを文書化します。同時に、優れた単体テストカバレッジを実現します。

Question 4

コーセラコースに参加し、デザインレシピを教えてもらうレッスンがありました。

docstring形式の下では、preetyが便利だと思いました。

def area（base、height）：
    '' '（数値、数値）->数値＃** TypeContract **
    寸法がベースのトリングの面積を返します＃**説明**
    と高さ

    >>> area（10,5）＃**例**
    25.0
    >>エリア（2.5,3）
    3.75
    '' '
    リターン（ベース*高さ）/ 2

docstringがこのように書かれていれば、開発者にとって大いに役立つかもしれないと思います。

ビデオへのリンク[ビデオをご覧ください]：https：//www.youtube.com/watch？v = QAPg6Vb_LgI

Question 5

はい、docstringを使用して、クラスと関数を他のプログラマーにとってより使いやすくする必要があります。

詳細：http：//www.python.org/dev/peps/pep-0257/#what-is-a-docstring

一部のエディターでは、入力中にdocstringを表示できるため、作業が非常に簡単になります。

Question 6

はい、そうです。

Pythonでは、関数が常に同じ型の変数を返す必要はありません（ただし、関数が常に同じ型を返すと、コードが読みやすくなります）。つまり、関数に単一の戻り値の型を指定することはできません。

同様に、パラメータも常に同じタイプである必要はありません。

Question 7

例：関数がタプルのリストを返し、各タプルが形式（node_id、node_name、uptime_minutes）であり、要素がそれぞれ文字列、文字列、整数であることをdocstringで簡潔に説明するにはどうすればよいですか？

ええと...これについての「簡潔な」説明はありません。複雑です。あなたはそれを複雑になるように設計しました。また、docstringに複雑なドキュメントが必要です。

申し訳ありませんが、複雑さは-まあ-複雑です。

Question 8

はい、動的に型付けされた言語なので;）

参考のためにこれを読んでください：PEP 257

Question 9

Docstrings（および一般的なドキュメント）。Python 3では、PEP 3107で説明されているように、（オプションの）関数アノテーションが導入されています（ただし、docstringを省略しないでください）。