Pythonでは、関数の引数や返り値に注釈(アノテーション)をつけることができます。これは、関数の引数や返り値の型を明確に記述するための機能で、コードの共有や他人のコードの解読を容易にします。
アノテーションの基本的な使い方
アノテーションの基本的な使い方は次のとおりです。
- 関数の引数に期待する型は、引数の後に、コロン
:
を付けて示す。 - 戻り値に期待する型は、引数の閉じカッコの後に、矢印
->
を付けて示す。
例えば、次のように記述します。
def add(x: int, y: int) -> int:
return x + y
この例では、関数 add
の引数 x
と y
が整数であることを示し、戻り値も整数であることを示しています。
アノテーションの利点
アノテーションは、コードの可読性を向上させ、エラーの発見を容易にします。特に、大規模なプロジェクトやチームでの開発では、アノテーションの使用は非常に有用です。
また、Pythonのアノテーションは実行時には無視されるため、パフォーマンスに影響を与えません。
注意点
アノテーションは、Pythonの動的型付けの性質を変えるものではありません。つまり、アノテーションが指定した型と異なる値を関数に渡したり、異なる型の値を返したりしても、Pythonはエラーを発生させません。
しかし、型チェッカー(例えば mypy
)を使用すると、アノテーションに違反するコードを検出できます。
まとめ
Pythonの関数アノテーションは、コードの可読性を向上させ、エラーの発見を容易にする強力なツールです。Pythonコードを書く際には、積極的に利用することをお勧めします。