pytest-yapf3 0.3.0

Validate your Python file format with yapf

pytest-yapf3

Validate your Python file format with yapf.

This is a pytest plugin, which make sure your python file is exactly formatted by yapf, or it will crash when running pytest.

Install

pip install pytest-yapf3

Usage

Modify setup.cfg (or pytest.ini):

[tool:pytest]
addopts =
    --yapf
    --yapfdiff

Add --yapf to pytest configuration addopts. By default, only line summaries is displayed. With --yapfdiff, a full text of yapf -d is displayed.

Features and Todos

• Basic support to validate yapf.
• Fix the diff line count error and improve the performance.
• Display YAPF-check as the error session name.
• Display YAPF in pytest --verbose.
• Support --yapf-ignore to ignore specified files.
• Skip running if a file is not changed.
• 100% test coverage.

Develop

Prepare the environment:

source your/virtual/env
pip install -e .[dev]

Run test:

pytest

License

The MIT License (MIT)

Copyright (c) 2019 Yan QiDong

This repository is forked from pytest-yapf in 2019, which is not maintained since 2017. Besides extra features, the project structure is adjusted, and the code is enhanced to pass linters like flake8, pylint and, of course, yapf.

Change Log

Release 0.3.0

• Display YAPF-check as the error session name
• Display ::YAPF in pytest --verbose

Release 0.2.0

Since forked from pytest-yapf 0.1.1, there are some improvements:

• Restructure the project and rewrite documents
• Support Python 3.4+ only
• Add linters to pytest, and fix their errors
• Fix the line count error
• Change build configurations in Travis and AppVeyor
• Support coverage and displayed in codecov