Public Member Functions | Public Attributes | List of all members
roslint.pycodestyle.StyleGuide Class Reference
Inheritance diagram for roslint.pycodestyle.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 2336 of file pycodestyle.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 2339 of file pycodestyle.py.

Member Function Documentation

◆ check_files()

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

Definition at line 2382 of file pycodestyle.py.

◆ excluded()

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

Check if 'options.exclude' contains a pattern matching filename.

Definition at line 2430 of file pycodestyle.py.

◆ get_checks()

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

◆ ignore_code()

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

◆ init_report()

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

Definition at line 2377 of file pycodestyle.py.

◆ input_dir()

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

Definition at line 2408 of file pycodestyle.py.

◆ input_file()

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

Definition at line 2400 of file pycodestyle.py.

Member Data Documentation

◆ checker_class

roslint.pycodestyle.StyleGuide.checker_class

Definition at line 2341 of file pycodestyle.py.

◆ options

roslint.pycodestyle.StyleGuide.options

Definition at line 2357 of file pycodestyle.py.

◆ paths

roslint.pycodestyle.StyleGuide.paths

Definition at line 2349 of file pycodestyle.py.

◆ runner

roslint.pycodestyle.StyleGuide.runner

Definition at line 2356 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