Public Member Functions | Public Attributes | Private Attributes | List of all members
roslint.pycodestyle.Checker Class Reference

Framework to run all checks. More...

Inheritance diagram for roslint.pycodestyle.Checker:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, filename=None, lines=None, options=None, report=None, kwargs)
 
def build_tokens_line (self)
 
def check_all (self, expected=None, line_offset=0)
 
def check_ast (self)
 
def check_logical (self)
 
def check_physical (self, line)
 
def generate_tokens (self)
 
def init_checker_state (self, name, argument_names)
 
def maybe_check_physical (self, token)
 
def readline (self)
 
def report_invalid_syntax (self)
 
def run_check (self, check, argument_names)
 

Public Attributes

 blank_before
 
 blank_lines
 
 checker_state
 
 filename
 
 hang_closing
 
 indent_char
 
 indent_level
 
 line_number
 
 lines
 
 logical_line
 
 max_doc_length
 
 max_line_length
 
 multiline
 
 noqa
 
 physical_line
 
 previous_indent_level
 
 previous_logical
 
 previous_unindented_logical_line
 
 report
 
 report_error
 
 tokens
 
 total_lines
 
 verbose
 

Private Attributes

 _ast_checks
 
 _checker_states
 
 _io_error
 
 _logical_checks
 
 _physical_checks
 

Detailed Description

Framework to run all checks.

Load a Python source file, tokenize it, check coding style.

Definition at line 1904 of file pycodestyle.py.

Constructor & Destructor Documentation

◆ __init__()

def roslint.pycodestyle.Checker.__init__ (   self,
  filename = None,
  lines = None,
  options = None,
  report = None,
  kwargs 
)

Definition at line 1908 of file pycodestyle.py.

Member Function Documentation

◆ build_tokens_line()

def roslint.pycodestyle.Checker.build_tokens_line (   self)
Build a logical line from tokens.

Definition at line 1998 of file pycodestyle.py.

◆ check_all()

def roslint.pycodestyle.Checker.check_all (   self,
  expected = None,
  line_offset = 0 
)
Run all checks on the input file.

Definition at line 2126 of file pycodestyle.py.

◆ check_ast()

def roslint.pycodestyle.Checker.check_ast (   self)
Build the file's AST and run all AST checks.

Definition at line 2066 of file pycodestyle.py.

◆ check_logical()

def roslint.pycodestyle.Checker.check_logical (   self)
Build a line from tokens and run all logical checks on it.

Definition at line 2031 of file pycodestyle.py.

◆ check_physical()

def roslint.pycodestyle.Checker.check_physical (   self,
  line 
)
Run all physical checks on a raw input line.

Definition at line 1986 of file pycodestyle.py.

◆ generate_tokens()

def roslint.pycodestyle.Checker.generate_tokens (   self)
Tokenize file, run physical line checks and yield tokens.

Definition at line 2078 of file pycodestyle.py.

◆ init_checker_state()

def roslint.pycodestyle.Checker.init_checker_state (   self,
  name,
  argument_names 
)
Prepare custom state for the specific checker plugin.

Definition at line 1981 of file pycodestyle.py.

◆ maybe_check_physical()

def roslint.pycodestyle.Checker.maybe_check_physical (   self,
  token 
)
If appropriate for token, check current physical line(s).

Definition at line 2093 of file pycodestyle.py.

◆ readline()

def roslint.pycodestyle.Checker.readline (   self)
Get the next line from the input buffer.

Definition at line 1964 of file pycodestyle.py.

◆ report_invalid_syntax()

def roslint.pycodestyle.Checker.report_invalid_syntax (   self)
Check if the syntax is valid.

Definition at line 1951 of file pycodestyle.py.

◆ run_check()

def roslint.pycodestyle.Checker.run_check (   self,
  check,
  argument_names 
)
Run a check plugin.

Definition at line 1974 of file pycodestyle.py.

Member Data Documentation

◆ _ast_checks

roslint.pycodestyle.Checker._ast_checks
private

Definition at line 1916 of file pycodestyle.py.

◆ _checker_states

roslint.pycodestyle.Checker._checker_states
private

Definition at line 1924 of file pycodestyle.py.

◆ _io_error

roslint.pycodestyle.Checker._io_error
private

Definition at line 1913 of file pycodestyle.py.

◆ _logical_checks

roslint.pycodestyle.Checker._logical_checks
private

Definition at line 1915 of file pycodestyle.py.

◆ _physical_checks

roslint.pycodestyle.Checker._physical_checks
private

Definition at line 1914 of file pycodestyle.py.

◆ blank_before

roslint.pycodestyle.Checker.blank_before

Definition at line 2043 of file pycodestyle.py.

◆ blank_lines

roslint.pycodestyle.Checker.blank_lines

Definition at line 2063 of file pycodestyle.py.

◆ checker_state

roslint.pycodestyle.Checker.checker_state

Definition at line 1984 of file pycodestyle.py.

◆ filename

roslint.pycodestyle.Checker.filename

Definition at line 1922 of file pycodestyle.py.

◆ hang_closing

roslint.pycodestyle.Checker.hang_closing

Definition at line 1920 of file pycodestyle.py.

◆ indent_char

roslint.pycodestyle.Checker.indent_char

Definition at line 1971 of file pycodestyle.py.

◆ indent_level

roslint.pycodestyle.Checker.indent_level

Definition at line 2041 of file pycodestyle.py.

◆ line_number

roslint.pycodestyle.Checker.line_number

Definition at line 2118 of file pycodestyle.py.

◆ lines

roslint.pycodestyle.Checker.lines

Definition at line 1927 of file pycodestyle.py.

◆ logical_line

roslint.pycodestyle.Checker.logical_line

Definition at line 2027 of file pycodestyle.py.

◆ max_doc_length

roslint.pycodestyle.Checker.max_doc_length

Definition at line 1918 of file pycodestyle.py.

◆ max_line_length

roslint.pycodestyle.Checker.max_line_length

Definition at line 1917 of file pycodestyle.py.

◆ multiline

roslint.pycodestyle.Checker.multiline

Definition at line 1919 of file pycodestyle.py.

◆ noqa

roslint.pycodestyle.Checker.noqa

Definition at line 1949 of file pycodestyle.py.

◆ physical_line

roslint.pycodestyle.Checker.physical_line

Definition at line 1988 of file pycodestyle.py.

◆ previous_indent_level

roslint.pycodestyle.Checker.previous_indent_level

Definition at line 2059 of file pycodestyle.py.

◆ previous_logical

roslint.pycodestyle.Checker.previous_logical

Definition at line 2060 of file pycodestyle.py.

◆ previous_unindented_logical_line

roslint.pycodestyle.Checker.previous_unindented_logical_line

Definition at line 2062 of file pycodestyle.py.

◆ report

roslint.pycodestyle.Checker.report

Definition at line 1947 of file pycodestyle.py.

◆ report_error

roslint.pycodestyle.Checker.report_error

Definition at line 1948 of file pycodestyle.py.

◆ tokens

roslint.pycodestyle.Checker.tokens

Definition at line 2064 of file pycodestyle.py.

◆ total_lines

roslint.pycodestyle.Checker.total_lines

Definition at line 2129 of file pycodestyle.py.

◆ verbose

roslint.pycodestyle.Checker.verbose

Definition at line 1921 of file pycodestyle.py.


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


roslint
Author(s): Mike Purvis, Jack O'Quin
autogenerated on Sun Mar 5 2023 03:27:29