Package org.sonar.plugins.python.api

Interface SubscriptionContext

public interface SubscriptionContext

Method Summary

Modifier and Type	Method	Description
PythonCheck.PreciseIssue	addFileIssue(String finalMessage)
PythonCheck.PreciseIssue	addIssue(LocationInFile location, String message)
PythonCheck.PreciseIssue	addIssue(Token token, String message)
PythonCheck.PreciseIssue	addIssue(Token from, Token to, String message)
PythonCheck.PreciseIssue	addIssue(Tree element, String message)
PythonCheck.PreciseIssue	addLineIssue(String message, int lineNumber)
CacheContext	cacheContext()
CallGraph	callGraph()
ProjectConfiguration	projectConfiguration()
PythonFile	pythonFile()
Set<PythonVersionUtils.Version>	sourcePythonVersions()	List of Python versions this project is compatible with.
Collection<Symbol>	stubFilesSymbols()	Returns symbols declared in stub files (e.g. typeshed) used in the analyzed project.
Tree	syntaxNode()
TypeChecker	typeChecker()
File	workingDirectory()	Returns null in case of Sonarlint context

Method Details

syntaxNode

Tree syntaxNode()

addIssue

PythonCheck.PreciseIssue addIssue(Tree element,
 @Nullable
 String message)

addIssue

PythonCheck.PreciseIssue addIssue(LocationInFile location,
 @Nullable
 String message)

addIssue

PythonCheck.PreciseIssue addIssue(Token token,
 @Nullable
 String message)

addIssue

PythonCheck.PreciseIssue addIssue(Token from,
 Token to,
 @Nullable
 String message)

addFileIssue

PythonCheck.PreciseIssue addFileIssue(String finalMessage)

addLineIssue

PythonCheck.PreciseIssue addLineIssue(String message,
 int lineNumber)

pythonFile

PythonFile pythonFile()

sourcePythonVersions

@Beta
Set<PythonVersionUtils.Version> sourcePythonVersions()

List of Python versions this project is compatible with.

stubFilesSymbols

@Beta
Collection<Symbol> stubFilesSymbols()

Returns symbols declared in stub files (e.g. typeshed) used in the analyzed project.

workingDirectory

@CheckForNull
File workingDirectory()

Returns null in case of Sonarlint context

cacheContext

@Beta
CacheContext cacheContext()

typeChecker

TypeChecker typeChecker()

projectConfiguration

ProjectConfiguration projectConfiguration()

callGraph

CallGraph callGraph()