1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
# pylint-plugin-utils
## Status
[](https://github.com/PyCQA/pylint-plugin-utils/actions)
[](https://coveralls.io/github/PyCQA/pylint-plugin-utils?branch=master)
[](https://github.com/ambv/black)
[](https://pypi.python.org/pypi/pylint-plugin-utils)
# 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](https://github.com/PyCQA/pylint-django) and [pylint-celery](https://github.com/PyCQA/pylint-celery).
# Testing
Create virtualenv:
```bash
python3.8 -m venv .pylint-plugin-utils
source .pylint-plugin-utils/bin/activate
pip install --upgrade pip setuptools
```
We use [tox](https://tox.readthedocs.io/en/latest/) for running the test suite. You should be able to install it with:
```bash
pip install tox pytest
```
To run the test suite for a particular Python version, you can do:
```bash
tox -e py38
```
To run individual tests with ``tox``, you can do:
```bash
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](https://docs.pytest.org/en/latest/), [pytest-cov](https://pypi.org/project/pytest-cov/) and your local python version::
```bash
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.
|
