File: README.rst

package info (click to toggle)
pytest-pylint 0.14.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 180 kB
  • sloc: python: 579; makefile: 9
file content (123 lines) | stat: -rw-r--r-- 3,264 bytes parent folder | download | duplicates (2)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
pytest pylint
-------------
.. image:: https://img.shields.io/travis/carsongee/pytest-pylint.svg
    :target: https://travis-ci.org/carsongee/pytest-pylint
.. image:: https://img.shields.io/coveralls/carsongee/pytest-pylint.svg
    :target: https://coveralls.io/r/carsongee/pytest-pylint
.. image:: https://img.shields.io/pypi/v/pytest-pylint.svg
    :target: https://pypi.python.org/pypi/pytest-pylint
.. image:: https://anaconda.org/conda-forge/pytest-pylint/badges/version.svg
   :target: https://anaconda.org/conda-forge/pytest-pylint
.. image:: https://anaconda.org/conda-forge/pytest-pylint/badges/downloads.svg
    :target: https://anaconda.org/conda-forge/pytest-pylint
.. image:: https://img.shields.io/pypi/l/pytest-pylint.svg
    :target: https://pypi.python.org/pypi/pytest-pylint

Run pylint with pytest and have configurable rule types
(i.e. Convention, Warn, and Error) fail the build.  You can also
specify a pylintrc file.

Sample Usage
============
.. code-block:: shell

   py.test --pylint

would be the most simple usage and would run pylint for all error messages.

.. code-block:: shell

   py.test --pylint --pylint-rcfile=/my/pyrc --pylint-error-types=EF --pylint-jobs=4

This would use the pylintrc file at /my/pyrc, only error on pylint
Errors and Failures, and use 4 cores for running pylint.

You can restrict your test run to only perform pylint checks and not any other
tests by typing:

.. code-block:: shell

    py.test --pylint -m pylint

Acknowledgements
================

This code is heavily based on 
`pytest-flakes <https://github.com/fschulze/pytest-flakes>`_


Releases
========

0.14.0
~~~~~~

- Added support for Pylint's ignore-patterns for regex based ignores
  thanks to `khokhlin <https://github.com/khokhlin>`_
- pytest-pylint now caches successful pylint checks to speedup test
  reruns when files haven't changed thanks to `yanqd0
  <https://github.com/yanqd0>`_

0.13.0
~~~~~~

- Python 3.7 compatibility verified
- Ignore paths no longer match partial names thanks to `heoga
  <https://github.com/heoga>`_

0.12.3
~~~~~~

- `jamur2 <https://github.com/jamur2>`_ corrected issue where file
  paths where not being output properly on lint failures.

0.12.2
~~~~~~

- Resolved issue where failing files weren't reported thanks to reports from
  `skirpichev <https://github.com/skirpichev>`_ and `jamur2 <https://github.com/jamur2>`_


0.12.1
~~~~~~

- Corrected a bug preventing this plugin from working with py.test >= 3.7.0.

0.12.0
~~~~~~

- `jwkvam <https://github.com/jwkvam>`_ added progress output during linting.

0.11.0
~~~~~~

- Added option ``--no-pylint`` to override ``--pylint`` for cases when
  it's turned on by default.

0.10.0
~~~~~~

- `jwkvam <https://github.com/jwkvam>`_ provided support for pylint 2.0

0.9.0
~~~~~

- `noisecapella <https://github.com/noisecapella>`_ added an option to
  run pylint with multiple processes

0.8.0
~~~~~

- `bdrung <https://github.com/bdrung>`_ corrected inconsitent returns in a function
- Dropped Python 3.3 support

0.7.1
~~~~~

- Corrected path issue reported by `Kargathia <https://github.com/Kargathia>`_

0.7.0
~~~~~

- Linting is performed before tests which enables code duplication
  checks to work along with a performance boost, thanks to @heoga