Pythonあれこれ 2021-01-31 - 関数アノテーション

概要

「Head First Python 第2版」を進めていった中で考えたことの記録です。

Head First Python 第2版 ―頭とからだで覚えるPythonの基本

Pythonにおける関数アノテーション

• 関数アノテーションは、コンピューターを操作する人間に関数の使い方を伝えるための記述
  • どのような型の値が引数として与えられることを期待するか
  • どのような型の値を戻り値とするか
• 関数アノテーションはオプションである
  • 関数アノテーションを使わなくても、文法上の問題はない
  • ただし、新規のコードにおいては、人間にとっての使いやすさを実現するために関数アノテーションを記述することが推奨される
• 関数アノテーションの有無は、インタプリタの動作に何らの影響も及ぼさない
  • 関数アノテーションがあっても、Pythonインタプリタは引数の型チェックを行わない
  • 関数アノテーションがあっても、Pythonインタプリタは戻り値の型チェックを行わない
  • この点は、厳格な型システムを有する言語（例えばJava）とは異なる動作である
• Pythonが関数アノテーションをサポートするようになったのは、Python3のあるバージョン以降
  • 付加情報としての関数アノテーション…Python 3.0以降
  • 型ヒント…Python 3.5以降
• 関数アノテーションの情報は、以下の方法で参照することができる
  • 組み込み関数のhelp()を用いる
  • IDEの機能により、ポップアップウィンドウの形で表示される

def search4vowels(phrase:str) -> set:
    """指定された単語内の母音を返す。"""
    vowels = set('aeiou')
    return vowels.intersection(set(phrase))

↑関数アノテーションが記述された関数の例search4vowels()。意味は以下。

• search4vowelsの引数phraseには、文字列が与えられることが期待されている
  • 引数定義における、仮引数名の後の:型名
• search4vowelsは集合を返す
  • 引数定義の後の-> 戻り値の型

# 上記search4vowels()がimportされた状態で

help(search4vowels)
# => Help on function search4vowels in module __main__:
# =>
# => search4vowels(phrase: str) -> set
# =>     指定された単語内の母音を返す。

↑組み込み関数のhelp()により、上記search4vowels()関数の関数アノテーションを出力した例。