質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.81%

python で def に関するヘルプを表示することは可能ですか?

解決済

回答 3

投稿

  • 評価
  • クリップ 0
  • VIEW 698

kankan0

score 20

前提・実現したいこと

python で def に関するヘルプを表示することは可能ですか?

また表示が可能である場合、それを「ヘルプdef.txt」などのテキストファイルに出力可能ですか?

私はバッチファイルを少しいじる程度の初心者で、pythonはバッチに比べて格段に高機能かと思いますが、defの他にもpythonに含まれるあらゆる機能に関して、ヘルプの表示方法など教えていただけると助かります。
私自身、バッチの機能を学ぶ際に「コマンド名 /? > ヘルプ-コマンド名.txt」などと逐一保存し、少しずつ学んでました。

発生している問題・エラーメッセージ

エラーメッセージ

該当のソースコード

ソースコード

試したこと

ここに問題に対して試したことを記載してください。

補足情報(FW/ツールのバージョンなど)

python3.7.3

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 3

checkベストアンサー

+2

help関数があります。機能としては、

  • 引数を与えなければ対話的ヘルプシステムが起動する(help()のように)
  • 任意のオブジェクトを渡してdocstringから生成されたヘルプを見れる(たとえばhelp(1)のように)
  • 文字列を渡すとそれでドキュメントを検索してヒットする項目を出してくれる

使い方は以下のドキュメントを参照してください。

https://docs.python.org/ja/3/library/functions.html#help

defについて調べたければ、

>>> help("def")
Function definitions
********************

A function definition defines a user-defined function object (see
section *The standard type hierarchy*):
# くっそ長いので略

テキストにリダイレクトしたければ、$ python -c "help('def')" > output.txtのようにすればいいかと。-cオプションは後に続く引数をそのまま実行します。

ただし、「日本語で読みたい」は無理だと思います。それに、初心者向けの親切な解説が出てくるという訳でもないです(「開発者向け」の内容だと思った方が良い。バッチとはコンセプトが違うので・・・)。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/05/14 21:30

    初心者に対して親切にありがとうございます。

    キャンセル

  • 2019/05/14 21:33

    これを見るより、普通にオンラインのリファレンス見ることが多いですけどね。幸いpythonのドキュメントは親切だし、日本語訳まで(一部翻訳が終わってないところもありますが)あります。

    キャンセル

0

普通は、公式リファレンスを見ます。https://docs.python.org/ja/3.7/

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/05/14 21:22

    なるほど・・・。
    「そのような機能はないので、python内の細かい機能については公式リファレンスのヘルプを見てください。」
    という意味ですかね・・・。
    こういった細かい機能についてコマンドラインからヘルプ表示ができないようでしたら非常に残念です。
    もし理解が間違っていれば言って下さい。

    キャンセル

  • 2019/05/14 21:30

    どうせテキストに保存するぐらいなら最初からまとまってるリファレンス見たほうがいいんじゃないかと思うのですが

    キャンセル

  • 2019/05/14 22:09

    英文で良ければ、pydoc というコマンドがあります。

    キャンセル

0

一般的な関数はPythonドキュメントやインストールした各モジュールで公開されているヘルプページを参照することになります。
それに加え、Pythonでは関数(def)にヘルプ情報を埋め込む仕組み(docstring)があります。
自作関数であってもdocstringを書いておくことにより、誰でも簡単にその情報を表示、参照することができ便利です。
ヘルプ情報が埋め込まれた関数についてはREPL上でhelp(func)と実行すればその情報が表示されます。
参考:Pythonのdocstring(ドキュメンテーション文字列)の書き方

# test.py
def func():
    """
    この関数はテストです。
    """
    return 0

REPL上

Python 3.6.7 (default, Feb 28 2019, 07:28:18) [MSC v.1900 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import test
>>> help(test.func)
Help on function func in module test:

func()
    この関数はテストです。
>>>

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/05/14 21:32

    ありがとうございます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.81%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る