Package org.sonar.python.metrics

Class FileLinesVisitor

java.lang.Object

org.sonar.plugins.python.api.PythonSubscriptionCheck

org.sonar.python.metrics.FileLinesVisitor

All Implemented Interfaces:

PythonCheck, PythonFileConsumer, SubscriptionCheck

public class FileLinesVisitor
extends PythonSubscriptionCheck

Visitor that computes CoreMetrics.NCLOC_DATA_KEY and CoreMetrics.COMMENT_LINES metrics used by the DevCockpit.

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.python.api.PythonCheck

PythonCheck.CheckScope, PythonCheck.PreciseIssue

Nested classes/interfaces inherited from interface org.sonar.plugins.python.api.SubscriptionCheck

SubscriptionCheck.Context

Constructor Summary

Constructors

Constructor	Description
FileLinesVisitor()
FileLinesVisitor(boolean isNotebook)

Method Summary

Modifier and Type	Method	Description
static boolean	containsNoSonarComment(Trivia trivia)
static Set<Integer>	countDocstringLines(StringLiteral docstring)
int	getClassDefs()
int	getCommentLineCount()
Set<Integer>	getExecutableLines()
Set<Integer>	getLinesOfCode()
Set<Integer>	getLinesWithNoSonar()
int	getStatements()
protected void	handleDocString(StringLiteral docstring)
void	initialize(SubscriptionCheck.Context context)
void	leaveFile()
void	scanFile(PythonVisitorContext visitorContext)
static Set<Integer>	tokenLineNumbers(Token token)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.python.api.PythonCheck

scope

Methods inherited from interface org.sonar.plugins.python.api.PythonFileConsumer

scanWithoutParsing

Constructor Details

FileLinesVisitor

public FileLinesVisitor(boolean isNotebook)

FileLinesVisitor

public FileLinesVisitor()

Method Details

scanFile

public void scanFile(PythonVisitorContext visitorContext)

Specified by:

scanFile in interface PythonFileConsumer

Overrides:

scanFile in class PythonSubscriptionCheck

initialize

public void initialize(SubscriptionCheck.Context context)

handleDocString

protected void handleDocString(@Nullable
 StringLiteral docstring)

countDocstringLines

public static Set<Integer> countDocstringLines(@Nullable
 StringLiteral docstring)

tokenLineNumbers

public static Set<Integer> tokenLineNumbers(Token token)

containsNoSonarComment

public static boolean containsNoSonarComment(Trivia trivia)

leaveFile

public void leaveFile()

Overrides:

leaveFile in class PythonSubscriptionCheck

getLinesWithNoSonar

public Set<Integer> getLinesWithNoSonar()

getLinesOfCode

public Set<Integer> getLinesOfCode()

getCommentLineCount

public int getCommentLineCount()

getExecutableLines

public Set<Integer> getExecutableLines()

getStatements

public int getStatements()

getClassDefs

public int getClassDefs()