pytest-yapf3

使用 yapf 验证您的 Python 文件格式。

这是一个pytest插件，它可以确保你的 python 文件完全被 yapf 格式化，否则运行时会崩溃pytest。

安装

pip install pytest-yapf3

要求：

• Python 3.6 或以上
• Pytest 5.4 或以上

如果有人在 Python 3.5 或低于 5.4 的 Pytest 中使用它，请设置'pytest-yapf3<0.6.0'.

用法

修改setup.cfg（或pytest.ini）：

[tool:pytest]
addopts =
    --yapf
    --yapfdiff
yapf-ignore =
    setup.py
    src/package/auto_generated/**.py

添加--yapf到pytest配置addopts。如果使用 运行pytest -m yapf，则仅yapf选中。

默认情况下，仅显示行摘要。使用可选--yapfdiff的 ，将yapf -d显示 的全文。如果此处未配置，pytest --yapfdiff也可以使用。

支持一个可选yapf-ignore的。每行指定一个不应该检查的文件的全局模式yapf。

将pytest缓存pytest-yapf3的成功结果，如果文件没有改变，将不再检查。有时您可能想要禁用它。有2种方式：

• pytest -p no:cacheprovider 如果任何其他 pytest 插件不支持，这可能会崩溃。
• rm -rf .pytest_cache/v/yapf 这很丑陋，但对任何环境都是安全的。

功能和待办事项

• 验证的基本支持yapf。
• 修复 diff 行数错误并提高性能。
• 显示YAPF-check为错误会话名称。
• 显示YAPF在pytest --verbose.
• 添加yapf为标记以启用pytest -m yapf.
• 支持yapf-ignore忽略指定文件。
• 如果文件未更改，则跳过运行。
• 100% 的测试覆盖率。

开发

准备环境：

pipenv install --dev
pipenv shell

运行测试：

pytest

徽章

和black一样，如果你的项目总是通过本项目提供的 yapf 检查，你可以使用非官方的徽章来炫耀。

降价（README.md）

[![Code style: yapf](https://img.shields.io/badge/code%20style-yapf-blue)](https://github.com/google/yapf)

reStructuredText (README.rst)

.. image:: https://img.shields.io/badge/code%20style-yapf-blue
    :target: https://github.com/google/yapf
    :alt: Code style: yapf

执照

麻省理工学院许可证 (MIT)

版权所有 (c) 2019~2020 严启东

这个存储库是2019 年从pytest-yapf派生的，自 2017 年起不再维护。除了额外的功能外，还调整了项目结构，并增强了代码以通过 flake8、pylint，当然还有 yapf 等 linter。

3in表示这个pytest-yapf3包只支持 Python 3。

更改日志

发布 0.6.1

• 修复缓存丢失。

发布 0.6.0

• 将 pytest 升级到 5.4+，修复警告。
• 只支持python 3.6+，放弃3.5
• 将 Pipfile 与pipenv

发布 0.5.1

• 修复覆盖缺失的行。
• 100% 的测试覆盖率。
• 修复 yapf 崩溃时的崩溃。
• 将发展状态改为稳定。

发布 0.5.0

• 如果文件未更改，则跳过运行。
• 在 README 中添加更多使用说明。

发布 0.4.0

• 添加yapf为 pytest 标记以启用pytest -m yapf
• 支持yapf-ignore忽略指定文件
• 修复由以下原因引起的概率问题\r

发布 0.3.0

• 显示YAPF-check为错误会话名称
• 显示::YAPF在pytest --verbose

发布 0.2.0

由于从pytest-yapf 派生 0.1.1，有一些改进：

• 重组项目并重写文档
• 仅支持 Python 3.4+
• 将 linter 添加到 pytest，并修复它们的错误
• 修复行数错误
• 在Travis和AppVeyor中更改构建配置
• 支持覆盖并显示在codecov中