Function 

/**
* @brief A function, a normal function def statement or an async function def statement. 
*/

Inherit from Statement

Primary key: element_oid: int

schema Function extends Statement {
  @primary element_oid: int,
  type: string,
  element_index: int,
  parent_oid: int,
  location_oid: int,
  printable_text: string
}

Function::getLocationOid 

/**
* @brief gets the location oid of this element.
* @return int
*/

pub fn getLocationOid(self: Function) -> int;

Function::getEnclosingStatement 

/**
* @brief gets the statement containing this statement.
* @return Statement 
*/

pub fn getEnclosingStatement(self: Function) -> Statement;

Function::getArgumentByIndex 

/**
* @brief gets the arg by index of the function.
* @return Arg 
*/

pub fn getArgumentByIndex(self: Function, i: int) -> Arg;

Function::getQualifiedName 

/**
* @brief gets the qualified name of the function.
* @return string 
*/
  • Parameter self: Function
  • Return string
pub fn getQualifiedName(self: Function) -> string;

Function::getAnAncestor 

/**
* @brief gets an ancestor of the element.
* @return CombineElement 
*/

pub fn getAnAncestor(self: Function) -> *CombineElement;

Function::getAChild 

/**
* @brief gets a child of this statement.
* @return Statement 
*/

pub fn getAChild(self: Function) -> *Statement;

Function::getArguments 

/**
* @brief gets the arguments of the function.
* @return Arguments 
*/

pub fn getArguments(self: Function) -> Arguments;

Function::getPrintableText 

/**
* @brief gets the printable text of this element.
* @return string
*/
  • Parameter self: Function
  • Return string
pub fn getPrintableText(self: Function) -> string;

Function::getLocation 

/**
* @brief gets the location for the element.
* @return Location
*/

pub fn getLocation(self: Function) -> Location;

Function::__all__

Data constraint method.

pub fn __all__(db: PythonDB) -> *Function;

Function::getType 

/**
* @brief gets the type of this element.
* @return string
*/
  • Parameter self: Function
  • Return string
pub fn getType(self: Function) -> string;

Function::getName 

/**
* @brief gets the name of the function.
* @return string 
*/
  • Parameter self: Function
  • Return string
pub fn getName(self: Function) -> string;

Function::getParentOid 

/**
* @brief gets the parent oid of this element.
* @return int
*/

pub fn getParentOid(self: Function) -> int;

Function::getElementIndex 

/**
* @brief gets the element index of this element.
* @return int
*/

pub fn getElementIndex(self: Function) -> int;

Function::getParent 

/**
* @brief gets the parent element of the statement
* @return CombineElement 
*/

pub fn getParent(self: Function) -> CombineElement;

Function::getEnclosingScope 

/**
* @brief gets the immediately enclosing scope (module, function or class) whose body contains this statement.
* @return Scope 
*/

pub fn getEnclosingScope(self: Function) -> Scope;

Function::getSize 

/**
* @brief gets the size information for the element.
* @return NumberOfLines
*/

pub fn getSize(self: Function) -> NumberOfLines;