Violations¶

Violation - function for parsing raw violation data.

For enabling violation you need to add it to settings.VIOLATIONS, like:

VIOLATIONS = (
    'violations.dummy',
    'violations.pep8',
    'violations.sloccount',
    'violations.py_unittest',
    'violations.pip_review',
    'violations.testem',
)

Available violations¶

violations.coverage.coverage_violation(data)[source]¶

Coverage violation parser

Parameters:	data (dict) – task data
Returns:	dict

violations.dummy.dummy_violation(data)[source]¶

Return data without parsing

Parameters:	data (dict) – task data
Returns:	dict

violations.pep8.pep8_violation(data)[source]¶

PEP8 violation parser

Parameters:	data (dict) – task data
Returns:	dict

violations.pip_review.pip_review_violation(data)[source]¶

pip-review violation parser

Parameters:	data (dict) – task data
Returns:	dict

violations.py_unittest.py_unittest_violation(data)[source]¶

Python unittest violation parser

Parameters:	data (dict) – task data
Returns:	dict

violations.sloccount.sloccount_violation(data)[source]¶

PEP8 violation parser

Parameters:	data (dict) – task data
Returns:	dict

violations.testem.testem_violation(data)[source]¶

Testem violation

Parameters:	data (dict) – task data
Returns:	dict

Violation library¶

class violations.base.ViolationsLibrary[source]¶

Library for register and access available violations

register(name)¶

Register function in library

Parameters:	name (str) – name of method
Returns:	decorator

get(name)¶

Get item from library

Parameters:	name (str) – name of method
Returns:	method – registered method

has(name)¶

Has item in library

Parameters:	name (str) – name of method
Returns:	bool

from violations.base import library

@library.register('violation')
def violation(data):
    return data

library.get('violation')
library.has('violation')

exception¶: alias of ViolationDoesNotExists