FunctionSymbol (Python :: Frontend 5.5.0.23291 API)

All Superinterfaces:: Symbol

All Known Implementing Classes:: FunctionSymbolImpl

public interface FunctionSymbol extends Symbol

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

FunctionSymbol.Parameter

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

Modifier and Type

Method

Description

String

annotatedReturnTypeName()

Returns fully qualified name of the return type if any

List<String>

decorators()

Returns the known names of the decorators.

LocationInFile

definitionLocation()

boolean

hasDecorators()

boolean

hasVariadicParameter()

boolean

isAsynchronous()

boolean

isInstanceMethod()

boolean

isStub()

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

List<FunctionSymbol.Parameter>

parameters()

Methods inherited from interface org.sonar.plugins.python.api.symbols.Symbol
annotatedTypeName, fullyQualifiedName, is, kind, name, usages

Method Details
- parameters
  
  List<FunctionSymbol.Parameter> parameters()
- isStub
  
  boolean isStub()
  When true, it denotes a function symbol for a function stub.
  def fn(p1, p2): ...
- isAsynchronous
  
  boolean isAsynchronous()
- hasVariadicParameter
  
  boolean hasVariadicParameter()
- isInstanceMethod
  
  boolean isInstanceMethod()
- decorators
  
  List<String> decorators()
  
  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
- hasDecorators
  
  boolean hasDecorators()
- definitionLocation
  
  @CheckForNull LocationInFile definitionLocation()
- annotatedReturnTypeName
  
  @Beta @CheckForNull String annotatedReturnTypeName()
  
  Returns fully qualified name of the return type if any