問題タブ [docstring]

これに似たSphinxのコードを文書化しています：

ドキュメントに を追加した:inherited-membersのでChildClass、「/run/ParentClass/generic_fun() を使用してこの関数を呼び出す」などのステートメントが含まれています。

Sphinx が文書化する実際のクラスに置き換える <class_name> のようなものを docstring に入れる方法はありますか?

コードを次のようにしたいと思います。

したがって、ChildClass セクションでは、Sphinx ドキュメントは「(...) using /run/ChildClass/generic_fun()(...)」と読み、ParentClass セクションは「(...) using /run/ParentClass/」と読みます。 generic_fun()(...)"?

理想的には、ドキュメントを同じページに配置したいので、置換文字列はセクションごとに異なります。

__init__おそらくばかげた質問です: C 拡張機能を作成するときなど、特別な関数に docstring を指定するにはどうすればよいでしょうか? 通常のメソッドの場合、メソッド テーブルにはドキュメント文字列が用意されています。help(myclass) を試すと、次の自動生成されたドキュメントが表示されます。

しかし、これは私がオーバーライドしたいものです。

使用法の文字列にユーザーの例を示したいと思い__doc__ます。これが私の質問に関連するコードの重要な部分です。

私はこの振る舞いを期待しています：

ただし、例をコマンドラインにコピーすると、プログラムが実行されることを期待します。代わりに私は得る：

上記の2行目に注意してください。print argsこれは、内のコマンドの結果main()です。argsリスト['\\\\Hal\\hal free agent 1\\backups\\videos" out.txt']には2つではなく1つの要素しかないと言っています。これは私には意味がありません。

Windowsの.cmdファイルを作成して、もう少し調査を行いました。次にshow_args.cmdを示します。

実行の結果は次のとおりです。

Windowsはアイテムを分離しているようです。私は困惑しています。誰かがここで何が起こっているのか知っていますか？

誰かが共有する洞察を持っていることを願っています。前もって感謝します。

内func_docに(式として)を設定したいと思います。 def

これは可能ですか？

(これを行う理由として考えられるのは、モジュールから関数をインポートすること (および docstring もインポートすること) とlexerを使用することの 2 つです。)

Sublime Text 2でPythondocstringと1行の文字列を区別したいと思います。Python言語の定義を見ると、同じcomment.block.python名を使用するアポストロフィ文字列の一致する定義とともにこれを確認できます。 。

しかし、次のような新しいカラールールを作成すると、次のようになります。

何も起こりません; それらは、単一行の文字列と同じ色のままです。

これを行うことは可能ですか？もしそうなら、私は何を間違っていますか？

実装が（保守性のために）2つの内部サブモジュールに分割されているPythonパッケージがあります。ただし、ユーザーの観点からは、パッケージは1つのユニットとして表示されるはずなので、パッケージの__init__.py両方のサブモジュールはimport *、次のようにでインポートされます。

と

これは、パッケージ機能の観点から意図したとおりに機能します。

これらのクラスのインラインヘルプを直接検索する場合は、すべてが良好です。

問題は、トップレベルパッケージのヘルプを検索するだけの場合です。

その場合、サブモジュールのクラスと関数は「自発的に」表示されません（ただし、それらの変数はDATAセクションに表示されます）。これは予想される/正しい動作ですか？それを回避して、ユーザーが実装/保守の便宜のためだけに存在するサブモジュールについて知る必要がないようにする方法はありますか？

docstring を XML データに変換し、この XML データを既存の XML ファイルの先頭に追加する必要があります。

XML に変換するデータは次のようになります。

string = __doc__ドキュメント文字列が表示されますが、XML に変換して既存の XML ファイルの先頭に追加する方法を教えてください。

XML ファイルは次のようになります。

Python Docstrings ( __doc__) を記述する 2 つの方法の違いは何だろうと思っていました:

1. 3 つの一重引用符:

   /li>

2. 3 つの二重引用符:

   /li>

後でドキュメントを生成する際にドキュメント文字列をフォーマットする方法に微妙な違いはありますか?

関数のドキュメント文字列にデコレータを追加するにはどうすればよいでしょうか?

結果：

すべての助けをいただければ幸いです。

欲しい物はほぼ揃ってる…

動的 docstring 生成を使用してジェネリック関数呼び出しをカプセル化するこの動的オブジェクト:

そして、期待どおりに動作します：

唯一の 2 つの問題は、ヘルプがmutable_f署名を表示することです。

そして、オートコンプリートがないこと (有効な関数のリストをオンザフライで取得し、その操作が高価であるためキャッシュすることができます)

最初のものは解けないと思いますが、2番目のものはよくわかりません。アイデア？