niryo_libraries.genpy.generate

module documentation

Undocumented

Function	`add_pattern`	Record struct pattern that's been used for (de)serialization.
Function	`clear_patterns`	Clear record of struct pattern that have been used for (de)serialization.
Function	`compute_struct_pattern`	Get struct pattern.
Function	`get_patterns`	Get record of struct pattern that have been used for (de)serialization.
Function	`int32_pack`	Pack int32.
Function	`int32_unpack`	Unpack int32.
Function	`pack`	Create struct.pack call for when pattern is a string pattern.
Function	`pack2`	Create struct.pack call for when pattern is the name of a variable.
Function	`reduce_pattern`	Optimize the struct format pattern.
Function	`serialize`	Return code to write expression to buffer.
Function	`unpack`	Create struct.unpack call for when pattern is a string pattern.
Function	`unpack2`	Create struct.unpack call for when pattern refers to variable.
Function	`unpack3`	Create an unpack call on the `struct.Struct` object with the name `struct_var`.
Variable	`_context_patterns`	Undocumented

def add_pattern(p): ¶

Record struct pattern that's been used for (de)serialization.

def clear_patterns(): ¶

Clear record of struct pattern that have been used for (de)serialization.

def compute_struct_pattern(types): ¶

Get struct pattern.

Parameters
types	type names, `[str]`
Returns
format string for struct if types are all simple. Otherwise, return None, `str`

def get_patterns(): ¶

Get record of struct pattern that have been used for (de)serialization.

def int32_pack(var): ¶

Pack int32.

Parameters
var	variable name, `str`
Returns
struct packing code for an int32

def int32_unpack(var, buff): ¶

Unpack int32.

Parameters
var	variable name, `str`
buff	Undocumented
Returns
struct unpacking code for an int32

def pack(pattern, vars_): ¶

Create struct.pack call for when pattern is a string pattern.

def pack2(pattern, vars_): ¶

Create struct.pack call for when pattern is the name of a variable.

Parameters
pattern	name of variable storing string pattern, `struct`
vars_	name of variables to pack, `str`

def reduce_pattern(pattern): ¶

Optimize the struct format pattern.

Parameters
pattern	struct pattern, `str`
Returns
optimized struct pattern, `str`

def serialize(expr): ¶

Return code to write expression to buffer.

Parameters
expr	Undocumented
expr str	string python expression that is evaluated for serialization
Returns
python call to write value returned by expr to serialization buffer

def unpack(var, pattern, buff): ¶

Create struct.unpack call for when pattern is a string pattern.

Parameters
var	name of variable to unpack, `str`
pattern	pattern for pack, `str`
buff	buffer to unpack from, `str`

def unpack2(var, pattern, buff): ¶

Create struct.unpack call for when pattern refers to variable.

Parameters
var	variable the stores the result of unpack call, `str`
pattern	name of variable that unpack will read from, `str`
buff	buffer that the unpack reads from, `StringIO`

def unpack3(var, struct_var, buff): ¶

Create an unpack call on the struct.Struct object with the name struct_var.

Parameters
var	variable the stores the result of unpack call, `str`
struct_var	Undocumented
buff	buffer that the unpack reads from, `StringIO`
str struct_var	name of the struct variable used to unpack `buff`

_context_patterns: list = ¶

Undocumented

niryo_libraries.genpy.generate_struct