問題タブ [docstring]

モジュールが読み込まれると、Python docstring とコメントはメモリに保存されますか?

私は通常、自分のコードをよく文書化しているので、これが本当かどうか疑問に思っていました。これはメモリ使用量に影響しますか?

通常、すべての Python オブジェクトには__doc__メソッドがあります。これらの docstring はファイルから読み取られますか、それとも別の方法で処理されますか?

ここでフォーラム、Google、メーリング リストを検索しましたが、関連する情報は見つかりませんでした。

あなたはよく知っていますか？

doctest にあるこのコードは、単独で実行すると機能しますが、この doctest では 10 か所で失敗します。なぜそうなるのかはわかりません。以下はモジュール全体です。

私はpython 3.1を使用しています。

1 つのモジュールまたは関数に対して複数の docstring を作成することは可能ですか? 私はプログラムを作成しており、それぞれにカテゴリを持つ複数の docstring を持つつもりです。私は他の人がプログラムを使用できるようにプログラムを提供するつもりです。また、プログラマーと非プログラマーの両方にとって物事を簡単にするために、プログラム自体のドキュメント用の docstring への参照を入れています。

より具体的には、プログラム/モジュールにインターフェイスとしてメニューがあり、オプションの1つを使用して、プログラムに関するドキュメントのモジュールdocstringにアクセスできます。したがって、可能であれば、複数のドキュメント文字列を作成して、さまざまな種類のドキュメントを分類したいと考えています。そのため、ドキュメントの一部を見たい場合は、ユーザーにとってより簡単になります。

例えば。最初の docstring には、プログラムの使用方法に関する説明が含まれています。2 番目の docstring には、プログラムの一部がどのように機能するかに関する情報が含まれています。3 番目の docstring には、別の部分がどのように機能するかに関する情報が含まれています。等

これは可能ですか？もしそうなら、どのようにそれらを参照しますか?

更新: コメントを追加しました。

私の最初の考えは、実際には次の意味で複数のdocstringを持つことでした:

次に、これらの各 docstring を参照できるようにするために使用できるコードがいくつかあります。それで、これは不可能だと思いますか？

可能であれば、emacs 内から、Python コードのドキュメント文字列に対してスペル チェッカーを実行したいと考えています。

コード内のコメントのみをスペル チェックするために使用できる ispell-check-comments 設定を見つけましたが、かなり Python 固有のものである docstring のみをターゲットにすることはできませんでした。

私はepytextからreSTマークアップへのコンバーターを作成しました。今、ライブラリ全体のすべての docstring を epytext から reST 形式に変換したいと考えています。

モジュール内のすべての docstring を読み取り、置換を書き戻すスマートな方法はありますか?

ps:おそらくastモジュール?

docstringの繰り返しコンテンツを処理するための良い方法は何ですか？「標準」引数を取る関数がたくさんありますが、これはdocstringで説明する必要がありますが、docstringの関連部分を一度だけ記述すると、保守と更新がはるかに簡単になります。私は素朴に次のことを試みました：

しかし、これは機能しません。なぜなら、私がそうするhelp(test)と、docstringが表示されないからです。これを行う良い方法はありますか？

Python では、文字列は単なる式であり、コードの呼び出し元に制御が戻るとすぐに文字列自体がガベージ コレクションされることを理解していますが、...

1. コード内の大きなクラス/メソッド doc 文字列: 文字列オブジェクトを構築することでメモリを浪費していませんか?
2. モジュール レベルのドキュメント文字列: インタプリタによって無限に保存されますか?

これも問題ですか？私の唯一の懸念は、Django のような大規模なフレームワーク、または複数の大規模なオープン ソース ライブラリを使用している場合、数メガバイトのテキストで十分に文書化される傾向があるという考えから生じました。これらの場合、途中で使用されるコードのためにドキュメント文字列がメモリにロードされ、そこに保持されますか、それとも通常の文字列のようにすぐに収集されますか?

私は、属性がパブリックにアクセス可能であり、特定のインスタンス化でオーバーライドされることがある軽量クラスを作成しています。Python 言語には、クラス属性の docstring やその他の属性を作成するための規定はありません。これらの属性を文書化するために、期待され、サポートされている方法は何ですか? 現在、私はこのようなことをしています：

これにより、最初の標準ドキュメント文字列セクションを含むクラスのドキュメント文字列と、 への拡張代入を介して各属性に追加された行が生成されます__doc__。

このスタイルはdocstring スタイル ガイドラインで明示的に禁止されているようには見えませんが、オプションとしても言及されていません。ここでの利点は、提示可能なクラス docstring を作成しながら、定義と共に属性を文書化する方法を提供し、docstring からの情報を繰り返すコメントを記述する必要がないことです。属性を実際に 2 回書かなければならないことに、いまだにイライラしています。少なくともデフォルト値の重複を避けるために、docstring の値の文字列表現を使用することを検討しています。

これは、その場しのぎのコミュニティの慣習に対する凶悪な違反ですか? 大丈夫ですか？より良い方法はありますか？たとえば、属性の値とドキュメント文字列を含むディクショナリを作成し、その内容を__dict__クラス宣言の末尾に向かってクラスとドキュメント文字列に追加することができます。これにより、属性名と値を 2 回入力する必要がなくなります。 edit : この最後のアイデアは、少なくともデータからクラス全体を動的に構築しない限り、実際には不可能だと思います。これは、他の理由がない限り、本当に悪い考えのように思えます。

私は python にかなり慣れていないので、コーディング スタイルの詳細をまだ調べているので、関係のない批評も大歓迎です。

コンテンツをコピーペーストすることなく、Javatextの docstrings に変数を表示することは可能ですか?cls

関数のdocstringを表示したいのですが、このように使用すると

メタプログラミングのトリッキーを使用しているという理由だけで、ドキュメント文字列が表示されません。これを修正するにはどうすればよいですか?