Class Function

Metaclass for Falcon function type.

class Function \ from BOM

Summary

attributes()Returns a dictionary containing annotation attributes of the given function.
caller()Gets the direct caller or one of the calling ancestors.
name()Gets the symbolic name of the given function.

Inherited methods

add__ from BOM Overrides binary addition operand.
baseClass from BOM Returns the class item from which an object has been instantiated.
call__ from BOM Overrides call operator "self()".
className from BOM Returns the name of the class an instance is instantiated from.
clone from BOM Performs a deep copy of the item.
compare from BOM Performs a lexicographical comparison.
dec__ from BOM Overrides decrement unary prefix operand.
decpost__ from BOM Overrides decrement unary postfix operand.
derivedFrom from BOM Checks if this item has a given parent.
describe from BOM Returns the deep contents of an item on a string representation.
div__ from BOM Overrides binary division operand.
getIndex__ from BOM Overrides array access operator []
inc__ from BOM Overrides increment unary prefix operand.
incpost__ from BOM Overrides increment unary postifx operand.
isCallable from BOM Determines if an item is callable.
len from BOM Retreives the lenght of a collection
metaclass from BOM Returns the metaclass associated with this item.
mod__ from BOM Overrides modulo operand.
mul__ from BOM Overrides binary multiplication operand.
pow__ from BOM Overrides power operand.
ptr from BOM Returns a raw memory pointer out of this data (as an integer).
serialize from BOM Serialize the item on a stream for persistent storage.
setIndex__ from BOM Overrides array write operator []
sub__ from BOM Overrides binary subtraction operand.
toString from BOM Coverts the object to string.
typeId from BOM Returns an integer indicating the type of this item.

Methods

attributes()

Returns a dictionary containing annotation attributes of the given function.

Function.attributes( )

Returns:Nil if the function has no attributes, or a string-indexed dictionary.

caller()

Gets the direct caller or one of the calling ancestors.

Function.caller( [level] )

levelCaller level (starting from zero, the default).
Returns:The item having performed the nth call.

This function returns the n-th caller (zero based) that caused this function to be called. It may be a function, a method or another callable item from which the call has originated.

Note: The method can also be called statically on the Function metaclass.

name()

Gets the symbolic name of the given function.

Function.name( )

Returns:A string containing the function name

This is useful if the function symbol or has been re-assigned to temporary variables, or if it is applied to the fself keyword.


Made with faldoc 2.1.0