org.sonar.plugins.python

Class PythonHighlighter

java.lang.Object

org.sonar.python.PythonVisitor

org.sonar.plugins.python.PythonHighlighter

public class PythonHighlighter
extends PythonVisitor

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 and Description
PythonHighlighter(org.sonar.api.batch.sensor.SensorContext context, org.sonar.api.batch.fs.InputFile inputFile)

Method Summary

Modifier and Type	Method and Description
void	leaveFile(com.sonar.sslr.api.AstNode astNode)
Set<com.sonar.sslr.api.AstNodeType>	subscribedKinds()
void	visitNode(com.sonar.sslr.api.AstNode astNode)
void	visitToken(com.sonar.sslr.api.Token token)

Methods inherited from class org.sonar.python.PythonVisitor

getContext, leaveNode, scanFile, scanNode, visitFile

Methods inherited from class java.lang.Object

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

Constructor Detail

PythonHighlighter

public PythonHighlighter(org.sonar.api.batch.sensor.SensorContext context,
                         org.sonar.api.batch.fs.InputFile inputFile)

Method Detail

subscribedKinds

public Set<com.sonar.sslr.api.AstNodeType> subscribedKinds()

Overrides:

subscribedKinds in class PythonVisitor

visitNode

public void visitNode(com.sonar.sslr.api.AstNode astNode)

Overrides:

visitNode in class PythonVisitor

visitToken

public void visitToken(com.sonar.sslr.api.Token token)

Overrides:

visitToken in class PythonVisitor

leaveFile

public void leaveFile(@Nullable
                      com.sonar.sslr.api.AstNode astNode)

Overrides:

leaveFile in class PythonVisitor