pyplusplus.function_transformers package

Overview

This sub-package implements function transformation functionality

pyplusplus.function_transformers.from_address(*args, **keywd)

pyplusplus.function_transformers.inout(*args, **keywd)

pyplusplus.function_transformers.inout_static_array(*args, **keywd)

pyplusplus.function_transformers.inout_static_matrix(*args, **keywd)

pyplusplus.function_transformers.input(*args, **keywd)

pyplusplus.function_transformers.input_c_buffer(*args, **keywd)

pyplusplus.function_transformers.input_static_array(*args, **keywd)

pyplusplus.function_transformers.input_static_matrix(*args, **keywd)

pyplusplus.function_transformers.modify_type(*args, **keywd)

pyplusplus.function_transformers.output(*args, **keywd)

pyplusplus.function_transformers.output_static_array(*args, **keywd)

pyplusplus.function_transformers.output_static_matrix(*args, **keywd)

pyplusplus.function_transformers.transfer_ownership(*args, **keywd)

Modules

controllers

defines controller classes which help to define the function transformation

The idea behind implementation of “Function Transformation” functionality is simple: Py++ defines few templates. Transformers are just editors for the templates. In most cases, transformers don’t directly edit the template, but use controller classes for this purpose. Controller classes provide an abstraction of the templates.

class pyplusplus.function_transformers.controllers.controller_base_t(function)

Bases: object

base class for all controller classes

apply(transformations)

asks all transformations to configure the controller

function

pyplusplus.function_transformers.controllers.create_variables_manager(function)

class pyplusplus.function_transformers.controllers.free_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.sealed_fun_controller_t

apply(transformations)

class pyplusplus.function_transformers.controllers.mem_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.sealed_fun_controller_t

apply(transformations)

inst_arg

class pyplusplus.function_transformers.controllers.pure_virtual_mem_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.virtual_mem_fun_controller_t

class default_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.default_fun_controller_t

template

class pure_virtual_mem_fun_controller_t.override_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.override_fun_controller_t

template

class pyplusplus.function_transformers.controllers.sealed_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.controller_base_t

base class for free and member function controllers

add_post_call_code(code)

add_pre_call_code(code)

arg_expressions

declare_variable(type, name, initialize_expr='')

find_wrapper_arg(name)

modify_arg_expression(index, expression)

post_call

pre_call

register_variable_name(name)

remove_wrapper_arg(name)

result_variable

return_variable(variable_name)

return_variables

template

variables

wrapper_args

wrapper_return_type

class pyplusplus.function_transformers.controllers.variable_t(type, name, initialize_expr='')

Bases: object

defines C++ variable

Parameters:

• type (instance of pygccxml.declarations.type_t) – type of the variable
• name – name( str ) of the variable
• initialize_expr – an expression that initialize the variable

declare_var_string()

initialize_expr

initialize expression

name

variable name

type

variable type

class pyplusplus.function_transformers.controllers.variables_manager_t

Bases: object

function wrapper variables manager

Almost every time we define new transformer, we need to define variables. It is important to keep the variable names unique. This class will ensure this. Every time you declare new variable, it will return the unique variable name. The name will be built from the original variable name and some index, which will make the variable to be unique.

declare_variable(type, name, initialize_expr='')

declare variable

Parameters:

• type (instance of pygccxml.declarations.type_t) – type of the variable
• name – name( str ) of the variable
• initialize_expr – an expression that initialize the variable

Returns:

the variable name, which is unique in a whole scope, based on “name” argument

Return type:

str

register_name(name)

register predefined variable name

There are use cases, where it is convenience to define variables within a template. In such cases, the only thing that should be done is registering a unique name of the variable.

variables

list of all declared variables

class pyplusplus.function_transformers.controllers.virtual_mem_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.controller_base_t

apply(transformations)

default_controller

class default_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.sealed_fun_controller_t

inst_arg

template

virtual_mem_fun_controller_t.override_controller

class virtual_mem_fun_controller_t.override_fun_controller_t(function)

Bases: pyplusplus.function_transformers.controllers.controller_base_t

add_py_post_call_code(code)

add_py_pre_call_code(code)

declare_py_variable(type, name, initialize_expr='')

modify_py_arg_expression(index, expression)

py_arg_expressions

py_function_var

py_post_call

py_pre_call

py_result_variable

py_variables

register_py_variable_name(name)

remove_py_arg(index)

template

function_transformation

defines :class:function_transformation_t class

class pyplusplus.function_transformers.function_transformation.function_transformation_t(function, transformer_creator, **keywd)

the class holds function transformation definition - all transformations that should be applied

alias

controller

required_headers()

thread_safe

transformers

unique_name

templates

defines few templates, which will be used to create a function-wrapper definition.

class pyplusplus.function_transformers.templates.pure_virtual_mem_fun

class pyplusplus.function_transformers.templates.sealed_fun

pyplusplus.function_transformers.templates.substitute(text, **keywd)

class pyplusplus.function_transformers.templates.virtual_mem_fun

transformer

defines :class:transformer_t class

class pyplusplus.function_transformers.transformer.transformer_t(function)

Bases: object

Base class for a function transformer.

Parameter:function – reference to function declaration

configure_free_fun(controller)

transformers should override the method, in order to define custom transformation for free function.

Parameter:controller – instance of free_fun_controller_t class

configure_mem_fun(controller)

