Working with Michelson code

Expanding macros

class pymavryk.michelson.macros.PxrNode(depth, annots, args, is_root)

annots

Alias for field number 1

args

Alias for field number 2

depth

Alias for field number 0

is_root

Alias for field number 3

pymavryk.michelson.macros.build_pxr_tree(pxr_macro, pxr_annots) → PxrNode

pymavryk.michelson.macros.dip_n(instr, depth=1)

pymavryk.michelson.macros.expand_assert(prim, annots, args) → dict

pymavryk.michelson.macros.expand_assert_cmpx(prim, annots, args) → list

pymavryk.michelson.macros.expand_assert_left(prim, annots, args) → dict

pymavryk.michelson.macros.expand_assert_none(prim, annots, args) → dict

pymavryk.michelson.macros.expand_assert_right(prim, annots, args) → dict

pymavryk.michelson.macros.expand_assert_some(prim, annots, args) → dict

pymavryk.michelson.macros.expand_assert_x(prim, annots, args) → list

pymavryk.michelson.macros.expand_caxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_cdxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_cmpx(prim, annots, args) → list

pymavryk.michelson.macros.expand_cxr(prim, annots) → list

pymavryk.michelson.macros.expand_dixp(prim, annots, args) → dict

pymavryk.michelson.macros.expand_duxp(prim, annots, args) → dict

pymavryk.michelson.macros.expand_fail(prim, annots, args) → list

pymavryk.michelson.macros.expand_if_right(prim, annots, args) → dict

pymavryk.michelson.macros.expand_if_some(prim, annots, args) → dict

pymavryk.michelson.macros.expand_ifcmpx(prim, annots, args) → list

pymavryk.michelson.macros.expand_ifx(prim, annots, args) → list

pymavryk.michelson.macros.expand_macro(prim, annots, args, internal=False)

Expands Michelson macro.

Parameters:

• prim – macro name

• annots – annotations (optional)

• args – arguments (optional)

• internal – this function is called during another macro expansion

Returns:

Code sequence (Micheline expression)

pymavryk.michelson.macros.expand_map_car(prim, annots, args) → list

pymavryk.michelson.macros.expand_map_caxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_map_cdr(prim, annots, args) → list

pymavryk.michelson.macros.expand_map_cdxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_map_cxr(prim, annots, args)

pymavryk.michelson.macros.expand_pxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_set_car(prim, annots, args) → list

pymavryk.michelson.macros.expand_set_caxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_set_cdr(prim, annots, args) → list

pymavryk.michelson.macros.expand_set_cdxr(prim, annots, args) → list

pymavryk.michelson.macros.expand_set_cxr(prim, annots)

pymavryk.michelson.macros.expand_unpxr(prim, annots, args) → list

pymavryk.michelson.macros.expr(**kwargs) → dict

pymavryk.michelson.macros.get_field_annots(annots)

pymavryk.michelson.macros.get_map_cxr_annots(annots) → Tuple[str, list]

pymavryk.michelson.macros.get_var_annots(annots)

pymavryk.michelson.macros.macro(regexp)

pymavryk.michelson.macros.seq(instr=None) → list

pymavryk.michelson.macros.skip_nones(array)

pymavryk.michelson.macros.traverse_pxr_tree(prim, annots, produce)

Parsing AST

class pymavryk.michelson.parse.MichelsonParser(debug=False, write_tables=False, extra_primitives: List[str] | None = None)

Customizable Michelson parser

p_annot(p)

annot : ANNOT

p_annots(p)

annots : annot | empty

p_annots_list(p)

annots : annots annot

p_arg_byte(p)

arg : BYTE

p_arg_group(p)

arg : LEFT_PAREN expr RIGHT_PAREN

p_arg_int(p)

arg : INT

p_arg_prim(p)

arg : PRIM

p_arg_str(p)

arg : STR

p_arg_subseq(p)

arg : LEFT_CURLY instr RIGHT_CURLY

p_args(p)

args : arg | empty

p_args_list(p)

args : args arg

p_empty(p)

empty :

p_error(p)

p_expr(p)

expr : PRIM annots args

p_instr(p)

instr : expr | empty

p_instr_byte(p)

instr : BYTE

p_instr_int(p)

instr : INT

p_instr_list(p)

instr : instr SEMI instr

p_instr_str(p)

instr : STR

p_instr_subseq(p)

instr : LEFT_CURLY instr RIGHT_CURLY

parse(code)

Parse Michelson source.

Parameters:

code – Michelson source

Returns:

Micheline expression

tokens = ('INT', 'BYTE', 'STR', 'ANNOT', 'PRIM', 'LEFT_CURLY', 'RIGHT_CURLY', 'LEFT_PAREN', 'RIGHT_PAREN', 'SEMI')

exception pymavryk.michelson.parse.MichelsonParserError(token: LexToken, message=None)

format_stdout() → str

class pymavryk.michelson.parse.Sequence(iterable=(), /)

class pymavryk.michelson.parse.SimpleMichelsonLexer

t_ANNOT = '[:@%]+([_0-9a-zA-Z\\.]*)?'

t_BYTE = '0x[A-Fa-f0-9]*'

t_INT = '-?[0-9]+'

t_LEFT_CURLY = '\\{'

t_LEFT_PAREN = '\\('

t_PRIM = '[A-Za-z][A-Za-z0-9_]+'

t_RIGHT_CURLY = '\\}'

t_RIGHT_PAREN = '\\)'

t_SEMI = ';'

t_STR = '\\"(\\\\.|[^\\"])*\\"'

t_error(t)

t_ignore = ' \t\r\n\x0c'

t_ignore_COMMENT = '#[^\\n]*'

t_ignore_MULTI_COMMENT = '/\\*[^*]*\\*/'

