マスターへのエントリからPythonの戦闘パート12 - 関数パラメータにメタ情報を増やします

機能を書かれ、その後、他のユーザーはこの機能を使用する必要があります正確にどのように知ることができるようになりますので、この関数のパラメータのためのいくつかの追加情報を追加します。

良いアイデアですが、それは正しく、この機能を使用するには、どのようにプログラマを求めなければならない関数パラメータの注釈を使用してください。たとえば、次の機能を注釈を付けされています：

def add(x:int, y:int) -> int:
    return x + y

Pythonインタプリタは、これらのアノテーションのための任意のセマンティクスを追加しません。彼らは無実行時で注釈を付けると隙間がないの効果前に、検査の種類ではありません。しかし、ソースコードを読んでいる人のために友人の面で参考になります。サードパーティ製のツールとフレームワークは、これらのセマンティック注釈を追加することがあります。同時に、彼らはまた、文書に表示されます。

>>> help(add)
Help on function add in module __main__:
add(x: int, y: int) -> int

あなたは（などのオブジェクトインスタンス数、文字列、など）の注釈を追加するために、目的関数のいずれかのタイプを使用できますが、一般的にクラスまたは使用する文字列を言えば、より良いポイントになります。

ファンクション注釈はのみの機能に格納されている  __annotations__ プロパティ。例えば：

>>> add.__annotations__
{'y': <class 'int'>, 'return': <class 'int'>, 'x': <class 'int'>}