roslint.pycodestyle.BaseReport Class Reference

Inheritance diagram for roslint.pycodestyle.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 2172 of file pycodestyle.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 2177 of file pycodestyle.py.

Member Function Documentation

error()

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

Report an error, according to options.

Definition at line 2208 of file pycodestyle.py.

get_count()

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

Return the total count of errors and warnings.

Definition at line 2231 of file pycodestyle.py.

get_file_results()

def roslint.pycodestyle.BaseReport.get_file_results

(

self

)

Return the count of errors and warnings for this file.

Definition at line 2227 of file pycodestyle.py.

get_statistics()

def roslint.pycodestyle.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 2236 of file pycodestyle.py.

increment_logical_line()

def roslint.pycodestyle.BaseReport.increment_logical_line

(

self

)

Signal a new logical line.

Definition at line 2204 of file pycodestyle.py.

init_file()

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

Signal a new file.

Definition at line 2194 of file pycodestyle.py.

print_benchmark()

def roslint.pycodestyle.BaseReport.print_benchmark

(

self

)

Print benchmark numbers.

Definition at line 2252 of file pycodestyle.py.

print_statistics()

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

Print overall statistics (number of errors and warnings).

Definition at line 2247 of file pycodestyle.py.

start()

def roslint.pycodestyle.BaseReport.start

(

self

)

Start the timer.

Definition at line 2186 of file pycodestyle.py.

stop()

def roslint.pycodestyle.BaseReport.stop

(

self

)

Stop the timer.

Definition at line 2190 of file pycodestyle.py.

Member Data Documentation

_benchmark_keys

roslint.pycodestyle.BaseReport._benchmark_keys

private

Definition at line 2178 of file pycodestyle.py.

_ignore_code

roslint.pycodestyle.BaseReport._ignore_code

private

Definition at line 2179 of file pycodestyle.py.

_start_time

roslint.pycodestyle.BaseReport._start_time

private

Definition at line 2188 of file pycodestyle.py.

counters

roslint.pycodestyle.BaseReport.counters

Definition at line 2183 of file pycodestyle.py.

elapsed

roslint.pycodestyle.BaseReport.elapsed

Definition at line 2181 of file pycodestyle.py.

expected

roslint.pycodestyle.BaseReport.expected

Definition at line 2198 of file pycodestyle.py.

file_errors

roslint.pycodestyle.BaseReport.file_errors

Definition at line 2200 of file pycodestyle.py.

filename

roslint.pycodestyle.BaseReport.filename

Definition at line 2196 of file pycodestyle.py.

line_offset

roslint.pycodestyle.BaseReport.line_offset

Definition at line 2199 of file pycodestyle.py.

lines

roslint.pycodestyle.BaseReport.lines

Definition at line 2197 of file pycodestyle.py.

messages

roslint.pycodestyle.BaseReport.messages

Definition at line 2184 of file pycodestyle.py.

print_filename

bool roslint.pycodestyle.BaseReport.print_filename = False

static

Definition at line 2175 of file pycodestyle.py.

total_errors

roslint.pycodestyle.BaseReport.total_errors

Definition at line 2182 of file pycodestyle.py.

---

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

• pycodestyle.py