プログラミング

初心者のPython入門(ヘルプを表示するhelp関数の使い方)

2019年7月6日

Pythonでヘルプを表示するhelp関数の使い方です。(Pythonの標準関数です。)

Pythonの標準関数一覧はこちらです。

ヘルプとは

関数の使い方や引数の情報です。help関数によって表示することができます。

標準関数ですが、プログラム中で動作させる関数ではなく、プログラム作成中に関数の使い方を確認するために使います。

プログラム中から呼び出してヘルプ表示することも出来ますが、そういった使い方はしないですね。

help関数の使い方

help([object])

objectのヘルプを表示します。引数無しで起動するとヘルプシステムが起動して、入力した関数のヘルプ表示を連続して行うことが出来ます。

引数付きで呼び出すと、引数で指定した関数のヘルプが表示されます。

Anacondaプロンプトからpythonを起動し、max関数のヘルプを表示してみます。

>>> help(max)
Help on built-in function max in module builtins:

max(...)
    max(iterable, *[, default=obj, key=func]) -> value
    max(arg1, arg2, *args, *[, key=func]) -> value

    With a single iterable argument, return its biggest item. The
    default keyword-only argument specifies an object to return if
    the provided iterable is empty.
    With two or more arguments, return the largest argument.

>>>

日本語のヘルプは表示されません。

Spyderでプログラムを作っている場合は、コンソールで上helpを使うことが出来ます。JyupyterLabはNotebookでヘルプ関数を記述して実行すればヘルプを表示することができます。

ただ、関数の使い方はWebで情報が見れるので、私はhelp関数は使わないと思います。

-プログラミング
-, ,

© 2020 小さなことをやってみるブログ