問題タブ [docstring]

Pythonでdocstringを書くいくつかの異なるスタイルを見てきましたが、最も人気のあるスタイルは何ですか？

次のように、コンストラクターの実行の一部としてのみ宣言されるオブジェクト属性を持つPythonクラスがあります。

どちらかを使用するか、Sphinxでhelp(Foo)ドキュメント化しようとすると、属性と属性が表示されません。これは、APIのユーザーにとって問題です。Fooself.basepathself.availableruns

これらの「動的に宣言された」属性がパーサーによって検出される（そしてできればdocstringされる）ことを保証するための標準的な方法を検索しようとしましたが、これまでのところ運がありません。助言がありますか？ありがとう。

関数を返すラッパー関数があります。返された関数の docstring をプログラムで設定する方法はありますか? 私が書くことができるなら、私は__doc__次のことをします：

それから私はすることができました

ただし、__doc__読み取り専用なので、それはできません。正しい方法は何ですか？

編集:わかりました、これを単純にしたかったのですが、もちろん、これは私が実際にやろうとしていることではありません。私の場合、一般的__doc__には書き込み可能ですが、そうではありません。

unittestのテストケースを自動的に作成しようとしています。のサブクラスであるクラス オブジェクトを作成するラッパー関数がありますunittest.TestCase。

このクラスを作成して docstring を設定しようとするとtestSomething、エラーが発生します。

たとえば、次のような関数があるとします。

そのためのドキュメント文字列を書きたいです。

docstringでaを取り、a + 1を返すことを指定する際の規則は何ですか？

PHP では、PHPdoc 構文に慣れていました。

— ちょっとした便利なリファレンス: 特にサードパーティのライブラリの場合、「あれは何??」を思い出すだけでよい場合に非常に便利です。また、すべての IDE でこれをポップアップ ヒントに表示できます。

Python には規則がないように思われます。プレーン テキストのみです。よく説明されていますが、ダイジェストするには長すぎます。

わかりました、そうしましょう。しかし、私のアプリケーションでは平文の山を使いたくありません。

従うべきよく知られた規則はありますか? クラス属性を文書化する方法は?! PyCharm IDEレシピは特に歓迎します:)

Python3 には、機能注釈用のPEP 3107があります。これは 2.x (具体的には 2.6) では役に立ちません。

また、reStructuredText のPEP 0287もあります。空想ですが、まだ構造化されていません。

私は多くの小さな関数を備えたモジュールに取り組んでいますが、そのdocstringはかなり長くなる傾向があります。実際のコードを少し見つけるために長いdocstringを絶えずスクロールしなければならないので、docstringはモジュールでの作業を苛立たせます。

docstringをドキュメント化する関数から分離する方法はありますか？ファイルの最後にあるdocstringをコードから離して指定できるようにしたいのですが、さらに良いのは、別のファイルで指定できるようにすることです。

Python を学び始めたばかりで、Emacs をエディターとして使用しています。現在、Emacs は通常の文字列 (一重引用符) と docstring (三重引用符) に同じ色を使用しています。docstring を別の色にしたいので、'Options->Customize Emacs' メニュー オプションを使用して 'font-lock-doc-face' を新しい色に変更し、変更を保存しました。ただし、Emacs は引き続き docstring を通常の文字列と同じ色に保ちます。通常の文字列の色を変更すると、その変更がドキュメント文字列にも適用されます。

Emacs は docstring と通常の文字列を同じものとして扱っているようです。Python docstring を通常の文字列とは別に、Emacs に適切に見つけて色を付ける方法はありますか?

編集: デフォルトの Python モード設定で Emacs 23.1.1 (Kubuntu 10.10 パッケージ) を使用しています。真夜中をテーマにした color-theme パッケージも使用しています。

ユニットテストモジュールはPython2.7で大幅に変更されたようです

私はテストケースを持っています：

コンソール出力は次のとおりです。

fooをテストします...わかりました

Python 2.7にアップグレードすると、コンソールの出力は次のようになります。

test_foo（testcase.demotest.DemoTest）

fooをテストします...わかりました

説明の最初の行は役に立ちません。隠したいのですが、どうしたらいいのかわかりません。

私は Flask を使用して、職場で内部アプリ用の Web サービスを作成しています。Web サービス URI の多くは HTML パーシャルを返します。HTML テンプレート文字列をきれいに格納する方法を見つけようとしています。テンプレート文字列を別々のファイルに入れたくありません。通常、それらは数行の長さしかなく、それぞれに 3 行が含まれる 20 個のテンプレート ファイルを持ちたくないからです。関数の docstring で関数の html テンプレート文字列を定義することを考えていました。それは複数の目的に役立つと思うからです。基本的に「これは私が出力したものです」と言って、ドキュメントとして機能し、3行のテンプレート文字列を別のファイルに保存する必要がないようにします. これが私が話していることです：

これが維持するのが悪夢になるかどうかはわかりません...何か考えはありますか?

私は現在Pythonを始めており、PHPのバックグラウンドが強く、PHPではjavadocドキュメントテンプレートとして使用する習慣があります。

Pythonのドキュメントjavadocとしての場所があるのだろうかと思っていました。ここで確立された慣習および/または公式のギルドラインは何ですか？docstring

たとえば、このようなものはPythonの考え方に合わせるには複雑すぎるのでしょうか、それともできるだけ簡潔にする必要がありますか？

そして、私が少し網羅的すぎる場合は、代わりにこのようなものを使用する必要があります（ほとんどのドキュメントが__doc__メソッドを介して印刷されません）？