Public Member Functions | Public Attributes | List of all members
roslint.pep8.StyleGuide Class Reference
Inheritance diagram for roslint.pep8.StyleGuide:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args, kwargs)
 
def check_files (self, paths=None)
 
def excluded (self, filename, parent=None)
 
def get_checks (self, argument_name)
 
def ignore_code (self, code)
 
def init_report (self, reporter=None)
 
def input_dir (self, dirname)
 
def input_file (self, filename, lines=None, expected=None, line_offset=0)
 

Public Attributes

 checker_class
 
 options
 
 paths
 
 runner
 

Detailed Description

Initialize a PEP-8 instance with few options.

Definition at line 1775 of file pep8.py.

Constructor & Destructor Documentation

def roslint.pep8.StyleGuide.__init__ (   self,
  args,
  kwargs 
)

Definition at line 1778 of file pep8.py.

Member Function Documentation

def roslint.pep8.StyleGuide.check_files (   self,
  paths = None 
)
Run all checks on the paths.

Definition at line 1820 of file pep8.py.

def roslint.pep8.StyleGuide.excluded (   self,
  filename,
  parent = None 
)
Check if the file should be excluded.

Check if 'options.exclude' contains a pattern that matches filename.

Definition at line 1868 of file pep8.py.

def roslint.pep8.StyleGuide.get_checks (   self,
  argument_name 
)
Get all the checks for this category.

Find all globally visible functions where the first argument name
starts with argument_name and which contain selected tests.

Definition at line 1896 of file pep8.py.

def roslint.pep8.StyleGuide.ignore_code (   self,
  code 
)
Check if the error code should be ignored.

If 'options.select' contains a prefix of the error code,
return False.  Else, if 'options.ignore' contains a prefix of
the error code, return True.

Definition at line 1883 of file pep8.py.

def roslint.pep8.StyleGuide.init_report (   self,
  reporter = None 
)
Initialize the report instance.

Definition at line 1815 of file pep8.py.

def roslint.pep8.StyleGuide.input_dir (   self,
  dirname 
)
Check all files in this directory and all subdirectories.

Definition at line 1846 of file pep8.py.

def roslint.pep8.StyleGuide.input_file (   self,
  filename,
  lines = None,
  expected = None,
  line_offset = 0 
)
Run all checks on a Python source file.

Definition at line 1838 of file pep8.py.

Member Data Documentation

roslint.pep8.StyleGuide.checker_class

Definition at line 1780 of file pep8.py.

roslint.pep8.StyleGuide.options

Definition at line 1795 of file pep8.py.

roslint.pep8.StyleGuide.paths

Definition at line 1787 of file pep8.py.

roslint.pep8.StyleGuide.runner

Definition at line 1794 of file pep8.py.


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


roslint
Author(s): Mike Purvis, Jack O'Quin
autogenerated on Wed May 1 2019 02:23:59