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

Class PyFunctionObject

Import path

import python

Direct supertypes

Indirect supertypes

Predicates

descriptiveString

Gets a longer, more descriptive version of toString()

getARaisedType

Gets a class that may be raised by this function

getAReturnedNode

Gets a control flow node corresponding to the value of a return statement

getAnInferredReturnType

Gets a class that this function may return

getName

Gets the name of this function

getParameter
getQualifiedName

Gets the qualified name for this function object. Should return the same name as the __qualname__ attribute on functions in Python 3.

isProcedure

Whether this function is a procedure, that is, it has no explicit return statement and is not a generator function

maxParameters

Gets the maximum number of parameters that can be correctly passed to this function

minParameters

Gets the minimum number of parameters that can be correctly passed to this function

raisesUnknownType

Whether this function raises an exception, the class of which cannot be inferred

toString

Gets a textual representation of this element.

unconditionallyReturnsParameter

Inherited predicates

asBuiltin

INTERNAL – Do not use

from Object
booleanValue

Gets the Boolean value of this object if it always evaluates to true or false. For example: false for None, true for 7 and no result for int(x)

from Object
getACall

Gets a call-site from where this function is called

from FunctionObject
getACall

Gets a call-site from where this function is called, given the context

from FunctionObject
getACallee

Gets a function that this function (directly) calls

from FunctionObject
getAFunctionCall

Gets a call-site from where this function is called as a function

from FunctionObject
getAMethodCall

Gets a call-site from where this function is called as a method

from FunctionObject
getAnInferredType

Gets an inferred type for this object, without using inter-procedural analysis. WARNING: The lack of context makes this less accurate than f.refersTo(this, result, _) for a control flow node ‘f’

from Object
getArgumentForCall

Gets the ControlFlowNode that will be passed as the nth argument to this when called at call. This predicate will correctly handle x.y(), treating x as the zeroth argument.

from FunctionObject
getFunctionfrom FunctionObject
getNamedArgumentForCall

Gets the ControlFlowNode that will be passed as the named argument to this when called at call. This predicate will correctly handle x.y(), treating x as the self argument.

from FunctionObject
getOrigin

Gets the point in the source code from which this object “originates”.

from Object
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 Object
hasLongName

Holds if this object can be referred to by longName For example, the modules dict in the sys module has the long name sys.modules and the name os.path.join will refer to the path joining function even though it might be declared in the posix or nt modules. Long names can have no more than three dots after the module name.

from Object
isAbstractfrom FunctionObject
isBuiltin

Whether this is a builtin object. A builtin object is one defined by the implementation, such as the integer 4 or by a native extension, such as a NumPy array class.

from Object
isC

Retained for backwards compatibility. See Object.isBuiltin()

from Object
isLegalArgumentName

Whether name is a legal argument name for this function

from FunctionObject
isNormalMethod

Whether this is a “normal” method, that is, it is exists as a class attribute which is not wrapped and not the new method.

from FunctionObject
isOverriddenMethodfrom FunctionObject
isOverridingMethodfrom FunctionObject
maybefrom Object
neverReturns

Whether this function never returns. This is an approximation.

from FunctionObject
notClassfrom Object
overrides

Whether this overrides o. In this context, “overrides” means that this object is a named attribute of a some class C and o is a named attribute of another class S, both attributes having the same name, and S is a super class of C.

from Object
simpleClass

Gets the class of this object for simple cases, namely constants, functions, comprehensions and built-in objects.

from Object
theCallablefrom FunctionObject

Charpred