CodeQL library for Python
codeql/python-all 0.6.4 (changelog, source)
Search

Class API::CallNode

A CallCfgNode that is connected to the API graph.

Can be used to reason about calls to an external API in which the correlation between parameters and/or return values must be retained.

The member predicates getParameter, getKeywordParameter, getReturn, and getInstance mimic the corresponding predicates from API::Node. These are guaranteed to exist and be unique to this call.

Import path

import semmle.python.ApiGraphs

Direct supertypes

Indirect supertypes

Known direct subtypes

    Fields

    Inherited fields

    Predicates

    getAParameter

    Gets the API node for a parameter of this invocation.

    getKeywordParameter

    Gets the API node for the keyword parameter name of this invocation.

    getNumArgument

    Gets the number of positional arguments of this call.

    getParameter

    Gets the API node for the ith parameter of this invocation.

    getParameter

    Gets the API node for the parameter that has index i or has keyword name.

    getReturn

    Gets the API node for the return value of this call.

    getSelfParameter

    Gets the object that this method-call is being called on, if this is a method-call

    Inherited predicates

    asCfgNode

    Gets the control-flow node corresponding to this node, if any.

    from CfgNode
    asExpr

    Gets the expression corresponding to this node, if any.

    from Node
    asVar

    Gets the ESSA variable corresponding to this node, if any.

    from Node
    backtrack

    Gets a node that may flow into this one using one heap and/or interprocedural step.

    from LocalSourceNode
    flowsTo

    Holds if this LocalSourceNode can flow to nodeTo in one or more local flow steps.

    from LocalSourceNode
    getACall

    Gets a call to this node.

    from LocalSourceNode
    getALocalSource

    Gets a local source node from which data may flow to this node in zero or more local data-flow steps.

    from Node
    getAMethodCall

    Gets a call to the method methodName on this node.

    from LocalSourceNode
    getAnAttributeRead

    Gets a read of attribute attrName on this node.

    from LocalSourceNode
    getAnAttributeRead

    Gets a read of any attribute on this node.

    from LocalSourceNode
    getAnAttributeReference

    Gets a reference (read or write) of attribute attrName on this node.

    from LocalSourceNode
    getAnAttributeReference

    Gets a reference (read or write) of any attribute on this node.

    from LocalSourceNode
    getAnAttributeWrite

    Gets a write of attribute attrName on this node.

    from LocalSourceNode
    getAnAttributeWrite

    Gets a write of any attribute on this node.

    from LocalSourceNode
    getAnAwaited

    Gets an awaited value from this node.

    from LocalSourceNode
    getArg

    Gets the data-flow node corresponding to the i’th positional argument of the call corresponding to this data-flow node

    from CallCfgNode
    getArgByName

    Gets the data-flow node corresponding to the named argument of the call corresponding to this data-flow node

    from CallCfgNode
    getEnclosingCallable

    Gets the enclosing callable of this node.

    from Node
    getFunction

    Gets the data-flow node for the function component of the call corresponding to this data-flow node.

    from CallCfgNode
    getLocation

    Gets the location of this node

    from CfgNode
    getNode

    Gets the ControlFlowNode represented by this data-flow node.

    from CfgNode
    getScope

    Gets the scope of this node.

    from CfgNode
    getSubscript

    Gets a subscript of this node.

    from LocalSourceNode
    hasLocationInfo

    Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

    from Node
    toString

    Gets a textual representation of this element.

    from CfgNode
    track

    Gets a node that this node may flow to using one heap and/or interprocedural step.

    from LocalSourceNode

    Charpred