CPython.Types.Function

Documentation

data Function

Instances

Concrete Function

Methods

concreteType :: Function -> Type

Object Function

Methods

toObject :: Function -> SomeObject

fromForeignPtr :: ForeignPtr Function -> Function

functionType :: Type

new :: Code -> Dictionary -> IO Function

Return a new function associated with the given code object. The second parameter will be used as the globals accessible to the function.

The function's docstring, name, and module are retrieved from the code object. The parameter defaults and closure are set to Nothing.

getCode :: Function -> IO Code

Return the code object associated with a function.

getGlobals :: Function -> IO Dictionary

Return the globals dictionary associated with a function.

getModule :: Function -> IO SomeObject

Return the module attribute of a function. This is normally a Unicode containing the module name, but can be set to any other object by Python code.

getDefaults :: Function -> IO (Maybe Tuple)

Return the default parameter values for a function. This can be a tuple or Nothing.

setDefaults :: Function -> Maybe Tuple -> IO ()

Set the default values for a function.

getClosure :: Function -> IO (Maybe Tuple)

Return the closure associated with a function. This can be Nothing, or a tuple of Cells.

setClosure :: Function -> Maybe Tuple -> IO ()

Set the closure associated with a function. The tuple should contain Cells.

getAnnotations :: Function -> IO (Maybe Dictionary)

Return the annotations for a function. This can be a mutable dictionary, or Nothing.

setAnnotations :: Function -> Maybe Dictionary -> IO ()

Set the annotations for a function object.