我应该如何调试 Trac 插件？

Question

我即将开始大量工作来扩展 Trac 以满足我们的业务需求。 到目前为止，我已经使用 pythonWin 和 Netbeans 6.5 作为开发环境 - 这些似乎都没有提供任何调试我正在开发的插件的方法。

我对 Python 完全陌生，所以可能还没有设置开发环境，如何配置它以进行调试。

我错过了一些明显的东西吗？ 必须诉诸于将调试消息打印到 Trac 日志似乎有点过时，这就是我目前调试的方式。

Answer 1

您可以创建包装器 wsgi 脚本并在调试器中运行它。 例如：

import os
import trac.web.main

os.environ['TRAC_ENV'] = '/path/to/your/trac/env'

application = trac.web.main.dispatch_request

from flup.server.fcgi import WSGIServer
server = WSGIServer(application, bindAddress=("127.0.0.1", 9000), )
server.run()

您可以在调试器中运行此脚本，并且可以使用lighttpd作为Web应用程序的前端，并通过如下简单配置：

server.document-root = "/path/to/your/trac/env"
server.port = 1234
server.modules = ( "mod_fastcgi" )
server.pid-file = "/path/to/your/trac/env/httpd.pid"
server.errorlog = "/path/to/your/trac/env/error.log"
fastcgi.server = ( "/" =>
  (( "host" => "127.0.0.1",
     "port" => 9000,
     "docroot" => "/",
     "check-local" => "disable",
  ))
)

只需在调试器中运行fcgi wsgi包装器，在插件中设置断点，然后打开网页。

Answer 2

通常，我们首先进行单元测试。

然后，我们编写日志消息来诊断问题。

我们通常不会严重依赖调试，因为在 Python 脚本嵌入到较大产品中的情况下通常很难做到这一点。

Answer 3

我发现 Winpdb 是一个不错的 python 调试器。

但正如 S.Lott 指出的那样，当您的项目嵌入到较大的项目中时，调试器可能对您没有多大用处。

Answer 4

Trac 包含很好的 Python 代码示例，使用它作为指南将有助于避免错误。 只要确保测试你的代码，并且经常这样做，因为你是 Python 新手......你会发现你不需要调试器。

对于单元测试，请查看 PyUnit。

Answer 5

我发现在运行时添加那些奇特的 Trac 消息框作为调试帮助或跟踪是最有用的，就像这样：

from trac.web.chrome import add_notice
...
def any_function_somewhere(self, req, ...anyother args...):
    ...
    var = ...some value...
    add_notice(req, "my variable value I am tracing %s" % var)

有时它比事后阅读日志记录更舒服。 尽管它仅在您运行的函数具有该 req 参数时才有效。