【Python】関数の使い方が思い出せなければdocstringを確認すればいい【__doc__】

【Python】関数の使い方が思い出せなければdocstringを確認すればいい【__doc__】

はじめに

コジマです。

Pythonで使いたい関数のdocstringを見る方法を紹介する記事です。

docstringとは

簡単に言うと、javadocやperldocなんかのPython版。
モジュールや関数の使い方が書いてある。

この記事ではdocstring自体には深入りしないです。

実際に見てみる

見方は超簡単

モジュール名や関数名の後ろに.__doc__とつけてprintするだけ。

numpyモジュールのdocstringを見てみましょう。
docstringにはnumpyスタイルと言うものがあるくらいなので、例にちょうどいいかと思いました。

そうするとこんな感じでべろーーーっと出てきます。これがdocstringです。

np.arrayメソッドのdocstringも見てましょう。

このように関数の使い方が記載されています。

docstringは自作の関数に対して自分で書くこともできるので、それはまた別の機会に。

さいごに

docstringを表示する方法について書きました。

  • モジュールについて深く知りたい
  • 関数の使い方を思い出したい

なんて場合に非常に便利です。

この記事を面白いまたは役に立ったと思ってくれた方は是非私のTwitter(@kojimanotech)を
フォローしてくれたらうれしいです!

以上、コジマでした。


Pythonカテゴリの最新記事