org.sonar.plugins.python

Class PythonHighlighter

java.lang.Object

org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

org.sonar.plugins.python.PythonHighlighter

All Implemented Interfaces:

com.sonar.sslr.api.AstAndTokenVisitor, com.sonar.sslr.api.AstVisitor, org.sonar.squidbridge.api.CodeVisitor

public class PythonHighlighter
extends org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>
implements com.sonar.sslr.api.AstAndTokenVisitor

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)

Method Summary

Modifier and Type	Method and Description
void	init()
void	leaveFile(com.sonar.sslr.api.AstNode astNode)
void	visitFile(com.sonar.sslr.api.AstNode astNode)
void	visitNode(com.sonar.sslr.api.AstNode astNode)
void	visitToken(com.sonar.sslr.api.Token token)

Methods inherited from class org.sonar.squidbridge.SquidAstVisitor

destroy, getAstNodeTypesToVisit, getContext, leaveNode, setContext, subscribeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sonar.sslr.api.AstVisitor

getAstNodeTypesToVisit, leaveNode

Constructor Detail

PythonHighlighter

public PythonHighlighter(org.sonar.api.batch.sensor.SensorContext context)

Method Detail

init

public void init()

Overrides:

init in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

visitFile

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

Specified by:

visitFile in interface com.sonar.sslr.api.AstVisitor

Overrides:

visitFile in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

visitNode

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

Specified by:

visitNode in interface com.sonar.sslr.api.AstVisitor

Overrides:

visitNode in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>

visitToken

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

Specified by:

visitToken in interface com.sonar.sslr.api.AstAndTokenVisitor

leaveFile

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

Specified by:

leaveFile in interface com.sonar.sslr.api.AstVisitor

Overrides:

leaveFile in class org.sonar.squidbridge.SquidAstVisitor<com.sonar.sslr.api.Grammar>