webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Public Member Functions | List of all members
webkitpy.style.checker.ProcessorBase Class Reference
Inheritance diagram for webkitpy.style.checker.ProcessorBase:
webkitpy.style.checker.StyleProcessor webkitpy.style.filereader_unittest.TextFileReaderTest.MockProcessor

Public Member Functions

def should_process (self, file_path)
 
def process (self, lines, file_path, kwargs)
 

Detailed Description

The base class for processors of lists of lines.

Member Function Documentation

◆ process()

def webkitpy.style.checker.ProcessorBase.process (   self,
  lines,
  file_path,
  kwargs 
)
Process lines of text read from a file.

Args:
  lines: A list of lines of text to process.
  file_path: The path from which the lines were read.
  **kwargs: This argument signifies that the process() method of
    subclasses of ProcessorBase may support additional
    keyword arguments.
        For example, a style checker's check() method
    may support a "reportable_lines" parameter that represents
    the line numbers of the lines for which style errors
    should be reported.

◆ should_process()

def webkitpy.style.checker.ProcessorBase.should_process (   self,
  file_path 
)
Return whether the file at file_path should be processed.

The TextFileReader class calls this method prior to reading in
the lines of a file.  Use this method, for example, to prevent
the style checker from reading binary files into memory.

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