tidypy下载 - tidypy源代码下载

tidypy

其他类别

1.0.0

下载

tidypy

退休

该项目不再积极维护。

内容

tidypy
退休
- 概述
- 特征
- 用法
- Docker
- 配置
- 忽略问题
- 包括工具
- 包括记者
- 包括集成
- 扩展易变
- 常见问题解答
- 贡献
- 执照

概述

Tidypy是一种封装许多其他静态分析工具的工具，并使其易于配置，执行和查看其结果。

特征

这是用于对整个Python项目进行静态分析的合并工具 - 不仅是您的*.py源文件。除了执行代码上的许多不同工具外，它还可以检查您的YAML，JSON，PO，POT和RST文件。
Tidypy并没有在项目中放置另一个专业配置文件，而是使用pyproject.toml文件，由PEP 518定义。所有工具的所有选项都在一个地方声明，而不是要求您以不同的方式配置每个工具。
在您的Python来源中尊重伪标准# noqa评论，以轻松忽略任何工具报告的问题。
包括许多集成，因此您可以将其与您喜欢的工具链一起使用。
包括各种记者，可让您以最适合您的方式查看或使用Tidypy分析的结果。
为您提供一个简单的API，以实现自己的工具或记者，并将其包括在项目分析中。
支持Python 2和3以及PYPY。甚至在Windows上运行。

用法

安装TidyPy（ pip install tidypy tidypy时，应在您的环境中可用：

 $ tidypy--螺旋
用法：tidypy [options]命令[args] ...

  在Python项目上执行多个静态分析工具的工具
  并汇总结果。

选项：
   -  Version显示版本和退出。
   - 主持人显示此消息和退出。

命令：
  检查在项目文件上执行工具。
  Default-Config输出默认配置，可用于
                      引导自己的配置文件。
  扩展输出所有可用的tidypy扩展名的清单。
  安装VCS将Tidypy作为预先承诺的挂钩安装到指定的
                      VCS。
  列表代码输出所有已知问题代码的清单
                      可以举报。
  吹扫-Config-cache删除了从
                      在主要配置之外。
  删除-VC从指定的
                      VCS。

要使TidyPy分析您的项目，请使用check子命令：

 $ tidypy检查 - 螺旋
用法：Tidypy检查[选项] [路径]

  在项目文件上执行工具。

  接受一个论点，这是通往Python项目基础的道路。
  如果未指定，则默认为当前工作目录。

选项：
  -x， - 隔离正则指定正则表达式匹配
                                  反对您想排除的道路
                                  考试。可以指定多个
                                  时代。覆盖指定的表达式
                                  在配置文件中。
  -t，-tool [Bandit | dlint |根除| JSONLINT |清单| McCabe | Polint | Pycodestyle | Pydiatra | Pydoctyle | Pydocstyle | Pydocstyle | Pyflakes | Pyflakes | Pylint | Pyromal | Pyroma | pyroma | rstlint | rstlint |秘密| Vulture | Vulture | Vulture | Yamllint]
                                  指定在此期间使用的工具的名称
                                  考试。可以指定多个
                                  时代。覆盖配置文件。
  -r， - 报告[控制台，CSV，Custom，Json，Null，PyCodestyle，Pycodestyle，Pylint，Pylint-parsable，toml，yaml] [：filename]
                                  指定要执行的报告的名称
                                  考试后。可以指定一个
                                  使用表单-r的可选输出文件名
                                  报告：文件名。如果文件名不设，则
                                  报告将在Stdout上写。可以
                                  多次指定。覆盖
                                  配置文件。
  -c， -  config文件名指定了通往幻想的路径
                                  配置文件而不是
                                  在项目中找到的配置
                                  pyproject.toml。
   - 工人num_workers同时使用的工人人数
                                  执行工具。覆盖
                                  配置文件。
   - 易于混合禁用各种问题的合并
                                  工具当Tidypy认为它们等效时。
                                  覆盖配置文件。
   - 可行的过程禁用进度栏的显示。
   -  disable-noqa可以禁用使用使用的能力
                                  Python文件中的“＃NOQA”注释。
   - 可访问时可用于检索时缓存的使用
                                  “扩展”引用的配置
                                  选项。
   - 主持人显示此消息和退出。

如果您需要使用默认选项生成骨架配置文件，请使用default-config子命令：

 $ tidypy默认config-螺旋
用法：tidypy默认config [options]

  输出默认配置，可用于引导您自己的
  配置文件。

选项：
   - 型 - 八型将配置输出，以便可以在pyproject.toml中使用它
               文件。
   - 主持人显示此消息和退出。

如果您想查看可以返回的可能问题代码的列表，请使用list-codes命令：

 $ tidypy列表编码 - 螺旋
用法：Tidypy列表编码[选项]

  输出工具可能报告的所有已知问题代码的列表。

