API Reference

class genpy.Generable

A base class for AST nodes capable of generating code.

__str__() → str

Return a single string (possibly containing newlines) representing this code construct.

abstract generate() → Iterator[str]

Generate (i.e. yield) the lines making up this code construct.

class genpy.Suite(contents: Iterable[Generable] | Generable | None = None)

Bases: Generable

__init__(contents: Iterable[Generable] | Generable | None = None) → None

generate() → Iterator[str]

Generate (i.e. yield) the lines making up this code construct.

append(data: Generable) → None

extend(data: Iterable[Generable]) → None

insert(i: int, data: Generable) → None

extend_log_block(descr: str, data: Iterable[Generable]) → None

class genpy.Collection(contents: Iterable[Generable] | Generable | None = None)

Bases: Suite

Like Suite, but does not lead to indentation.

Block nodes

class genpy.Class(name: str, bases: Iterable[str], attributes: Iterable[Generable])

Bases: Generable

A class definition.

__init__(name: str, bases: Iterable[str], attributes: Iterable[Generable]) → None

class genpy.If(condition: str, then_: Generable, else_: Generable | None = None)

Bases: Generable

An if/then/else block.

__init__(condition: str, then_: Generable, else_: Generable | None = None) → None

class genpy.Loop(body: Generable)

Bases: Generable, ABC

An abstract base class for loops. class for loop blocks.

__init__(body: Generable) → None

abstract intro_line() → str | None

outro_line() → str | None

class genpy.CustomLoop(intro_line: str | None, body: Generable, outro_line: str | None = None)

Bases: Loop

__init__(intro_line: str | None, body: Generable, outro_line: str | None = None) → None

class genpy.While(condition: str, body: Generable)

Bases: Loop

__init__(condition: str, body: Generable)

class genpy.For(vars: str | tuple[str, ...], iterable: str, body: Generable)

Bases: Loop

__init__(vars: str | tuple[str, ...], iterable: str, body: Generable) → None

class genpy.Function(name: str, args: Iterable[str], body: Generable, decorators: Iterable[str] = ())

Bases: Generable

__init__(name: str, args: Iterable[str], body: Generable, decorators: Iterable[str] = ()) → None

genpy.make_multiple_ifs(conditions_and_blocks: Sequence[tuple[str, Generable]], base: Generable | Literal['last'] | None = None) → Generable | None

Single (logical) line Nodes

class genpy.Import(module: str)

Bases: Generable

__init__(module: str) → None

class genpy.ImportAs(module: str, as_: str)

Bases: Generable

__init__(module: str, as_: str) → None

class genpy.FromImport(module: str, names: Iterable[str])

Bases: Generable

__init__(module: str, names: Iterable[str]) → None

class genpy.Statement(text: str)

Bases: Generable

__init__(text: str) → None

class genpy.Assign(lvalue: str, rvalue: str)

Bases: Generable

__init__(lvalue: str, rvalue: str) → None

class genpy.Line(text: str = '')

Bases: Generable

__init__(text: str = '') → None

class genpy.Return(expr: str)

Bases: Generable

__init__(expr: str) → None

class genpy.Raise(expr: str)

Bases: Generable

__init__(expr: str) → None

class genpy.Assert(expr: str)

Bases: Generable

__init__(expr: str) → None

class genpy.Yield(expr: str)

Bases: Generable

__init__(expr: str) → None

class genpy.Pass

Bases: Generable

__init__()

class genpy.Comment(text: str)

Bases: Generable

__init__(text: str) → None