equip.visitors package

Submodules

equip.visitors.bytecode

Callback the visitor method for each encountered opcode.

copyright:

3. 2014 by Romain Gaucher (@rgaucher)

license:

Apache 2, see LICENSE for more details.

class equip.visitors.bytecode.BytecodeVisitor

Bases: object

A visitor to visit each instruction in the bytecode. For example, the following code:

class CallFunctionVisitor(BytecodeVisitor):
  def __init__(self):
    BytecodeVisitor.__init__(self)

  def visit_call_function(self, oparg):
    print "Function call with %d args" % oparg

Prints whenever a CALL_FUNCTION opcode is visited and prints out its number of arguments (the oparg for this opcode).

static toMethodName(name)

visit(index, op, arg=None, lineno=None, cflow_in=False)

Callback of the visitor. It dynamically constructs the name of the specialized visitor to call based on the name of the opcode.

Parameters:

• index – Bytecode index.
• op – The opcode that is currently visited.
• arg – The expanded oparg (i.e., constants, names, etc. are resolved).
• lineno – The line number associated with the opcode.
• cflow_in – True if the current index is the target of a jump.

visit_binary_add()

visit_binary_and()

visit_binary_divide()

visit_binary_floor_divide()

visit_binary_lshift()

visit_binary_modulo()

visit_binary_multiply()

visit_binary_or()

visit_binary_power()

visit_binary_rshift()

visit_binary_subscr()

visit_binary_subtract()

visit_binary_true_divide()

visit_binary_xor()

visit_break_loop()

visit_build_class()

visit_build_list(oparg)

visit_build_map(oparg)

visit_build_set(oparg)

visit_build_slice(oparg)

visit_build_tuple(oparg)

visit_call_function(oparg)

visit_call_function_kw(oparg)

visit_call_function_var(oparg)

visit_call_function_var_kw(oparg)

visit_compare_op(compare)

visit_continue_loop(jump_abs)

visit_delete_attr(name)

visit_delete_fast(local)

visit_delete_global(name)

visit_delete_name(name)

visit_delete_slice_0()

visit_delete_slice_1()

visit_delete_slice_2()

visit_delete_slice_3()

visit_delete_subscr()

visit_dup_top()

visit_dup_topx(oparg)

visit_end_finally()

visit_exec_stmt()

visit_extended_arg(oparg)

visit_for_iter(jump_rel)

visit_get_iter()

visit_import_from(name)

visit_import_name(name)

visit_import_star()

visit_inplace_add()

visit_inplace_and()

visit_inplace_divide()

visit_inplace_floor_divide()

visit_inplace_lshift()

visit_inplace_modulo()

visit_inplace_multiply()

visit_inplace_or()

visit_inplace_power()

visit_inplace_rshift()

visit_inplace_subtract()

visit_inplace_true_divide()

visit_inplace_xor()

visit_jump_absolute(jump_abs)

visit_jump_forward(jump_rel)

visit_jump_if_false_or_pop(jump_abs)

visit_jump_if_true_or_pop(jump_abs)

visit_list_append(oparg)

visit_load_attr(name)

visit_load_closure(free)

visit_load_const(constant)

visit_load_deref(free)

visit_load_fast(local)

visit_load_global(name)

visit_load_locals()

visit_load_name(name)

visit_make_closure(oparg)

visit_make_function(oparg)

visit_map_add(oparg)

visit_nop()

visit_pop_block()

visit_pop_jump_if_false(jump_abs)

visit_pop_jump_if_true(jump_abs)

visit_pop_top()

visit_print_expr()

visit_print_item()

visit_print_item_to()

visit_print_newline()

visit_print_newline_to()

visit_raise_varargs(oparg)

visit_return_value()

visit_rot_four()

visit_rot_three()

visit_rot_two()

visit_set_add(oparg)

visit_setup_except(jump_rel)

visit_setup_finally(jump_rel)

visit_setup_loop(jump_rel)

visit_setup_with(jump_rel)

visit_slice_0()

visit_slice_1()

visit_slice_2()

visit_slice_3()

visit_stop_code()

visit_store_attr(name)

visit_store_deref(free)

visit_store_fast(local)

visit_store_global(name)

visit_store_map()

visit_store_name(name)

visit_store_slice_0()

visit_store_slice_1()

visit_store_slice_2()

visit_store_slice_3()

visit_store_subscr()

visit_unary_convert()

visit_unary_invert()

visit_unary_negative()

visit_unary_not()

visit_unary_positive()

visit_unpack_sequence(oparg)

visit_with_cleanup()

visit_yield_value()

equip.visitors.classes

Callback the visit method for each encountered class in the program.

copyright:

3. 2014 by Romain Gaucher (@rgaucher)

license:

Apache 2, see LICENSE for more details.

class equip.visitors.classes.ClassVisitor

Bases: object

A class visitor that is triggered for all encountered TypeDeclaration.

Example, listing all types declared in the bytecode:

class TypeDeclVisitor(ClassVisitor):
  def __init__(self):
    ClassVisitor.__init__(self)

  def visit(self, typeDecl):
    print "New type: %s (parentDecl=%s)" \
          % (typeDecl.type_name, typeDecl.parent)

visit(typeDecl)

equip.visitors.methods

Callback the visit method for each encountered method in the program.

copyright:

3. 2014 by Romain Gaucher (@rgaucher)

license:

Apache 2, see LICENSE for more details.

class equip.visitors.methods.MethodVisitor

Bases: object

A method visitor that is triggered for all encountered MethodDeclaration.

Example, listing all methods declared in the bytecode:

class MethodDeclVisitor(MethodVisitor):
  def __init__(self):
    MethodVisitor.__init__(self)

  def visit(self, methDecl):
    print "New method: %s:%d (parentDecl=%s)" \
          % (methDecl.method_name, methDecl.start_lineno, methDecl.parent)

visit(methodDecl)

equip.visitors.modules

Callback the visit method for each encountered module in the program.

copyright:

3. 2014 by Romain Gaucher (@rgaucher)

license:

Apache 2, see LICENSE for more details.

class equip.visitors.modules.ModuleVisitor

Bases: object

visit(moduleDecl)

Module contents

equip.visitors

Different visitor interfaces to traverse the bytecode, modules, classes, or methods.

copyright:

3. 2014 by Romain Gaucher (@rgaucher)

license:

Apache 2, see LICENSE for more details.