Package org.sonar.plugins.python

Class PythonHighlighter

java.lang.Object

org.sonar.plugins.python.PythonHighlighter

public class PythonHighlighter
extends Object

Colors Python code. Currently colors:

• String literals. Examples:

         "hello"
  
         'hello'
  
         """ hello
             hello again
         """
       

• Keywords. Example:

         def
       

• Numbers. Example:

          123
          123L
          123.45
          123.45e-10
          123+88.99J
       

  For a negative number, the "minus" sign is not colored.
• Comments. Example:

          # some comment
       

Docstrings are handled (i.e., colored) as structured comments, not as normal string literals. "Attribute docstrings" and "additional docstrings" (see PEP 258) are handled as normal string literals. Reminder: a docstring is a string literal that occurs as the first statement in a module, function, class, or method definition.

Constructor Summary

Constructors

Constructor	Description
PythonHighlighter()
PythonHighlighter(Lock lock)

Method Summary

Modifier and Type	Method	Description
void	highlight(org.sonar.api.batch.sensor.SensorContext sensorContext, PythonVisitorContext visitorContext, PythonInputFile inputFile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PythonHighlighter

public PythonHighlighter(Lock lock)

PythonHighlighter

public PythonHighlighter()

Method Details

highlight

public void highlight(org.sonar.api.batch.sensor.SensorContext sensorContext,
 PythonVisitorContext visitorContext,
 PythonInputFile inputFile)