Package org.sonar.python.checks

Class CheckUtils

java.lang.Object

org.sonar.python.checks.CheckUtils

public class CheckUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static boolean	areEquivalent(Tree leftTree, Tree rightTree)
static boolean	classHasInheritance(ClassDef classDef)
static boolean	containsCallToLocalsFunction(Tree tree)
static Symbol	findFirstParameterSymbol(FunctionDef functionDef)
static ClassDef	getParentClassDef(Tree tree)
static boolean	isAbstract(FunctionDef funDef)
static boolean	isConstant(Expression condition)
static boolean	isConstantCollectionLiteral(Expression condition)
static boolean	isImmutableConstant(Expression condition)
static boolean	isNone(InferredType type)
static boolean	isSelf(Expression expression)	Simple check whether the given expression is the "self" name expression.
static boolean	mustBeAProtocolLike(ClassDef classDef)	Determines whether the given class must be a Protocol or a similar Protocol-like definition (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

areEquivalent

public static boolean areEquivalent(@Nullable
                                    Tree leftTree,
                                    @Nullable
                                    Tree rightTree)

getParentClassDef

@CheckForNull
public static ClassDef getParentClassDef(Tree tree)

classHasInheritance

public static boolean classHasInheritance(ClassDef classDef)

containsCallToLocalsFunction

public static boolean containsCallToLocalsFunction(Tree tree)

isConstant

public static boolean isConstant(Expression condition)

isImmutableConstant

public static boolean isImmutableConstant(Expression condition)

isConstantCollectionLiteral

public static boolean isConstantCollectionLiteral(Expression condition)

isNone

public static boolean isNone(InferredType type)

mustBeAProtocolLike

public static boolean mustBeAProtocolLike(ClassDef classDef)

Determines whether the given class must be a Protocol or a similar Protocol-like definition (e.g. zope.interface.Interface).

isAbstract

public static boolean isAbstract(FunctionDef funDef)

isSelf

public static boolean isSelf(Expression expression)

Simple check whether the given expression is the "self" name expression. Carefully check the context when relying on this method! This implementation does not ensure that the name is actually referring to a method parameter or whether the surrounding method might be static, etc.

findFirstParameterSymbol

@CheckForNull
public static Symbol findFirstParameterSymbol(FunctionDef functionDef)