PythonImportResolverPass

io.joern.pysrc2cpg.PythonImportResolverPass
class PythonImportResolverPass(cpg: Cpg) extends XImportResolverPass

Attempts to solve imports similar Python, and will use heuristics to build out unresolved imports.

Attributes

See also
Graph
Supertypes
class XImportResolverPass
class ConcurrentWriterCpgPass[Import]
class NewStyleCpgPassBase[Import]
trait CpgPassBase
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

type DiffGraphBuilder = DiffGraphBuilder

Attributes

Inherited from:
NewStyleCpgPassBase

Value members

Concrete methods

override def init(): Unit

Attributes

Definition Classes
NewStyleCpgPassBase
override protected def optionalResolveImport(fileName: String, importCall: Call, importedEntity: String, importedAs: String, diffGraph: DiffGraphBuilder): Unit

Attributes

Definition Classes
XImportResolverPass

Inherited methods

override def createAndApply(): Unit

Attributes

Definition Classes
NewStyleCpgPassBase -> CpgPassBase
Inherited from:
NewStyleCpgPassBase
override def createApplySerializeAndStore(serializedCpg: SerializedCpg, inverse: Boolean, prefix: String): Unit

WARNING: runOnPart is executed in parallel to committing of graph modifications. The upshot is that it is unsafe to read ANY data from cpg, on pain of bad race conditions

WARNING: runOnPart is executed in parallel to committing of graph modifications. The upshot is that it is unsafe to read ANY data from cpg, on pain of bad race conditions

Only use ConcurrentWriterCpgPass if you are very sure that you avoid races.

E.g. adding a CFG edge to node X races with reading an AST edge of node X.

Attributes

Definition Classes
ConcurrentWriterCpgPass -> CpgPassBase
Inherited from:
ConcurrentWriterCpgPass
protected def evaluatedImportToTag(x: EvaluatedImport, importCall: Call, diffGraph: DiffGraphBuilder): Unit

Attributes

Inherited from:
XImportResolverPass
def finish(): Unit

Attributes

Inherited from:
NewStyleCpgPassBase
override def generateParts(): Array[Import]

Attributes

Definition Classes
XImportResolverPass -> NewStyleCpgPassBase
Inherited from:
XImportResolverPass
def isParallel: Boolean

Attributes

Inherited from:
NewStyleCpgPassBase
def name: String

Name of the pass. By default it is inferred from the name of the class, override if needed.

Name of the pass. By default it is inferred from the name of the class, override if needed.

Attributes

Inherited from:
CpgPassBase
override def runOnPart(builder: DiffGraphBuilder, part: Import): Unit

Attributes

Definition Classes
XImportResolverPass -> NewStyleCpgPassBase
Inherited from:
XImportResolverPass
override def runWithBuilder(externalBuilder: DiffGraphBuilder): Int

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Attributes

Definition Classes
NewStyleCpgPassBase -> CpgPassBase
Inherited from:
NewStyleCpgPassBase
def runWithBuilderLogged(builder: DiffGraphBuilder): Int

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Attributes

Inherited from:
CpgPassBase

Inherited fields

protected val codeRootDir: String

Attributes

Inherited from:
XImportResolverPass
protected val logger: Logger

Attributes

Inherited from:
XImportResolverPass
var nDiffT: Int

Attributes

Inherited from:
ConcurrentWriterCpgPass