1

私は、マニュアル QA が時々読めるようにしたい機能テストの広範なセットを含む pylons プロジェクトを持っているので、epydoc を使用して機能テスト モジュールで html pydoc を構築しています。

うまくいっているようです。ドキュメントが生成され、明らかな問題なくドキュメントをナビゲートできます。

ただし、epydoc ビルドを実行すると奇妙なエラーが発生し、修正方法がわかりません。

+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| In project.tests.functional.resource:
| Import failed (but source code parsing was successful).
|     Error: KeyError: '__file__' (line 28)
|
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | In /Eclipse/product/project/server/src/project/tests/functional/resource/ftest_module1.py: | Import failed (but source code parsing was successful). | Error: KeyError: '__file__' (line 28) |
+------------------------------------------------------------------------------------------

これが発生しているパッケージは合計 2 つ、モジュールは 8 つです。最初は、モジュールの先頭またはパッケージの __init__ に docstrings がない可能性があると思いましたが、それらを追加しても修正されませんでした。

以下は、機能テスト用に特別に記述された epydoc 構成ファイルのコピーです。

[epydoc]
modules: project.tests.functional.resource,project.tests.functional.views
output: html
sourcecode: yes
#graph: none
target: ../pydoc/ftests
name: PROJECT
# exclude: test
private: no
imports: no
verbosity: 0
include-log: yes

そして、これを実行するために使用されるシェル スクリプトのコピーを次に示します。

#!/usr/bin/env bash
basedir=${0%/*}
cd "$basedir/../src"

etc="../etc"
pydoc="../pydoc"
pydoc_ftests="../pydoc/ftests"

mkdir -p $pydoc
mkdir -p $pydoc_ftests

epydoc -v --config $etc/epydoc.config
epydoc -v --config $etc/epydoc.ftests.config

助言がありますか?

4

1 に答える 1

0

最後に、私がやったことは、epydocコマンドに--parse-onlyを含めて、何もインポートしないようにすることでした(したがって、場所を特定できないインポートの問題を回避しましたが、なぜそれが起こったのかは実際には答えていません)。完璧なソリューションではありませんが、要件を満たしていました...

于 2011-05-31T19:15:27.750 に答える