pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-05 12:36:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document Legacy API

Browse source
This commit is contained in:
Ian Cordasco 2016-07-14 08:13:10 -05:00
parent 911c69f0fd
commit ec678de427
No known key found for this signature in database
GPG key ID: 656D3395E4A9791A
2 changed files with 106 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/flake8/api/legacy.py
View file

@ -156,6 +156,10 @@ class Report(object):
There are important changes in how this object behaves compared to
the object provided in Flake8 2.x.
.. warning::
This should not be instantiated by users.
.. versionchanged:: 3.0.0
"""
@ -174,7 +178,15 @@ class Report(object):
return self._application.result_count
def get_statistics(self, violation):
"""Get the number of occurences of a violation."""
"""Get the list of occurences of a violation.
:returns:
List of occurrences of a violation formatted as:
{Count} {Error Code} {Message}, e.g.,
``8 E531 Some error message about the error``
:rtype:
list
"""
return [
'{} {} {}'.format(s.count, s.error_code, s.message)
for s in self._stats.statistics_for(violation)