roslint.pep8.BaseReport Class Reference

Inheritance diagram for roslint.pep8.BaseReport:

Public Member Functions
def	__init__ (self, options)
def	error (self, line_number, offset, text, check)
def	get_count (self, prefix='')
def	get_file_results (self)
def	get_statistics (self, prefix='')
def	increment_logical_line (self)
def	init_file (self, filename, lines, expected, line_offset)
def	print_benchmark (self)
def	print_statistics (self, prefix='')
def	start (self)
def	stop (self)

Public Attributes
	counters
	elapsed
	expected
	file_errors
	filename
	line_offset
	lines
	messages
	total_errors

Static Public Attributes
bool	print_filename = False

Private Attributes
	_benchmark_keys
	_ignore_code
	_start_time

Detailed Description

Collect the results of the checks.

Definition at line 1612 of file pep8.py.

Constructor & Destructor Documentation

def roslint.pep8.BaseReport.__init__	(		self,
			options
	)

Definition at line 1617 of file pep8.py.

Member Function Documentation

def roslint.pep8.BaseReport.error	(		self,
			line_number,
			offset,
			text,
			check
	)

Report an error, according to options.

Definition at line 1648 of file pep8.py.

def roslint.pep8.BaseReport.get_count	(		self,
			prefix = ''
	)

Return the total count of errors and warnings.

Definition at line 1671 of file pep8.py.

def roslint.pep8.BaseReport.get_file_results

(

self

)

Return the count of errors and warnings for this file.

Definition at line 1667 of file pep8.py.

def roslint.pep8.BaseReport.get_statistics	(		self,
			prefix = ''
	)

Get statistics for message codes that start with the prefix.

prefix='' matches all errors and warnings
prefix='E' matches all errors
prefix='W' matches all warnings
prefix='E4' matches all errors that have to do with imports

Definition at line 1676 of file pep8.py.

def roslint.pep8.BaseReport.increment_logical_line

(

self

)

Signal a new logical line.

Definition at line 1644 of file pep8.py.

def roslint.pep8.BaseReport.init_file	(		self,
			filename,
			lines,
			expected,
			line_offset
	)

Signal a new file.

Definition at line 1634 of file pep8.py.

def roslint.pep8.BaseReport.print_benchmark

(

self

)

Print benchmark numbers.

Definition at line 1692 of file pep8.py.

def roslint.pep8.BaseReport.print_statistics	(		self,
			prefix = ''
	)

Print overall statistics (number of errors and warnings).

Definition at line 1687 of file pep8.py.

def roslint.pep8.BaseReport.start

(

self

)

Start the timer.

Definition at line 1626 of file pep8.py.

def roslint.pep8.BaseReport.stop

(

self

)

Stop the timer.

Definition at line 1630 of file pep8.py.

Member Data Documentation

roslint.pep8.BaseReport._benchmark_keys

private

Definition at line 1618 of file pep8.py.

roslint.pep8.BaseReport._ignore_code

private

Definition at line 1619 of file pep8.py.

roslint.pep8.BaseReport._start_time

private

Definition at line 1628 of file pep8.py.

roslint.pep8.BaseReport.counters

Definition at line 1623 of file pep8.py.

roslint.pep8.BaseReport.elapsed

Definition at line 1621 of file pep8.py.

roslint.pep8.BaseReport.expected

Definition at line 1638 of file pep8.py.

roslint.pep8.BaseReport.file_errors

Definition at line 1640 of file pep8.py.

roslint.pep8.BaseReport.filename

Definition at line 1636 of file pep8.py.

roslint.pep8.BaseReport.line_offset

Definition at line 1639 of file pep8.py.

roslint.pep8.BaseReport.lines

Definition at line 1637 of file pep8.py.

roslint.pep8.BaseReport.messages

Definition at line 1624 of file pep8.py.

bool roslint.pep8.BaseReport.print_filename = False

static

Definition at line 1615 of file pep8.py.

roslint.pep8.BaseReport.total_errors

Definition at line 1622 of file pep8.py.

---

The documentation for this class was generated from the following file:

• pep8.py