选项：
  -t，-tool [Bandit | dlint |根除| JSONLINT |清单| McCabe | Polint | Pycodestyle | Pydiatra | Pydoctyle | Pydocstyle | Pydocstyle | Pyflakes | Pyflakes | Pylint | Pyromal | Pyroma | pyroma | rstlint | rstlint |秘密| Vulture | Vulture | Vulture | Yamllint]
                                  指定代码的工具的名称
                                  应该输出。如果未指定，默认
                                  到所有工具。
  -f， -  format [toml | json | yaml | csv]
                                  指定工具的格式
                                  应该输出。如果未指定，默认
                                  到汤姆尔。
   - 主持人显示此消息和退出。

如果要在项目的VCS中安装或删除作为预先承诺的钩子，请使用install-vcs / remove-vcs子命令：

 $ tidypy install-vcs-Help
用法：tidypy install-vcs [options] vcs [path]

  将TIDYPY作为预先承诺的钩子安装到指定的VC中。

  接受两个论点：

    VCS：将钩子安装到的版本控制系统。选择：
    Git，HG

    路径：通往存储库底座的路径，将钩子安装到。
    如果未指定，则默认为当前工作目录。

选项：
   - 如果发现缝隙
            问题。
   - 主持人显示此消息和退出。

$ tidypy remove-vcs-Help
用法：tidypy remove-vcs [options] vcs [path]

  从指定的VC中删除tidypy的预加入钩。

  接受两个论点：

    VCS：从中卸下钩子的版本控制系统。选择：
    Git，HG

    路径：通往存储库底座的路径以从中卸下钩子。如果
    未指定，默认为当前工作目录。

选项：
   - 主持人显示此消息和退出。

如果您想启用tidypy的bash完成，请在外壳中运行以下内容（或将其放入bash启动脚本中）：

 $ est

Docker

如果您不想在系统或Virtualenv上本地安装Tidypy，则可以使用已发布的Docker Image：

 $ docker run -rm -tty -tty -volume =`pwd`：/project tidypy/tidypy

上面的命令将在当前目录的内容上运行tidypy check 。如果您想在其他目录上运行它，请将`pwd`更改为所需的任何路径（目标是将项目目录安装到容器/project量中）。

以这种方式运行易变具有一些限制，主要是围绕以下事实：由于Tidypy是按照自己的，孤立的Python环境运行的，诸如Pylint之类的工具将无法在本地安装您的项目包装，因此它可能会报告围绕“ Import-Error”，“无名模型”，“ No Mecember”，“ No-Meber”，“”，“”等误报，等等。

如果要运行check以外的其他命令，请在调用Docker时通过该命令：

 $ docker run  -  rm -tty -tty-volume =`pwd`：/project tidypy/tidypy tidypy list-codes

配置

托多

忽略问题

除了通过配置文件从工具中忽略整个文件，工具或特定问题类型外，还可以使用Python源文件中的注释来忽略特定行上的问题。有些工具为此具有自己的内置支持和符号：

皮特将尊重看起来像： # pylint评论
强盗将尊重看起来像： # nosec评论
pycodestyle将尊重看起来像： # noqa评论
PydocStyle还将尊重看起来像： # noqa评论
检测秘密将尊重看起来像： # pragma: whitelist secret评论

Tidypy超出了这些特定于工具的标志，可以在全球范围内为Python源文件实现# noqa 。无论工具提出什么工具，它都会忽略具有# noqa评论的行的问题。如果您只想在行上忽略特定类型的问题，则可以使用以下语法：

 ＃NOQA：Code1，Code2

或者，如果在多个工具中使用了特定代码，则可以在注释中指定确切的工具：

 ＃NOQA：PyCodestyle：Code1，Pylint：Code2

或者，如果您想忽略任何特定工具在行上提出的任何问题，则可以指定该工具：

 ＃NOQA： @PyCodestyle， @Pylint

当然，如果需要，可以在单个评论中混合所有三个符号：

 ＃NOQA：Code1，Pylint：Code2，@PyCodestyle

您可以通过在命令行上指定--disable-noqa选项，或者通过将noqa选项设置为“配置文件中的false来禁用Tidypy的NOQA行为。不过，请注意：目前的PyCodestyle和PydocStyle不尊重此选项，并且将始终尊重他们发现的任何# noqa评论。

包括工具

开箱即用，Tidypy包括对许多工具的支持：

