Pythonデータサイエンスハンドブック ―Jupyter、NumPy、pandas、Matplotlib、scikit-learnを使ったデータ分析、機械学習

1.2

 

IPython

のヘルプシステムとドキュメント

5

この仕組みは自分で作ったオブジェクトや関数に対しても働くという点が重要です。

docstring

付きの簡単な関数を定義してみましょう。

In [6]: def square(a):

....: """Return the square of a.""" a

の

2

乗を返す

....: return a ** 2

....:

自作の関数の

docstring

は、単純に最初の行に文字列リテラルを配置 するだけです。普通、

docstring

の内容は複数行に渡るため、二重引用符を

3

つ続ける記法を慣習的に使います。

それでは

?

を使って関数の

docstring

を表示してみましょう。

In [7]: square?

Type: function

String form: <function square at 0x103713cb0>

Definition: square(a)

Docs

tring: Return the square of a. a

の

2

乗を返す

docstring

を介してドキュメントへ迅速にアクセスできることが、自分の書いたコードにこのよ

うなドキュメントを埋め込む習慣を付ける理由の

1

つです。

1.2.2

 

??

文字を使ったソースコードの探索

Python

言語は、読みやすさを重視しているため、興味のあるオブジェクトのソースコードから

洞察を得ることもしばしばあります。

IPython

はソースコードを表示する

2

つのクエスチョンマー

ク（

??

）によるショートカットを提供しています。 ...