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

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

新規登録して質問してみよう
ただいま回答率
85.50%
Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

Q&A

解決済

3回答

1127閲覧

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

kankan0

総合スコア23

Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

0グッド

0クリップ

投稿2019/05/14 11:57

前提・実現したいこと

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

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

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

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

エラーメッセージ

該当のソースコード

python

1ソースコード

試したこと

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

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

python3.7.3

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

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答3

0

ベストアンサー

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

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

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

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

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

python

1>>> help("def") 2Function definitions 3******************** 4 5A function definition defines a user-defined function object (see 6section *The standard type hierarchy*): 7# くっそ長いので略

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

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

投稿2019/05/14 12:24

編集2019/05/14 12:30
hayataka2049

総合スコア30933

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

kankan0

2019/05/14 12:30

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

2019/05/14 12:33

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

0

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

Python

1# test.py 2def func(): 3 """ 4 この関数はテストです。 5 """ 6 return 0

REPL上

Python

1Python 3.6.7 (default, Feb 28 2019, 07:28:18) [MSC v.1900 64 bit (AMD64)] on win32 2Type "help", "copyright", "credits" or "license" for more information. 3>>> import test 4>>> help(test.func) 5Help on function func in module test: 6 7func() 8 この関数はテストです。 9>>>

投稿2019/05/14 12:24

can110

総合スコア38233

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

kankan0

2019/05/14 12:32

ありがとうございます。
guest

0

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

投稿2019/05/14 12:03

otn

総合スコア84421

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

kankan0

2019/05/14 12:14

すみません。 ヘルプ や help で検索はしてみましたが、defのヘルプを表示させるにはどうすればいいのか分かりませんでした。python や pip などexeファイルは--helpでいけますが、def --help ではダメでした。
otn

2019/05/14 12:20 編集

「公式リファレンスを見ます」というのが通じていないということでしょうか? コマンドで説明を見るんじゃ無くて、Python公式サイトのリファレンスページで説明を見ます。
kankan0

2019/05/14 12:22

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

2019/05/14 12:30

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

2019/05/14 13:09

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問