Package org.sonar.python.semantic

Class SymbolUtils

java.lang.Object

org.sonar.python.semantic.SymbolUtils

public class SymbolUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static List<Expression>	assignmentsLhs(AssignmentStatement assignmentStatement)
static boolean	canBeAnOverridingMethod(FunctionSymbol functionSymbol)
static int	firstParameterOffset(FunctionSymbol functionSymbol, boolean isStaticCall)
static Set<Symbol>	flattenAmbiguousSymbols(Set<Symbol> symbols)
static String	fullyQualifiedModuleName(String packageName, String fileName)
static Optional<FunctionSymbol>	getFirstAlternativeIfEqualArgumentNames(List<FunctionSymbol> alternatives)
static List<FunctionSymbol>	getFunctionSymbols(Symbol symbol)
static String	getModuleFileName(String fileName)
static Optional<FunctionSymbol>	getOverriddenMethod(FunctionSymbol functionSymbol)
static Optional<FunctionSymbol>	getOverriddenMethod(FunctionSymbol functionSymbol, Function<List<FunctionSymbol>,Optional<FunctionSymbol>> symbolPicker)
static List<FunctionSymbol>	getOverriddenMethods(FunctionSymbol functionSymbol)
static boolean	isEqualArgumentNames(List<FunctionSymbol> alternatives)
static boolean	isPrivateName(String name)
static Path	pathOf(PythonFile pythonFile)
static String	pythonPackageName(File file, String projectBaseDirAbsolutePath)
static Symbol	typeshedSymbolWithFQN(String fullyQualifiedName)

Methods inherited from class java.lang.Object

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

Method Detail

getModuleFileName

public static String getModuleFileName(String fileName)

fullyQualifiedModuleName

public static String fullyQualifiedModuleName(String packageName,
                                              String fileName)

assignmentsLhs

public static List<Expression> assignmentsLhs(AssignmentStatement assignmentStatement)

pythonPackageName

public static String pythonPackageName(File file,
                                       String projectBaseDirAbsolutePath)

pathOf

@CheckForNull
public static Path pathOf(PythonFile pythonFile)

firstParameterOffset

public static int firstParameterOffset(FunctionSymbol functionSymbol,
                                       boolean isStaticCall)

Returns:

the offset between parameter position and argument position: 0 if there is no implicit first parameter (self, cls, etc...) 1 if there is an implicit first parameter -1 if unknown (intent is not clear from context)

getOverriddenMethod

public static Optional<FunctionSymbol> getOverriddenMethod(FunctionSymbol functionSymbol)

getOverriddenMethod

public static Optional<FunctionSymbol> getOverriddenMethod(FunctionSymbol functionSymbol,
                                                           Function<List<FunctionSymbol>,Optional<FunctionSymbol>> symbolPicker)

getOverriddenMethods

public static List<FunctionSymbol> getOverriddenMethods(FunctionSymbol functionSymbol)

getFunctionSymbols

public static List<FunctionSymbol> getFunctionSymbols(@Nullable
                                                      Symbol symbol)

getFirstAlternativeIfEqualArgumentNames

public static Optional<FunctionSymbol> getFirstAlternativeIfEqualArgumentNames(List<FunctionSymbol> alternatives)

isEqualArgumentNames

public static boolean isEqualArgumentNames(List<FunctionSymbol> alternatives)

canBeAnOverridingMethod

public static boolean canBeAnOverridingMethod(@Nullable
                                              FunctionSymbol functionSymbol)

typeshedSymbolWithFQN

public static Symbol typeshedSymbolWithFQN(String fullyQualifiedName)

flattenAmbiguousSymbols

public static Set<Symbol> flattenAmbiguousSymbols(Set<Symbol> symbols)

isPrivateName

public static boolean isPrivateName(String name)