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
pip install pytest-yapf3
- Python 3.6 or above
- Pytest 5.4 or above
If someone use this with Python 3.5 or Pytest less than 5.4, set
[tool:pytest] addopts = --yapf --yapfdiff yapf-ignore = setup.py src/package/auto_generated/**.py
--yapf to pytest configuration
If run with
pytest -m yapf, only
yapf is checked.
By default, only line summaries is displayed.
With an optional
--yapfdiff, a full text of
yapf -d is displayed.
If not configured here,
pytest --yapfdiff will also work.
yapf-ignore is supported.
Each line specifies a glob pattern of files which should not check
pytest will cache success results of pytest-yapf3, and will not check again if files not changed.
Sometimes you may want to disable it.
There are 2 ways:
pytest -p no:cacheproviderThis may crash if any other pytest plugin not supports.
rm -rf .pytest_cache/v/yapfThis is ugly, but safe for any environment.
Features and Todos
- Basic support to validate
- Fix the diff line count error and improve the performance.
YAPF-checkas the error session name.
yapfas a marker to enable
pytest -m yapf.
yapf-ignoreto ignore specified files.
- Skip running if a file is not changed.
- 100% test coverage.
Prepare the environment:
pipenv install --dev pipenv shell
Like black, if your project always pass yapf checking provided by this project, you can use an unofficial badge to show off.
[![Code style: yapf](https://img.shields.io/badge/code%20style-yapf-blue)](https://github.com/google/yapf)
.. image:: https://img.shields.io/badge/code%20style-yapf-blue :target: https://github.com/google/yapf :alt: Code style: yapf
The MIT License (MIT)
Copyright (c) 2019~2020 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.
pytest-yapf3 means this package supports Python 3 only.