皮层: Pylint是一种Python源代码分析仪，它寻找编程错误，有助于执行某些代码气味的编码标准和嗅探。
pycodestyle: PyCodestyle是一种根据PEP 8中的某些样式惯例检查您的Python代码的工具。
PydocStyle: PydocStyle是一种用于检查符合Python Docstring约定的静态分析工具（例如，PEP 257）。
吡咯: Pyroma测试您项目的包装友好性。
秃鹰: 秃鹰在Python程序中找到未使用的代码。
土匪: Bandit是Python源代码的安全衬里。
根除: 根除在python文件中查找注释的代码。
碎片: Pyflakes是一个简单的程序，它检查Python源文件是否错误。
麦凯布: NED Batchelder的脚本以检查Python代码的McCabe循环复杂性。
jsonlint: 该工具是Demjson软件包的一部分，验证了您的JSON文档，以严格符合JSON规范，并检测潜在的数据可移植性问题。
Yamllint: 顾名思义，Yamllint工具是YAML文件的衬里。
rstlint: 顾名思义，重组的文本薄荷工具是重组文本文件的衬里。
波林: 该工具是丹尼斯软件包的一部分，它将PO和POT文件用于问题。
显现: 使用Check-Manifest脚本来检测项目清单中的差异或问题。
pydiatra: Pydiatra是Python代码的另一个静态检查器。
秘密: 检测销售工具试图在代码库中查找秘密（密钥，密码等）。
dlint: DLINT是鼓励最佳编码实践并帮助确保我们编写安全的Python代码的工具。

包括记者

Tidypy包括许多不同的方法来介绍和/或导出项目分析的结果。开箱即用，提供以下内容：

安慰: 默认记者。向控制台打印一份彩色报告，该报告将分组通过发现的文件发出。
皮层: 向控制台打印报告与Pylint的默认输出相同的格式。
可孔: 向控制台打印报告与Pylint的“可放松”输出的格式大致相同。
pycodestyle: 向控制台打印报告与PyCodestyle的默认输出相同的格式。
JSON: 生成一个包含分析结果的JSON序列化对象。
yaml: 生成一个包含分析结果的YAML序列化对象。
汤姆: 生成一个包含分析结果的TOML序列化对象。
CSV: 生成一组包含分析结果的CSV记录。
风俗: 将OUPUT打印到由项目配置中指定的模板字符串定义的格式的控制台。预计模板字符串将由str.format（）python方法允许。它将收到以下参数： filename ， line ， character ， tool ， code ， message 。

包括集成

Tidypy包含少数插件/集成，将其连接到其他工具中。

pytest: 可以在执行pytest测试套件期间运行tidypy。要启用它，您需要在运行pytest时在命令行上指定--tidypy ，或将其作为addopts属性的一部分包含在pytest config中。
鼻子: 可以在执行鼻子测试套件期间运行tidypy。为了启用它，您可以在鼻子运行时指定命令行上的--with-tidypy ，也可以将with-tidypy属性设置为setup.cfg中的1 。
PBBT: 可以使用tidypy测试将tidypy包含在您的PBBT脚本中。要启用它，您可以在运行PBBT时在命令行上指定--extend=tidypy.plugin.pbbt ，或在setup.cfg或pbbt.yaml中设置extend属性为tidypy.plugin.pbbt 。

扩展易变

存在一个简单的接口，用于扩展潮论，以包括更多和不同的工具和记者。要添加一个工具，请创建一个扩展tidypy.tool的类，在您的setup.py中，请声明tidypy.tools的entry_point 。

 entry_points = {
    'tidypy.tools'：[
        'myCooltool = path.to.model：myCoolToolClassName'，
    ]，，
}

要添加记者，该过程几乎是相同的，只是您扩展了tidypy.Report并声明tidypy.reports的entry_point 。

常见问题解答

没有这样的工具吗？

是的。有探矿者，Pylama，Flake8和Ciocheck仅举几例。但是，就像软件开发世界中的习惯一样，如果轮子不像您想要的那样圆形，则必须花费无数的时间来重新发明它。我尝试了许多这样的工具（甚至为某些工具做出了贡献），但最终，我总是发现缺乏或烦人的东西。因此，Tidypy诞生了。

如何在单个文件上运行tidypy？

简短的答案是，您没有（无论如何，目前）。它并没有考虑到该用例。 Tidypy旨在分析整个项目，并向您展示所有内容。

我尝试了我的项目的幻想，并报告了数百/数千个问题。我的自我现在被瘀伤了。

是的，发生了。我选择遵循此工具的理念是，我不希望它向我隐藏任何东西。我希望其默认行为能够使用最令人讨厌的设置执行其套件中的每个工具。然后，当我看到全部损坏范围时，我可以决定通过项目级配置禁用特定工具或问题。我认为如果有人花时间对特定问题进行检查，他们必须认为这有一定的价值。如果我的工具默认情况下将其隐藏起来，那么我将无法从中获得任何好处。

通常，当您认为自己“完成”时，我不建议开始使用衬里或其他类型的静态分析仪。您应该在项目开始时将它们纳入工作流程中 - 就像您（或应该）单位测试一样。这样，您就很早就找到东西并向它们学习（或禁用它们）。当您逐步解决这些任务时，要处理的任务要艰巨得多。