シラバス レッスン 250 中 25 · 関数
関数

docstring と型ヒント

ちょっとした 2 つの工夫で、動くだけの関数がプロの関数になります:docstring と型ヒントです。

docstring は、関数本体のいちばん最初の行に置く文字列リテラルです。関数が何をするかを説明します。ツールや help() がそれを読み、Python はそれを function.__doc__ に保存します:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

三重引用符を使うと docstring を複数行にでき、長めの説明に便利です。

型ヒントは、引数と戻り値がどんな型であることを期待しているかを書き添えるものです。各引数には name: type を、戻り値には -> type を書きます:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

ヒントは実行時には何も強制しません。文字列を渡しても Python は止めません。ヒントは、エディターやチェッカーが間違いを早めに見つけるために使うドキュメントであり、シグネチャを見ただけで意味がわかるようにしてくれます。よく使うヒントの型には int、float、str、bool があります。

ここからは、両方を備えた関数を書きましょう:わかりやすい docstring と正直な型ヒントです。

あなたの番

型ヒント def multiply(a: int, b: int) -> int: と、正確に Return the product of a and b. と書かれた docstring(本体の最初の行)を持つ関数 multiply を定義してください。本体は return a * b とします。

このレッスンに問題を見つけましたか?報告する · このレッスンについて質問する

この演習はまもなく開きます

その前のレッスンを終えると、このレッスンが解放されます。コース全体が無料でアカウントも不要、このレッスンは今すぐ読めます。