tokens = ('INT', 'BYTE', 'STR', 'ANNOT', 'PRIM', 'LEFT_CURLY', 'RIGHT_CURLY', 'LEFT_PAREN', 'RIGHT_PAREN', 'SEMI')

pymavryk.michelson.parse.doc(docstring)

pymavryk.michelson.parse.michelson_to_micheline(data, parser=None)

Converts Michelson source text into a Micheline expression.

Parameters:

• data – Michelson string

• parser – custom Michelson parser (optional)

Returns:

Micheline expression

Code formatter

exception pymavryk.michelson.format.MichelsonFormatterError

pymavryk.michelson.format.format_timestamp(timestamp: int) → str

Format unix timestamp.

Parameters:

timestamp – Unix timestamp (seconds)

pymavryk.michelson.format.micheline_to_michelson(data, inline=False, wrap=False) → str

Converts micheline expression into formatted Michelson source.

Parameters:

• data – Micheline expression

• inline – produce single line, used for octez-client arguments (False by default)

• wrap – ensure expression is wrapped in brackets

Parameter section

class pymavryk.michelson.sections.parameter.ParameterSection(item: MichelsonType)

aggregate_lazy_diff(mode='readable') → List[dict]

attach_context(context: AbstractContext)

classmethod create_type(args: List[Type[Micheline] | Any], annots: list | None = None, **kwargs) → Type[ParameterSection]

classmethod execute(stack, stdout: List[str], context: AbstractContext)

classmethod from_micheline_value(val_expr) → ParameterSection

classmethod from_parameters(parameters: Dict[str, Any]) → ParameterSection

classmethod from_python_object(py_obj) → ParameterSection

classmethod generate_pydoc() → str

classmethod list_entrypoints() → Dict[str, Type[MichelsonType]]

static match(type_expr) → Type[ParameterSection]

merge_lazy_diff(lazy_diff: List[dict]) → ParameterSection

prim: str | None = 'parameter'

root_name: str

to_micheline_value(mode='readable', lazy_diff=None)

to_parameters(mode='readable') → Dict[str, Any]

to_python_object(try_unpack=False, lazy_diff=None) → dict

Storage section

class pymavryk.michelson.sections.storage.StorageSection(item: MichelsonType)

aggregate_lazy_diff(mode='readable') → List[dict]

attach_context(context: AbstractContext)

classmethod dummy(context: AbstractContext)

classmethod execute(stack, stdout: List[str], context: AbstractContext)

classmethod from_micheline_value(val_expr) → StorageSection

classmethod from_python_object(py_obj) → StorageSection

classmethod generate_pydoc() → str

static match(type_expr) → Type[StorageSection]

merge_lazy_diff(lazy_diff: List[dict]) → StorageSection

prim: str | None = 'storage'

to_micheline_value(mode='readable', lazy_diff=False)

to_python_object(try_unpack=False, lazy_diff=False)

Code section

class pymavryk.michelson.sections.code.CodeSection

classmethod execute(stack, stdout: List[str], context: AbstractContext)

static match(code_expr) → Type[CodeSection]

prim: str | None = 'code'

Script wrapper

class pymavryk.michelson.program.MichelsonProgram(name: str, parameter: ParameterSection, storage: StorageSection)

Michelson .tz contract interpreter interface

classmethod as_micheline_expr() → List[Dict[str, Any]]

begin(stack: MichelsonStack, stdout: List[str], context: ExecutionContext) → None

Prepare stack for contract execution

code: Type[CodeSection]

static create(sequence: Type[MichelineSequence]) → Type[MichelsonProgram]

Create MichelsonProgram type from micheline

end(stack: MichelsonStack, stdout: List[str], output_mode='readable') → Tuple[List[dict], Any, List[dict], PairType]

Finish contract execution

execute(stack: MichelsonStack, stdout: List[str], context: ExecutionContext) → MichelsonInstruction

Execute contract in interpreter

execute_view(stack: MichelsonStack, stdout: List[str], context: ExecutionContext)

Execute view in interpreter

classmethod get_view(name: str) → Type[ViewSection]

classmethod instantiate(entrypoint: str, parameter, storage) → MichelsonProgram

classmethod instantiate_view(name: str, parameter, storage) → MichelsonProgram

static load(context: ExecutionContext, with_code=False) → Type[MichelsonProgram]

Create MichelsonProgram type from filled context

static match(expr) → Type[MichelsonProgram]

parameter: Type[ParameterSection]

ret(stack: MichelsonStack, stdout: List[str], output_mode='readable') → MichelsonType

storage: Type[StorageSection]

views: List[Type[ViewSection]]

class pymavryk.michelson.program.TztMichelsonProgram

Michelson .tzt contract interpreter interface

classmethod as_micheline_expr() → List[Dict[str, Any]]

begin(stack: MichelsonStack, stdout: List[str], context: ExecutionContext) → None

Prepare stack for contract execution

big_maps: Type[BigMapsSection] | None

code: Type[CodeSection]

static create(sequence: Type[MichelineSequence]) → Type[TztMichelsonProgram]

Create TztMichelsonProgram type from micheline

end(stack: MichelsonStack, stdout: List[str], context: ExecutionContext) → None

Finish contract execution

execute(stack: MichelsonStack, stdout: List[str], context: ExecutionContext) → MichelsonInstruction

Execute contract in interpreter

fill_context(script, context: ExecutionContext) → None

input: Type[InputSection]

classmethod instantiate() → TztMichelsonProgram

static load(context: ExecutionContext, with_code=False)

Create TztMichelsonProgram type from filled context

static match(expr) → Type[TztMichelsonProgram]

output: Type[OutputSection]

register_bigmaps(stack: MichelsonStack, stdout: List[str], context: ExecutionContext) → None