Transformers should override the method, in order to define custom transformation for non-virtual member function.

Parameter:controller – instance of mem_fun_controller_t class

configure_virtual_mem_fun(controller)

Transformers should override the method, in order to define custom transformation for virtual member function.

Parameter:controller – instance of virtual_mem_fun_controller_t class

function

reference to the function, for which a wrapper will be generated

get_argument(reference)

returns reference to the desired argument

Parameter:reference – name( str ) or index( int ) of the argument

get_type(reference)

returns type of the desired argument or return type of the function

Parameter:reference – name( str ) or index( int ) of the argument

required_headers()

Returns list of header files that transformer generated code depends on.

transformers

defines few argument transformation classes

class pyplusplus.function_transformers.transformers.from_address_t(function, arg_ref)

Bases: pyplusplus.function_transformers.transformers.type_modifier_t

Handles a single input variable.

Replaces the actual argument type with some integral type, so you could use ctypes package.

void do_something(int** image) -> do_something(unsigned int image_address)

Constructor.

The specified argument must be a reference or a pointer.

Parameter:arg_ref (int) – Index of the argument that is an output value

class pyplusplus.function_transformers.transformers.inout_static_array_t(function, arg_ref, size)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles an input/output array with fixed size.

void do_something(double* v) -> v2 = do_something(object v2)

where v2 is a Python sequence

Constructor.

Parameters:

• arg_ref (int) – Index of the argument that is an input/output array
• size (int) – The fixed size of the input/output array

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.inout_static_matrix_t(function, arg_ref, rows, columns)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles an input/output matrix with fixed size.

transpose_matrix(double m[2][3]) -> m = transpose_matrix(object m) # m must be a sequence of 2 sequences of 3 floats

Constructor.

Parameters:

• arg_ref (int) – Index of the argument that is an input/output matrix
• rows,columns (int) – The fixed size of the input/output matrix

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.inout_t(function, arg_ref)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles a single input/output variable.

void do_something(int& v) -> v = do_something(v)

Constructor.

The specified argument must be a reference or a pointer.

Parameter:arg_ref (int) – Index of the argument that is an in/out value

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.input_c_buffer_t(function, buffer_arg_ref, size_arg_ref)

Bases: pyplusplus.function_transformers.transformer.transformer_t

handles an input of C buffer:

void write( byte *buffer, int size ) -> void write( python sequence )

Constructor.

Parameters:

• buffer_arg_ref – “reference” to the buffer argument
• buffer_arg_ref – “reference” to argument, which holds buffer size

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.input_static_array_t(function, arg_ref, size)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles an input array with fixed size.

void do_something(double* v) -> do_something(object v2)

where v2 is a Python sequence

Constructor.

Parameters:

• arg_ref (int) – Index of the argument that is an input array
• size (int) – The fixed size of the input array

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.input_static_matrix_t(function, arg_ref, rows, columns)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles an input matrix with fixed size.

is_identity(double m[3][3]) -> is_identity(object m) # m must be a sequence of 3 sequences of 3 floats

Constructor.

Parameter:rows, columns (int) – The fixed size of the input matrix

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.input_t(function, arg_ref)

Bases: pyplusplus.function_transformers.transformers.type_modifier_t

Handles a single input variable.

The reference on the specified variable is removed.

void set_value(int& v) -> void set_value(int v)

Parameter:arg_ref (int) – Index of the argument that is an input value

pyplusplus.function_transformers.transformers.is_ptr_or_array(type_)

pyplusplus.function_transformers.transformers.is_ref_or_ptr(type_)

class pyplusplus.function_transformers.transformers.output_static_array_t(function, arg_ref, size)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles an output array of a fixed size.

void get_vec3(double* v) -> v = get_vec3() # v will be a list with 3 floats

Constructor.

Parameters:

• arg_ref (int) – Index of the argument that is an output array
• size (int) – The fixed size of the output array

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.output_static_matrix_t(function, arg_ref, rows, columns)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles an output matrix with fixed size.

get_matrix(double m[3][3]) -> m = get_matrix() # m will be a sequence of 3 sequences of 3 floats

Constructor.

Parameters:

• arg_ref (int) – Index of the argument that is an output matrix
• rows, columns (int) – The fixed size of the output matrix

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.output_t(function, arg_ref)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Handles a single output variable.

The specified variable is removed from the argument list and is turned into a return value.

void get_value(int& v) -> v = get_value()

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

pyplusplus.function_transformers.transformers.remove_ref_or_ptr(type_)

class pyplusplus.function_transformers.transformers.transfer_ownership_t(function, arg_ref)

Bases: pyplusplus.function_transformers.transformers.type_modifier_t

see http://boost.org/libs/python/doc/v2/faq.html#ownership

Constructor.

Parameter:arg_ref (int) – Index of the argument on which to transfer ownership

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

class pyplusplus.function_transformers.transformers.type_modifier_t(function, arg_ref, modifier)

Bases: pyplusplus.function_transformers.transformer.transformer_t

Change/modify type of the argument.

Right now compiler should be able to use implicit conversion

Constructor.

modifier is callable, which take the type of the argument and should return new type

Parameter:arg_ref (int) – Index of the argument which will be transformed

configure_free_fun(controller)

configure_mem_fun(controller)

configure_virtual_mem_fun(controller)

required_headers()

Returns list of header files that transformer generated code depends on.

blog comments powered by Disqus

---