Package org.sonar.python.tree

Class TreeUtils

java.lang.Object

org.sonar.python.tree.TreeUtils

public class TreeUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static RegularArgument	argumentByKeyword(String keyword, List<Argument> arguments)
static String	decoratorNameFromExpression(Expression expression)
static Tree	firstAncestor(Tree tree, Predicate<Tree> predicate)
static Tree	firstAncestorOfKind(Tree tree, Tree.Kind... kinds)
static Stream<Expression>	flattenTuples(Expression expression)
static String	fullyQualifiedNameFromExpression(Expression expression)
static String	fullyQualifiedNameFromQualifiedExpression(QualifiedExpression qualifiedExpression)
static ClassSymbol	getClassSymbolFromDef(ClassDef classDef)
static FunctionSymbol	getFunctionSymbolFromDef(FunctionDef functionDef)
static List<String>	getParentClassesFQN(ClassDef classDef)
static Optional<Symbol>	getSymbolFromTree(Tree tree)
static Token	getTreeSeparatorOrLastToken(Tree tree)	Statements can have a separator like semicolon.
static boolean	hasDescendant(Tree tree, Predicate<Tree> predicate)
static boolean	isBooleanLiteral(Tree tree)
static LocationInFile	locationInFile(Tree tree, String fileId)
static String	nameFromExpression(Expression expression)
static String	nameFromQualifiedExpression(QualifiedExpression qualifiedExpression)
static List<Parameter>	nonTupleParameters(FunctionDef functionDef)
static List<Token>	nonWhitespaceTokens(Tree tree)
static RegularArgument	nthArgumentOrKeyword(int argPosition, String keyword, List<Argument> arguments)
static List<Parameter>	positionalParameters(FunctionDef functionDef)
static List<Token>	tokens(Tree tree)
static List<FunctionDef>	topLevelFunctionDefs(ClassDef classDef)	Collects all top-level function definitions within a class def.

Methods inherited from class java.lang.Object

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

Method Detail

firstAncestor

@CheckForNull
public static Tree firstAncestor(Tree tree,
                                 Predicate<Tree> predicate)

firstAncestorOfKind

@CheckForNull
public static Tree firstAncestorOfKind(Tree tree,
                                       Tree.Kind... kinds)

tokens

public static List<Token> tokens(Tree tree)

nonWhitespaceTokens

public static List<Token> nonWhitespaceTokens(Tree tree)

hasDescendant

public static boolean hasDescendant(Tree tree,
                                    Predicate<Tree> predicate)

flattenTuples

public static Stream<Expression> flattenTuples(Expression expression)

getSymbolFromTree

public static Optional<Symbol> getSymbolFromTree(@Nullable
                                                 Tree tree)

getClassSymbolFromDef

@CheckForNull
public static ClassSymbol getClassSymbolFromDef(@Nullable
                                                ClassDef classDef)

getParentClassesFQN

public static List<String> getParentClassesFQN(ClassDef classDef)

getFunctionSymbolFromDef

@CheckForNull
public static FunctionSymbol getFunctionSymbolFromDef(@Nullable
                                                      FunctionDef functionDef)

nonTupleParameters

public static List<Parameter> nonTupleParameters(FunctionDef functionDef)

positionalParameters

public static List<Parameter> positionalParameters(FunctionDef functionDef)

topLevelFunctionDefs

public static List<FunctionDef> topLevelFunctionDefs(ClassDef classDef)

Collects all top-level function definitions within a class def. It is used to discover methods defined within "strange" constructs, such as class A: if p: def f(self): ...

argumentByKeyword

@CheckForNull
public static RegularArgument argumentByKeyword(String keyword,
                                                List<Argument> arguments)

nthArgumentOrKeyword

@CheckForNull
public static RegularArgument nthArgumentOrKeyword(int argPosition,
                                                   String keyword,
                                                   List<Argument> arguments)

isBooleanLiteral

public static boolean isBooleanLiteral(Tree tree)

nameFromExpression

public static String nameFromExpression(Expression expression)

nameFromQualifiedExpression

public static String nameFromQualifiedExpression(QualifiedExpression qualifiedExpression)

decoratorNameFromExpression

@CheckForNull
public static String decoratorNameFromExpression(Expression expression)

fullyQualifiedNameFromQualifiedExpression

public static String fullyQualifiedNameFromQualifiedExpression(QualifiedExpression qualifiedExpression)

fullyQualifiedNameFromExpression

@CheckForNull
public static String fullyQualifiedNameFromExpression(Expression expression)

locationInFile

@CheckForNull
public static LocationInFile locationInFile(Tree tree,
                                            @Nullable
                                            String fileId)

getTreeSeparatorOrLastToken

public static Token getTreeSeparatorOrLastToken(Tree tree)

Statements can have a separator like semicolon. When handling ranges we want to take them into account.