Pythonを学んでいると、わからない関数やメソッドに出会うことがあります。
そんなとき、検索して記事を読むのもよいですが、毎回検索に頼っていると、どの情報を信じればよいのか迷うこともありますよね。 公式ドキュメントを見れば正確そうだけれど、文章が難しくて読む気がなくなる。そんな経験はないでしょうか？
そこで役立つのが、Pythonの help() 関数です。
help() 関数を使うと、Pythonの関数、型、モジュール、メソッドなどの説明をその場で確認できます。ブラウザで検索しなくても、手元のPython環境から使い方のヒントを得られるのが大きな特徴です。
この記事では、Pythonのhelp関数とは何か、どのように使うのか、公式ドキュメントが苦手な初心者でも調べられるようになるコツをわかりやすく解説します。
Pythonのhelp関数とは¶
まずは、help関数が何をするものなのかを整理しておきましょう。
help関数は、Pythonに用意されている組み込み関数の一つです。関数やクラス、モジュールなどの説明を表示してくれます。
help関数は使い方を調べるための関数¶
Pythonでは、関数の使い方がわからないときに help() を使えます。
たとえば、print() 関数について調べたい場合は、次のように書きます。
help(print)
実行すると、print() 関数の説明が表示されます。
最初は英語が多くて少し難しく感じるかもしれません。でも、すべてを完璧に読む必要はありません。
初心者のうちは、何を受け取る関数なのか、どんな引数があるのか、どんな役割を持つのかをざっくり確認できれば十分です。
help関数は公式情報に近い説明を確認できる¶
ネット上の記事は読みやすい一方で、情報が古かったり、書き手の解釈が入っていたりすることがあります。
一方、help() で表示される内容は、Pythonのオブジェクトに含まれている説明やドキュメント文字列をもとにしています。
初心者には少し読みにくいこともありますが、慣れると検索する前に概要を確認できるようになります。
help関数の基本的な使い方¶
ここからは、実際にhelp関数を使ってみましょう。
難しい準備は必要ありません。Pythonが動く環境であれば、すぐに試せます。
関数の使い方を調べる¶
まずは、組み込み関数を調べる例です。
help(len)
len() は、文字列やリストなどの長さを調べる関数です。
helpで確認すると、どのような役割を持つ関数なのかが表示されます。細かい英語が読めなくても、length、object、Returnなどの単語から意味をつかめることもあります。
次に、input() 関数を調べてみましょう。
help(input)
input() は、キーボードから入力を受け取る関数です。
入力を受け取る処理は、初心者が最初に自分で動かした感覚を得やすいテーマです。
まだinput関数に不安がある方は、先にこちらの記事を読むと理解しやすくなります。
【関連記事】Pythonのinput関数を初心者向けに解説！キーボード入力を受け取る基本
メソッドの使い方を調べる¶
help関数は、関数だけでなくメソッドにも使えます。
たとえば、文字列の replace() メソッドを調べる場合は、次のように書きます。
help(str.replace)
str.replace は、文字列の一部を別の文字列に置き換えるメソッドです。
実際に使うと、次のようになります。
text = "I like Java"
new_text = text.replace("Java", "Python")
print(new_text)
実行結果は次の通りです。
I like Python
helpでメソッドを調べると、引数の順番や省略できる引数がわかります。
初心者のうちは、ドットを使って呼び出すものもhelpで調べられる、と覚えておけば大丈夫です。
型の説明を調べる¶
help関数では、型そのものを調べることもできます。
help(list)
このコードを実行すると、リスト型についての説明や、リストで使えるメソッドが表示されます。
かなり長い説明が出るので、最初は驚くかもしれません。
全部を読む必要はありません。append、pop、sort など、見覚えのある名前を探すだけでも勉強になります。
numbers = [3, 1, 2]
numbers.sort()
print(numbers)
このように、helpで見つけたメソッドを小さなコードで試すと、理解が深まりやすいです。
help関数で調べられるもの¶
help関数は、いろいろな対象に使えます。
ここで、初心者がよく使う調べ方を表にまとめておきます。
| 調べたいもの | 書き方 | 例 |
|---|---|---|
| 組み込み関数 | help(関数名) |
help(print) |
| データ型 | help(型名) |
help(dict) |
| メソッド | help(型.メソッド名) |
help(str.split) |
| モジュール | help(モジュール名) |
help(math) |
| 自分で作った関数 | help(関数名) |
help(greet) |
| キーワード検索 | help("キーワード") |
help("modules") |
表で見ると、help関数はかなり幅広く使えることがわかります。
ただし、最初から全部を使いこなす必要はありません。まずは、help(print) や help(str.replace) のような短い例から試してみましょう。
公式ドキュメントが苦手な初心者にhelp関数がおすすめな理由¶
公式ドキュメントは正確ですが、初心者には少し読みにくいことがあります。
では、なぜhelp関数が初心者に向いているのでしょうか？
手元ですぐに確認できる¶
help関数の良いところは、Pythonを開いたまま確認できることです。
ブラウザで複数の記事を開いて、どれが正しいのか比べる前に、まず手元で説明を確認できます。
この流れに慣れると、調べるスピードが上がります。
エンジニアとして10年ほど仕事をしていると、調べる力の大切さを何度も感じます。 すべてを暗記している人よりも、正しく調べて早く検証できる人の方が、現場では強いです。
実際の環境に合わせた情報を見られる¶
Pythonは、バージョンやライブラリによって使える機能が変わることがあります。
その点、help関数は今使っている環境にある情報を表示してくれます。これは地味ですが、かなり便利です。
調べる習慣が身につく¶
初心者のうちは、関数やメソッドをすべて覚えようとしがちです。
でも、Pythonの機能を全部暗記する必要はありません。実務のエンジニアも、必要なときに調べながら書いています。
大切なのは、覚えることよりも、調べ方を知ることです。
help関数は、その入り口としてちょうどよい存在です。
まずPython自身に聞いてみる感覚を持てるようになります。
help関数の出力で見るべきポイント¶
help関数を使うと、長い説明が表示されることがあります。
最初から全部を理解しようとすると疲れてしまいます。見るポイントを絞るのがおすすめです。
まず関数の名前と引数を見る¶
helpの出力では、最初の方に関数名や引数の形が表示されます。
たとえば、print() には sep や end などの引数があります。
help(print)
初心者のうちは、すべての引数を使う必要はありません。
ただ、何か指定できるものがあるんだなと知っておくだけでも十分です。
Returnや戻り値を確認する¶
次に見るとよいのが、戻り値です。
戻り値とは、関数を実行したあとに返ってくる値のことです。初心者がつまずきやすいテーマですが、ここを意識するとコードが読みやすくなります。
たとえば、len() は長さを返します。
count = len("Python")
print(count)
この場合、len("Python") の結果は 6 です。
helpの説明にReturnという言葉が出てきたら、この関数は何を返すのかを確認してみましょう。
Examplesがあれば真似して試す¶
ライブラリによっては、helpの説明に使用例が含まれていることがあります。
もしサンプルコードがあれば、まずそのまま真似して動かしてみましょう。
動いたら、数字や文字列を少し変えます。
少し変えて結果が変わるのを見ると、自分の理解に変わっていきます。
help関数を使った調べ方の例¶
ここからは、初心者が実際に使いやすい例を見ていきましょう。
単にhelpを実行するだけでなく、調べたあとに小さく試すところまでセットで考えると効果的です。
splitメソッドを調べる¶
文字列を分割する split() メソッドを調べてみます。
help(str.split)
そのあと、実際に短いコードを書いてみましょう。
text = "apple,banana,orange"
fruits = text.split(",")
print(fruits)
実行結果は次の通りです。
['apple', 'banana', 'orange']
このように、helpで調べた内容をすぐに試すと、ただ読むよりも理解しやすくなります。
dictのgetメソッドを調べる¶
辞書dictの get() メソッドも、helpで調べられます。
help(dict.get)
get() は、キーが存在しない場合でもエラーにせず、指定したデフォルト値を返せるメソッドです。
user = {
"name": "Taro"
}
email = user.get("email", "未登録")
print(email)
このコードでは、email キーがなくてもエラーになりません。
辞書のキーでつまずきやすい方は、こちらの記事もあわせて読むと理解しやすいです。
【関連記事】PythonでKeyErrorが出る理由とは？辞書dictで初心者がハマるポイント
モジュールの中身を調べる¶
help関数は、モジュールにも使えます。
たとえば、数学系の機能を持つ math モジュールを調べる場合は、次のようにします。
import math
help(math)
長い説明が出ますが、pi や sqrt などの名前を見つけられるはずです。
import math
print(math.pi)
print(math.sqrt(16))
実行結果は次のようになります。
3.141592653589793
4.0
モジュールの全体像を知りたいときに、helpは便利です。
help関数とdir関数の違い¶
help関数と一緒に覚えておきたいのが、dir() 関数です。
どちらも調べるために使えますが、役割が少し違います。
dir関数は名前の一覧を見るための関数¶
dir() は、オブジェクトが持っている属性やメソッドの名前を一覧で表示します。
print(dir(str))
実行すると、文字列で使えるメソッド名がたくさん表示されます。
ただし、dirは名前の一覧を出すだけなので、それぞれの詳しい説明はわかりません。
詳しく知りたいときはhelpを使う¶
dirで気になる名前を見つけたら、helpで詳しく調べるのがおすすめです。
help(str.upper)
upper() は、文字列を大文字に変換するメソッドです。
text = "python"
print(text.upper())
実行結果は次の通りです。
PYTHON
dirで一覧を見る。helpで詳しく見る。小さなコードで試す。
この流れを身につけると、自分で調べながら学習できるようになります。
初心者がhelp関数でつまずきやすいポイント¶
help関数は便利ですが、最初は使いにくく感じることもあります。
ここでは、初心者がよくハマるポイントを整理しておきます。
文字列で指定する場合としない場合がある¶
help関数では、対象をそのまま渡す場合と、文字列で渡す場合があります。
help(print)
help("print")
どちらも似た結果になりますが、基本的には関数や型を直接渡す形から覚えるとよいです。
help(list)
help(dict.get)
一方で、キーワードやトピックを調べたい場合は文字列を使うことがあります。
help("keywords")
最初は、調べたい関数名をそのまま入れると覚えておけば十分です。
説明が英語で難しく感じる¶
helpの説明は英語で表示されることが多いです。
ここで止まってしまう人も多いかもしれません。でも、全部を翻訳しようとしなくて大丈夫です。
まず見るのは、関数名、引数、Return、短い説明です。
英語が苦手でも、何度も見ているうちに、よく出る単語には慣れていきます。たとえば、return、object、optional、default、stringあたりはよく登場します。
出力が長すぎて迷子になる¶
help(list) や help(dict) のように型全体を調べると、出力がかなり長くなります。
最初から全部を読もうとすると大変です。
長すぎると感じたら、より具体的に調べましょう。たとえば、リスト全体ではなく help(list.append) のようにメソッド単位で見ると読みやすくなります。
help関数を学習に活かすコツ¶
最後に、help関数をPython学習に活かすコツを紹介します。
難しく考えすぎず、普段の学習の中に少しだけ混ぜるのがおすすめです。
わからない関数に出会ったらまずhelpを見る¶
教材や記事で知らない関数が出てきたら、まずhelpで見てみましょう。
たとえば、sorted() が出てきたら次のようにします。
help(sorted)
そのあと、短いコードで試します。
numbers = [3, 1, 2]
print(sorted(numbers))
こうすると、説明を読むだけでなく、実際の動きも確認できます。
helpだけで理解しようとしない¶
help関数は便利ですが、初心者がhelpだけで全部を理解するのは難しいです。
わからなければ、解説記事や公式ドキュメント、サンプルコードも一緒に使いましょう。
大切なのは、一つの情報源だけに頼りすぎないことです。
特にエラーが出たときは、helpだけでなくエラー文の読み方も大切になります。
エラーでつまずきやすい方は、こちらの記事も参考にしてください。
【関連記事】PythonのModuleNotFoundErrorって何？解決するにはどうしたらいいの？
調べたことをメモする¶
helpで調べた内容は、短くメモしておくと定着しやすくなります。
たとえば、str.split() は文字列を分割する、dict.get() はキーがなくても安全に取り出せる、list.append() はリストの末尾に追加する、というように自分の言葉でまとめます。
きれいなノートを作る必要はありません。
あとで見返して、そういえばこんな使い方だったと思い出せれば十分です。
まとめ¶
Pythonのhelp関数は、関数、メソッド、型、モジュールなどの説明を確認できる組み込み関数です。
公式ドキュメントが難しく感じる初心者でも、手元のPython環境で使い方のヒントを調べられるのが魅力です。
最初は英語が多く、出力も長く感じるかもしれません。
でも、すべてを完璧に読む必要はありません。関数名、引数、戻り値、短い説明を見るだけでも十分に役立ちます。
help関数を使うときは、調べて終わりにしないことが大切です。
help(str.split) を見たら、実際にsplitを使ってみる。help(dict.get) を見たら、辞書で存在しないキーを試してみる。このように、小さく動かすことで理解が深まります。
プログラミング学習では、暗記よりも調べ方を身につけることが大切です。
エンジニア歴10年の今でも、私も調べながらコードを書きます。わからないことがあるのは普通です。
だからこそ、help関数を使って、自分で調べる力を少しずつ育てていきましょう。
