【Python入門】もう迷わない!help()関数はあなたの隣にいる最高の相棒

こんにちは。ゆうせいです。

プログラミングの学習を始めたばかりの時、こんな経験はありませんか?

「この関数の使い方、なんだっけ?」

「引数に何を指定すればいいのか、すぐに思い出せない…」

ドキュメントを毎回インターネットで検索するのも、少し手間がかかりますよね。そんな時、あなたの強力な味方になってくれるのが、Pythonに標準で備わっているhelp()関数です!

今回は、このhelp()関数を使いこなして、自己解決能力をぐっと引き上げる方法を一緒に見ていきましょう。

help()関数って、一体何者?

help()関数を一言で表すなら、「Pythonの公式マニュアルを、その場で呼び出せる機能」です。

まるで、分厚い専門書の代わりに、いつでも質問に答えてくれる親切な専門家が隣にいてくれるようなもの。あなたが「この道具(関数やモジュール)はどうやって使うの?」と尋ねると、その使い方を丁寧に教えてくれる、まさにそんな存在なのですよ。

プログラミングの世界では、こうした公式の説明書のことを「ドキュメンテーション」と呼びます。help()関数は、このドキュメンテーションをターミナルやエディタ上ですぐに表示してくれる、非常に便利なツールなのです。

基本的な使い方をマスターしよう!

help()関数の使い方は驚くほど簡単です。調べたいものをカッコの中に入れるだけ!

さっそく、Pythonの対話モード(ターミナルで pythonpython3 と入力して起動するモード)で試してみましょう。

関数の使い方を調べる

例えば、画面に文字を出力するおなじみのprint関数について調べてみます。

help(print)

これを実行すると、print関数の詳しい説明が表示されます。

Help on built-in function print in module builtins:

print(...)
    print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)

    Prints the values to a stream, or to sys.stdout by default.
    Optional keyword arguments:
    file:  a file-like object (stream); defaults to the current sys.stdout.
    sep:   string inserted between values, default a space.
    end:   string appended after the last value, default a newline.
    flush: whether to forcibly flush the stream.

どうでしょうか?

sepやendといった、普段あまり意識しない引数(専門用語では「キーワード引数」と呼びます)があることまで分かりますね。これで、「print関数で出力した後に自動で改行されるのは、endの初期値が改行コード\nになっているからなんだ!」という発見にも繋がります。

型について調べる

関数だけでなく、str(文字列)やint(整数)といった「型」についても調べることができます。

help(str)

実行すると、文字列が持っている便利なメソッド(特定の型のデータに対して使える専用の関数のこと)の一覧と説明がずらっと出てきます。例えば、文字列を大文字に変換するupper()メソッドなどの使い方も、ここで確認できるというわけです。

モジュールだって丸わかり!

help()関数のすごいところは、Pythonに最初から入っている機能だけでなく、あなたがimportした「モジュール」についても調べられる点です。

モジュールは、便利な機能がたくさん詰まった「道具箱」のようなものだと考えてみてください。

例えば、数学的な計算に便利なmathモジュールという道具箱があります。この道具箱の使い方を知りたい時も、help()関数が活躍します。

import math
help(math)

これで、mathモジュール全体の概要が表示されます。

さらに、その道具箱の中に入っている個別の道具、例えば「平方根」を計算するsqrtという関数の使い方を知りたければ、こう尋ねます。

help(math.sqrt)

※help(math.sqrt())ではない点に注意。

素晴らしいと思いませんか?

わざわざWebブラウザを開かなくても、知りたい情報をその場で引き出せるのです。

help()関数のメリットと注意点

ここで、help()関数を使うことのメリットと、少しだけ注意しておきたい点をまとめてみましょう。

メリット

  • すぐに使える: エディタやターミナルから離れる必要がなく、思考を中断させずに情報を確認できます。
  • オフラインでもOK: インターネットに接続できない環境でも利用可能です。
  • 信頼性が高い: 表示されるのは公式の情報なので、正確性は抜群です。

注意点

  • 情報が英語: 多くの説明は英語で書かれています。最初は少し戸惑うかもしれませんが、簡単な英単語で構成されているので、慣れてくれば問題なく読めるようになるでしょう。
  • 情報量が多い: ときに情報が多すぎて、どこを読めばいいか分からなく感じるかもしれません。まずは関数の基本的な説明(最初の数行)と、引数の部分(parametersargumentsと書かれているあたり)に注目してみてください。

まとめ:これからの学習に向けて

いかがでしたか?

help()関数は、Pythonプログラミングにおける「最初の杖」となってくれる、とても頼もしい存在です。

分からない関数やモジュールに出会ったら、まずはhelp()で尋ねてみる。この習慣をつけるだけで、あなたの問題解決能力は飛躍的に向上するはずです。

help()で大まかな使い方を掴んだ後、さらに具体的なコード例や応用方法を知りたくなったら、その時に公式ドキュメントサイトや技術ブログを検索する、という流れが最も効率的です。

さあ、今日からhelp()関数をあなたの最高の相棒にしてください!

まずは身近なlen関数やlist型について、help()で尋ねてみることから始めてみましょう!

セイ・コンサルティング・グループの新人エンジニア研修のメニューへのリンク

投稿者プロフィール

山崎講師
山崎講師代表取締役
セイ・コンサルティング・グループ株式会社代表取締役。
岐阜県出身。
2000年創業、2004年会社設立。
IT企業向け人材育成研修歴業界歴20年以上。
すべての無駄を省いた費用対効果の高い「筋肉質」な研修を提供します!
この記事に間違い等ありましたらぜひお知らせください。