Package org.sonar.plugins.python.api.types.v2

Interface PythonType

All Known Subinterfaces:

UnknownType

All Known Implementing Classes:

ClassType, FunctionType, LazyType, LazyUnionType, ModuleType, ObjectType, SpecialFormType, UnionType, UnknownType.UnknownTypeImpl, UnknownType.UnresolvedImportType

@Beta
public interface PythonType

PythonType

Field Summary

Fields

Modifier and Type	Field	Description
static final PythonType	UNKNOWN

Method Summary

Modifier and Type	Method	Description
default Optional<LocationInFile>	definitionLocation()
default Optional<String>	displayName()
default TriBool	hasMember(String memberName)
default Optional<String>	instanceDisplayName()
default boolean	isCompatibleWith(PythonType another)
default String	key()
default String	name()
default Optional<PythonType>	resolveMember(String memberName)	Attempts to resolve a PythonType's member It should return Optional.empty() when the member doesn't exist, and PythonType.UNKNOWN when the member may exist but can't be resolved
default TypeSource	typeSource()
default PythonType	unwrappedType()

Field Details

UNKNOWN

static final PythonType UNKNOWN

Method Details

name

@Beta
default String name()

displayName

@Beta
default Optional<String> displayName()

instanceDisplayName

@Beta
default Optional<String> instanceDisplayName()

isCompatibleWith

@Beta
default boolean isCompatibleWith(PythonType another)

key

@Beta
default String key()

resolveMember

@Beta
default Optional<PythonType> resolveMember(String memberName)

Attempts to resolve a PythonType's member It should return Optional.empty() when the member doesn't exist, and PythonType.UNKNOWN when the member may exist but can't be resolved

hasMember

@Beta
default TriBool hasMember(String memberName)

definitionLocation

@Beta
default Optional<LocationInFile> definitionLocation()

unwrappedType

@Beta
default PythonType unwrappedType()

typeSource

@Beta
default TypeSource typeSource()