prospector-fixes-232 0.12.7

prospector
==========

.. image:: https://img.shields.io/pypi/v/prospector.svg
:target: https://pypi.python.org/pypi/prospector
:alt: Prospector最新版本
.. image:: https://travis-ci.org/landscapeio/prospector.png?branch=master
:target: https://travis-ci.org/landscapeio/prospector
:alt: 构建状态
.. image:: https://landscape.io/github/landscapeio/prospector/master/landscape.png?style=flat
:target: https://landscape.io/github/landscapeio/prospector/master
:alt: 代码健康度
.. image:: https://img.shields.io/coveralls/landscapeio/prospector.svg?style=flat
:target: https://coveralls.io/r/landscapeio/prospector
:alt: 测试覆盖率
.. image:: https://readthedocs.org/projects/prospector/badge/?version=latest
:target: http://prospector.landscape.io/
:alt: 文档


关于
-----

Prospector是一个分析Python代码的工具，可以输出有关
错误、潜在问题、违反约定和复杂度的信息。

它结合了其他Python分析工具的功能，例如
`Pylint <http://docs.pylint.org/>`_，
`pep8 <http://pep8.readthedocs.org/en/latest/>`_，
并且 `McCabe复杂性 <https://pypi.python.org/pypi/mccabe>`_。
请参阅 `支持的工具 <http://prospector.landscape.io/en/master/supported_tools.html>`_ 的文档部分，获取完整列表。
。

Prospector 的主要目标是“开箱即用”。其他 Python 分析工具的一个常见问题是，筛选出与您的编码风格相关或有趣的错误需要很长时间。
Prospector 提供了一些默认配置文件，希望它们能提供一个良好的起点，并且可以立即使用，并且会根据您项目使用的库调整输出。
。
。
。

安装
------------

可以使用以下命令通过 `pip` 安装 Prospector：

pip install prospector


Prospector 的可选依赖，如 `pyroma`，也可以通过运行以下命令进行安装：

pip install prospector[with_pyroma]


有关所有可选依赖的列表，请参阅 ReadTheDocs 页面上关于 `支持的工具 <https://prospector.landscape.io/en/latest/supported_tools.html#optional-extras>`_ 的可选插件部分。
有关安装工具的更详细信息，请参阅 ReadTheDocs 上工具主页的

`安装部分 <http://prospector.landscape.io/en/latest/#installation>`_。
。
。

文档
-------------

完整的 `文档可在 ReadTheDocs <http://prospector.landscape.io>`_ 上找到。

用法
-----

只需在项目的根目录中运行 prospector 即可：

prospector

这将输出一个消息列表，指出潜在的问题或错误，例如：

prospector.tools.base (prospector/tools/base.py)
L5:0 ToolBase: pylint - R0922
抽象类仅引用 1 次

选项
```````

运行 ``prospector --help`` 获取所有选项及其效果的完整列表。

输出格式
~~~~~~~~~~~~~

``prospector`` 的默认输出格式设计为易于阅读。为了解析（例如，用于报告），您可以使用 ``--output-format json`` 标志来获取 JSON 格式的输出。
。
。

配置文件
~~~~~~~~

Prospector 可以使用“配置文件”进行配置。这些是由指令组成的可组合 YAML 文件，用于禁用或启用工具或消息。有关更多信息，请阅读
`有关配置文件的文档 <http://prospector.landscape.io/en/latest/profiles.html>`_。
。

。
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

。
。
。
。

。

。
。
。

。

。

。
。

。

。
。

严格性
~~~~~~~~~~

Prospector 有一个可配置的“严格性”级别，这将确定其搜索错误的方式有多严格：

prospector --strictness high

可能的值有 ``verylow``、``low``、``medium``、``high``、``veryhigh``。

Prospector 默认不包含文档警告，但您可以将其打开：
使用 ``--doc-warnings`` 标志来做到这一点。


许可证
-------

Prospector 在 GPLv2 许可证下可用。