【Python入門】VS CodeでPythonのヘルプコマンドを使ってコーディングの効率をあげる方法の紹介

今回はPythonでコードを書くときにちょっとだけ便利な機能の紹介です。いろいろなアプリにはその使い方などを説明した「ヘルプ」がありますが、実はPythonにも「ヘルプ」が存在します。

そのヘルプを使うと、オブジェクトの情報を調べることができます。

今回はエディタとしてVS Code（Visual Studio Code）上のPythonで、そのヘルプを使う方法と、どのような結果になるのかを見ていきましょう。

公式サイトの説明

P`ythonには標準で組み込まれている関数として、help()関数が存在します。公式ドキュメントには、

組み込みヘルプシステムを起動します。(この関数は対話的な使用のためのものです。) 引数が与えられていない場合、対話的ヘルプシステムはインタプリタコンソール上で起動します。引数が文字列の場合、文字列はモジュール、関数、クラス、メソッド、キーワード、またはドキュメントの項目名として検索され、ヘルプページがコンソール上に印字されます。引数がその他のオブジェクトの場合、そのオブジェクトに関するヘルプページが生成されます。

Python公式ドキュメント：help([object])

と書かれています。

使い方

使い方はものすごく簡単です。次のように使います。

help(調べたいオブジェクト)  #クラスとか関数とかいろいろ

実際にVS Code上で使ってみましょう。たとえば、list()関数について調べてみましょう。次のように入力します。

help(list)

実行してみると次のような表示となります。

画面に表示されている内容を見るとは、list()関数とは、

• 実はobjectクラスを継承したlistというクラスであること
• list()関数から生成されるリスト型のオブジェクトはミュータブルなシーケンス型の1種であること
• 生成されたリスト型オブジェクトは、そのメソッドとして__add__などがあること
• それらのメソッドの使い方（引数が何を取るかなど）

などなど、いろいろな情報が表示されています。

上の画面の下には、– More–という表示があります。

この画像の「□」部分にマウスカーソルをあわせて、リターンキーを押すと、隠されていたさらなる情報が出てきます。リターンキーを押しっぱなしにすると、連続的にズラズラ～っと結果が表示されます。

このように、>>>という表示がでてきた時点でそのオブジェクトのヘルプ情報は終了です。

あるオブジェクトがどのような属性（メソッドとプロパティ）を持つのかは、dir()関数を使っても調べることができますが、そのオブジェクトを生成したクラスがどのようなクラスを継承しているのかとか、引数の情報などは確認できません。

そういったことを確認したいときは、このhelp()関数のほうが役立つでしょう。結果が英語だけの表示なのでとっつきにくいかもしれませんが、慣れてみると便利な機能かもしれませんね。

外部ライブラリなどの情報を確認したいときは、そのライブラリをimportしてから、help(ライブラリ名)としましょう。

Pythonをプロから短期間で合理的にマスターするなら、やはり動画による学習方法がわかりやすくオススメです。世界最大級のオンライン学習サイトUdemy（ユーデミー）【PR】ではPythonのプログラミング講座が入門～応用レベルまで幅広く展開されています。

Udemyの動画講座では講師に質問が可能、動画なのでプログラムの動きがわかりやすく理解しやすい、わかりにくいところを何度も繰り返し再生できる、プログラミングスクールよりもはるかに安いというメリットがあります。

その中でも次のような講座がおすすめです。

• Python 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイルを学ぶオンライン講座【PR】
• 【世界で5万人が受講】実践 Python データサイエンス・オンライン講座【PR】
• 人工知能・機械学習 脱ブラックボックス講座 【PR】
• みんなのAI講座 ゼロからPythonで学ぶ人工知能と機械学習 【PR】

他にも多数のプログラミング講座があるのでぜひ活用し、合理的に短期間でプログラミングを身に着けましょう。