pydocstyle打印调试信息

时间:2019-04-02 21:16:32

标签: python docstring

我刚刚使用pip在Windows中安装了pydocstyle:

python -m pip install pydocstyle

现在,当我使用这样的命令运行它时:

pycodestyle "Z:/path/to/my/file.py"

它会打印出一大堆调试信息,如下所示:

LA2PC018 2019-04-02 14:08:58,726 DEBUG   | got_newline: True
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | parsing definition list, current token is tk.DEDENT ()
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | got_newline: False
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | parsing definition list, current token is tk.NAME (_docs)
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | got_newline: True
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | parsing definition list, current token is tk.OP (+=)
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | got_newline: False
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | parsing definition list, current token is tk.STRING ('"""\n')
LA2PC018 2019-04-02 14:08:58,726 DEBUG   | got_newline: False
LA2PC018 2019-04-02 14:08:58,727 DEBUG   | parsing definition list, current token is tk.NEWLINE (
)
LA2PC018 2019-04-02 14:08:58,727 DEBUG   | got_newline: False
LA2PC018 2019-04-02 14:08:58,727 DEBUG   | parsing definition list, current token is tk.NL (
)
LA2PC018 2019-04-02 14:08:58,727 DEBUG   | got_newline: True
LA2PC018 2019-04-02 14:08:58,727 DEBUG   | parsing definition list, current token is tk.NAME (return)
LA2PC018 2019-04-02 14:08:58,729 DEBUG   | got_newline: False
LA2PC018 2019-04-02 14:08:58,729 DEBUG   | parsing definition list, current token is tk.NAME (_docs)
LA2PC018 2019-04-02 14:08:58,729 DEBUG   | got_newline: False
LA2PC018 2019-04-02 14:08:58,729 DEBUG   | parsing definition list, current token is tk.NEWLINE (
)

有没有一种方法可以抑制这种情况并只获取输出?我似乎以某种方式在调试模式下运行它,但是我看不到是怎么回事。

我正在使用3.0.0版。

$ pydocstyle --version
3.0.0

1 个答案:

答案 0 :(得分:0)

您有一个配置文件,用于设置-d / --debug选项。 pydocstyle会在您检查的文件目录中查找配置文件,每个父目录都查找根目录。

listed supported filenames中查找文件,并使用找到的第一个受支持名称:

setup.cfg
tox.ini
.pydocstyle
.pydocstyle.ini
.pydocstylerc
.pydocstylerc.ini
.pep257

如果该文件具有pydocstylepep257部分,则使用该文件。默认情况下,搜索也会在父目录中继续进行,并且结果将合并,请参见Inheritance

在该过程中的某个地方找到一个debug = True配置条目,并且该设置导致此级别的噪声。

找到这些文件和禁用该行的行,使用--config选项来指定另一个用于配置的文件。该文件可以为空。

如果您在查找配置文件时遇到问题,则可以可以运行pydocstyle --debug "Z:/path/to/my/file.py"(因此可以使用--debug start )和该工具如果找到配置文件,将为每个目录打印出来,如果找到了,它将打印出来。

话虽如此,在您的特定情况下似乎还有更多事情要做,pydocstyle明确地将输出处理程序配置为仅使用日志消息的级别名称和消息参数。您的输出中还包含日期时间戳和LA2PC018前缀,这表明其他仍在添加更多日志记录配置。这表明也许正在导入一个非标准模块,该模块恰好提供了足够的匹配功能以使其仍然可以工作,而且还为日志记录框架配置了其他处理程序。

如果您使用python -v -m pydocstyle "Z:/path/to/my/file.py"运行该工具,则会产生更多 lot 个输出;这会添加import ...日志记录输出以及为这些导入加载的文件。对此进行梳理,以查看是否导入了标准库之外的任何内容,例如site-packages之外的对象,而不是_frozen_importlib*对象。