Package org.sonar.python.semantic

Class FunctionSymbolImpl

java.lang.Object

org.sonar.python.semantic.SymbolImpl

org.sonar.python.semantic.FunctionSymbolImpl

All Implemented Interfaces:

FunctionSymbol, Symbol

public class FunctionSymbolImpl
extends SymbolImpl
implements FunctionSymbol

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionSymbolImpl.ParameterImpl

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

FunctionSymbol.Parameter

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

Symbol.Kind

Field Summary

Fields inherited from class org.sonar.python.semantic.SymbolImpl

validForPythonVersions

Constructor Summary

Constructors

Constructor	Description
FunctionSymbolImpl(FunctionDescriptor functionDescriptor, String symbolName)
FunctionSymbolImpl(SymbolsProtos.FunctionSymbol functionSymbolProto, String moduleName)
FunctionSymbolImpl(SymbolsProtos.FunctionSymbol functionSymbolProto, String containerClassFqn, String moduleName)
FunctionSymbolImpl(SymbolsProtos.FunctionSymbol functionSymbolProto, String containerClassFqn, List<String> validFor, String moduleName)

Method Summary

Modifier and Type	Method	Description
void	addParameter(FunctionSymbolImpl.ParameterImpl parameter)
String	annotatedReturnTypeName()	Returns fully qualified name of the return type if any
FunctionSymbolImpl	copyWithoutUsages()
InferredType	declaredReturnType()
List<String>	decorators()	Returns the known names of the decorators.
LocationInFile	definitionLocation()
boolean	hasDecorators()
boolean	hasVariadicParameter()
boolean	isAsynchronous()
boolean	isDjangoView()
boolean	isInstanceMethod()
boolean	isStub()	When true, it denotes a function symbol for a function stub.
Symbol	owner()
List<FunctionSymbol.Parameter>	parameters()
void	setDeclaredReturnType(InferredType declaredReturnType)
void	setIsDjangoView(boolean isDjangoView)
void	setOwner(Symbol owner)
void	setParametersWithType(ParameterList parametersList)

Methods inherited from class org.sonar.python.semantic.SymbolImpl

addChildSymbol, annotatedTypeName, copyWithoutUsages, fullyQualifiedName, getChildrenSymbolByName, inferredType, is, kind, name, removeUsages, setAnnotatedTypeName, setInferredType, setKind, usages, validForPythonVersions

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.symbols.Symbol

annotatedTypeName, fullyQualifiedName, is, kind, name, usages

Constructor Details

FunctionSymbolImpl

public FunctionSymbolImpl(SymbolsProtos.FunctionSymbol functionSymbolProto,
 String moduleName)

FunctionSymbolImpl

public FunctionSymbolImpl(SymbolsProtos.FunctionSymbol functionSymbolProto,
 @Nullable
 String containerClassFqn,
 String moduleName)

FunctionSymbolImpl

public FunctionSymbolImpl(SymbolsProtos.FunctionSymbol functionSymbolProto,
 @Nullable
 String containerClassFqn,
 List<String> validFor,
 String moduleName)

FunctionSymbolImpl

public FunctionSymbolImpl(FunctionDescriptor functionDescriptor,
 String symbolName)

Method Details

setParametersWithType

public void setParametersWithType(ParameterList parametersList)

addParameter

public void addParameter(FunctionSymbolImpl.ParameterImpl parameter)

copyWithoutUsages

public FunctionSymbolImpl copyWithoutUsages()

Overrides:

copyWithoutUsages in class SymbolImpl

decorators

public List<String> decorators()

Description copied from interface: FunctionSymbol

Returns the known names of the decorators. It might not be a reliable way to infer the number of decorators as they can take more complex expressions since Python 3.9

Specified by:

decorators in interface FunctionSymbol

parameters

public List<FunctionSymbol.Parameter> parameters()

Specified by:

parameters in interface FunctionSymbol

isStub

public boolean isStub()

Description copied from interface: FunctionSymbol

When true, it denotes a function symbol for a function stub.

   def fn(p1, p2): ...
 

Specified by:

isStub in interface FunctionSymbol

isAsynchronous

public boolean isAsynchronous()

Specified by:

isAsynchronous in interface FunctionSymbol

hasVariadicParameter

public boolean hasVariadicParameter()

Specified by:

hasVariadicParameter in interface FunctionSymbol

isInstanceMethod

public boolean isInstanceMethod()

Specified by:

isInstanceMethod in interface FunctionSymbol

hasDecorators

public boolean hasDecorators()

Specified by:

hasDecorators in interface FunctionSymbol

definitionLocation

public LocationInFile definitionLocation()

Specified by:

definitionLocation in interface FunctionSymbol

declaredReturnType

public InferredType declaredReturnType()

annotatedReturnTypeName

public String annotatedReturnTypeName()

Description copied from interface: FunctionSymbol

Returns fully qualified name of the return type if any

Specified by:

annotatedReturnTypeName in interface FunctionSymbol

setDeclaredReturnType

public void setDeclaredReturnType(InferredType declaredReturnType)

owner

public Symbol owner()

setOwner

public void setOwner(Symbol owner)

isDjangoView

public boolean isDjangoView()

setIsDjangoView

public void setIsDjangoView(boolean isDjangoView)