1

私が見つけることができるのはこのリファレンスだけです：

PythonでPOD（プレーンオールドドキュメント）を使用することは可能ですか？

これは、コードを使用するために、まったく別のドキュメントセットを生成する必要があるようです。

cmdline utilsを作成するためにPythonを試したいのですが、Perlでこれを行うと、ドキュメントをソースに直接埋め込み、Pod2UsageモジュールをGetoptと一緒に使用して、スクリプトを次のように実行できます。

cmd --man

これにより、ポッドシステムがトリガーされ、スクリプトに埋め込まれているドキュメントがマンページ形式でダンプされます。また、より短い（概要）または中判を生成することもできます。

pydocコードを使用して、それをリバースエンジニアリングしてタスクを実行できるように見えます（少なくとも完全なドキュメントを表示する）が、もっと良いものがすでに存在することを望んでいます。

4

2 に答える 2

2

python-modargsパッケージを使用すると、自己文書化コマンドラインインターフェイスを作成できます。使用可能にするコマンドごとに関数を定義すると、関数のdocstringがその関数のヘルプテキストになります。関数のキーワード引数は名前付き引数になり、python-modargsはキーワード引数の後のインラインコメントを解析して、その引数のヘルプテキストになります。

python-modargsを使用してdexyのコマンドラインインターフェイスを生成します。コマンドを定義するモジュールは次のとおりです 。https ：//github.com/ananelson/dexy/blob/027954f9234363d506225d40b675b3d6478994f4/dexy/commands.py#L144

生成されたヘルプを取得するには、help_commandメソッドを実装する必要があります。これは1ライナーです。

于 2012-11-08T23:15:07.610 に答える
0

pydocはあなたが探しているものかもしれないと思います。

pydoc自体（例）を呼び出す必要があるため、PODとはまったく同じではありませんがpydoc myscript.py、開始点としては適切だと思います。

もちろん、スクリプトからインポートしてその関数/クラスを使用することにより、スクリプトのpydocサポートをいつでも追加できます。最良の例については、pydoc独自のCLI実装を確認してください。

于 2012-11-08T00:22:06.673 に答える