pylint-plugin-utils

pylint-plugin-utils

Status

About

Utilities and helpers for writing Pylint plugins. This is not a direct Pylint plugin, but rather a set of tools and functions used by other plugins such as pylint-django and pylint-celery.

Testing

Create virtualenv:

python3.8 -m venv .pylint-plugin-utils
source .pylint-plugin-utils/bin/activate
pip install --upgrade pip setuptools

We use tox for running the test suite. You should be able to install it with:

pip install tox pytest

To run the test suite for a particular Python version, you can do:

tox -e py38

To run individual tests with tox, you can do:

tox -e py38 -- -k test_linter_should_be_pickleable

We use pytest for testing pylint, which you can use without using tox for a faster development cycle.

If you want to run tests on a specific portion of the code with pytest, pytest-cov and your local python version::

pip install pytest-cov
# Everything:
python3 -m pytest tests/ --cov=pylint_plugin_utils
coverage html

License

pylint-plugin-utils is available under the GPLv2 License.