kirin.ir.nodes.stmt.Statement

← Module overview

classStatement¶source

kirin.ir.nodes.stmt.Statement

Bases: IRNode['Block']

The Statement is an instruction in the IR

Signature

class Statement(*, args: Sequence[SSAValue] = (), regions: Sequence[Region] = (), successors: Sequence[Block] = (), attributes: Mapping[str, Attribute] = {}, results: Sequence[ResultValue] = (), result_types: Sequence[TypeAttribute] = (), args_slice: Mapping[str, int | slice] = {}, source: SourceInfo | None = None)

Public import paths

• from kirin.ir import Statement
• from kirin.decl import Statement
• from kirin.ir.ssa import Statement
• from kirin.ir.use import Statement
• from kirin.ir.group import Statement
• from kirin.ir.nodes import Statement
• from kirin.ir.method import Statement
• from kirin.ir.dialect import Statement
• from kirin.rewrite.abc import Statement
• from kirin.interp.frame import Statement
• from kirin.ir.exception import Statement
• from kirin.lowering.abc import Statement
• from kirin.rewrite.walk import Statement
• from kirin.lowering.frame import Statement
• from kirin.lowering.state import Statement
• from kirin.testing.statements import Statement
• from kirin.ir.nodes.base import Statement
• from kirin.ir.nodes.block import Statement
• from kirin.ir.nodes.region import Statement
• from kirin.ir.traits.basic import Statement
• from kirin.ir.traits.symbol import Statement
• from kirin.ir.traits.callable import Statement
• from kirin.lowering.python.binding import Statement
• from kirin.dialects.ilist.rewrite.to_range_loop import Statement

!!! note “Pretty Printing” This object is pretty printable via .print() method.

Parameters

Name	Type	Default	Description
args	Sequence[SSAValue]	()
regions	Sequence[Region]	()
successors	Sequence[Block]	()
attributes	Mapping[str, Attribute]	{}
results	Sequence[ResultValue]	()
result_types	Sequence[TypeAttribute]	()
args_slice	Mapping[str, int | slice]	{}
source	SourceInfo | None	None

Attributes

Name	Type	Default	Description
IS_STATEMENT	bool	True
name	str	required
dialect	Dialect | None	field(default=None, init=False, repr=False)
traits	frozenset[Trait['Statement']]	frozenset()
successors	list[Block]	list(successors)
attributes	dict[str, Attribute]	dict(attributes)
parent	Block | None	None
source	SourceInfo | None	source	The source information of the Statement for debugging/stacktracing.
AttributeType	—	TypeVar('AttributeType', bound=Attribute)
TraitType	—	TypeVar('TraitType', bound=(Trait['Statement']))

propertyparent_stmt¶source

kirin.ir.nodes.stmt.Statement.parent_stmt

parent_stmt: Statement | None

Get the parent statement.

Returns

Statement | NoneThe parent statement.

source

propertyparent_node¶source

kirin.ir.nodes.stmt.Statement.parent_node

parent_node: Block | None

Get the parent node.

Returns

Block | NoneThe parent node.

source

propertyparent_region¶source

kirin.ir.nodes.stmt.Statement.parent_region

parent_region: Region | None

Get the parent Region. Returns: Region | None: The parent Region.

source

propertyparent_block¶source

kirin.ir.nodes.stmt.Statement.parent_block

parent_block: Block | None

Get the parent Block.

Returns

Block | NoneThe parent Block.

source

propertynext_stmt¶source

kirin.ir.nodes.stmt.Statement.next_stmt

next_stmt: Statement | None

Get the next statement.

source

propertyprev_stmt¶source

kirin.ir.nodes.stmt.Statement.prev_stmt

prev_stmt: Statement | None

Get the previous statement.

source

methodinsert_after¶source

kirin.ir.nodes.stmt.Statement.insert_after

def insert_after(stmt: Statement) -> None

Insert the current Statement after the input Statement.

Parameters

Name	Type	Description
stmt	Statement	Input Statement.

Example

The following example demonstrates how to insert a Statement after another Statement. After insert_after is called, stmt1 will be inserted after stmt2, which appears in IR in the order (stmt2 -> stmt1)

stmt1 = Statement()
stmt2 = Statement()
stmt1.insert_after(stmt2)

source

methodinsert_before¶source

kirin.ir.nodes.stmt.Statement.insert_before

def insert_before(stmt: Statement) -> None

Insert the current Statement before the input Statement.

Parameters

Name	Type	Description
stmt	Statement	Input Statement.

Example

The following example demonstrates how to insert a Statement before another Statement. After insert_before is called, stmt1 will be inserted before stmt2, which appears in IR in the order (stmt1 -> stmt2)

stmt1 = Statement()
stmt2 = Statement()
stmt1.insert_before(stmt2)

source

methodreplace_by¶source

kirin.ir.nodes.stmt.Statement.replace_by

def replace_by(stmt: Statement) -> None

Replace the current Statement by the input Statement.

Parameters

Name	Type	Description
stmt	Statement	Input Statement.

source

propertyargs¶source

kirin.ir.nodes.stmt.Statement.args

args: ArgumentList

Get the arguments of the Statement.

Returns

ArgumentListArgumentList: The arguments View of the Statement.

source

propertyresults¶source

kirin.ir.nodes.stmt.Statement.results

results: ResultList

Get the result values of the Statement.

Returns

ResultListResultList: The result values View of the Statement.

source

propertyregions¶source

kirin.ir.nodes.stmt.Statement.regions

regions: list[Region]

Get a list of regions of the Statement.

Returns

list[Region]The list of regions of the Statement.

source

methoddrop_all_references¶source

kirin.ir.nodes.stmt.Statement.drop_all_references

def drop_all_references() -> None

Remove all the dependency that reference/uses this Statement.

source

methoddelete¶source

kirin.ir.nodes.stmt.Statement.delete

def delete(safe: bool = True) -> None

Delete the Statement completely from the IR graph.

Parameters

Name	Type	Default	Description
safe	bool	True	If True, raise error if there is anything that still reference components in the Statement. Defaults to True.

Note

This method will detach + remove references of the Statement.

source

methoddetach¶source

kirin.ir.nodes.stmt.Statement.detach

def detach() -> None

detach the statement from its parent block.

source

methodfrom_stmt¶source

kirin.ir.nodes.stmt.Statement.from_stmt

Signature

def from_stmt(other: Statement, args: Sequence[SSAValue] | None = None, regions: list[Region] | None = None, successors: list[Block] | None = None, attributes: dict[str, Attribute] | None = None) -> Self

Create a similar Statement with new ResultValue and without attaching to any parent block. This still references to the old successor and regions.

Parameters

Name	Type	Default	Description
other	Statement	required
args	Sequence[SSAValue] | None	None
regions	list[Region] | None	None
successors	list[Block] | None	None
attributes	dict[str, Attribute] | None	None

Returns

Self

source

methodwalk¶source

kirin.ir.nodes.stmt.Statement.walk

Signature

def walk(*, reverse: bool = False, region_first: bool = False, include_self: bool = True) -> Iterator[Statement]

Traversal the Statements of Regions.

Parameters

Name	Type	Default	Description
reverse	bool	False	If walk in the reversed manner. Defaults to False.
region_first	bool	False	If the walk should go through the Statement first or the Region of a Statement first. Defaults to False.
include_self	bool	True	If the walk should include the Statement itself. Defaults to True.

Returns

Iterator[Statement]

Yields

Statement — Iterator[Statement]: An iterator that yield Statements of Blocks in the Region, in the specified order.

source

methodis_structurally_equal¶source

kirin.ir.nodes.stmt.Statement.is_structurally_equal

Signature

def is_structurally_equal(other: IRNode, context: dict[IRNode | SSAValue, IRNode | SSAValue] | None = None) -> bool

Check if the Statement is structurally equal to another Statement.

Parameters

Name	Type	Default	Description
other	IRNode	required	The other node to compare with.
context	dict[IRNode | SSAValue, IRNode | SSAValue] | None	None	A map of IRNode/SSAValue to hint that they are equivalent so the check will treat them as equivalent. Defaults to None.

Returns

boolbool: True if the IRNode is structurally equal to the other.

source

methodprint_impl¶source

kirin.ir.nodes.stmt.Statement.print_impl

def print_impl(printer: Printer) -> None

Parameters

Name	Type	Description
printer	Printer

source

methodget_attribute¶source

kirin.ir.nodes.stmt.Statement.get_attribute

Signature

def get_attribute(key: str, default: Attribute | None = None) -> Attribute | None

Get the attribute or property of the Statement.

Parameters

Name	Type	Default	Description
key	str	required	The key of the attribute or property.
default	Attribute | None	None

Returns

Attribute | NoneThe attribute or property of the Statement.

source

methodget_attribute_casted¶source

kirin.ir.nodes.stmt.Statement.get_attribute_casted

Signature

def get_attribute_casted(key: str, expect: type[AttributeType], default: AttributeType | None = None) -> AttributeType | None

Get the attribute or property of the Statement.

Parameters

Name	Type	Default	Description
key	str	required	The key of the attribute or property.
expect	type[AttributeType]	required	The expected type of the attribute.
default	AttributeType | None	None	The default value to return if the attribute is not found. Defaults to None.

Returns

AttributeType | NoneAttributeType: The attribute or property of the Statement.

source

methodget_attribute_typed¶source

kirin.ir.nodes.stmt.Statement.get_attribute_typed

Signature

def get_attribute_typed(key: str, expect: type[AttributeType], default: AttributeType | None = None) -> AttributeType | None

Get the attribute or property of the Statement.

Parameters

Name	Type	Default	Description
key	str	required	The key of the attribute or property.
expect	type[AttributeType]	required	The expected type of the attribute.
default	AttributeType | None	None	The default value to return if the attribute is not found. Defaults to None.

Returns

AttributeType | NoneAttributeType: The attribute or property of the Statement.

source

methodhas_trait¶source

kirin.ir.nodes.stmt.Statement.has_trait

def has_trait(trait_type: type[Trait['Statement']]) -> bool

Check if the Statement has a specific trait.

Parameters

Name	Type	Description
trait_type	type[Trait['Statement']]	The type of trait to check for.

Returns

boolbool: True if the class has the specified trait, False otherwise.

source

methodget_trait¶source

kirin.ir.nodes.stmt.Statement.get_trait

def get_trait(trait: type[TraitType]) -> TraitType | None

Get the trait of the Statement.

Parameters

Name	Type	Description
trait	type[TraitType]

Returns

TraitType | None

source

methodget_present_trait¶source

kirin.ir.nodes.stmt.Statement.get_present_trait

def get_present_trait(trait: type[TraitType]) -> TraitType

Just like get_trait, but expects the trait to be there. Useful for linter checks, when you know the trait is present.

Parameters

Name	Type	Description
trait	type[TraitType]

Returns

TraitType

source

methodexpect_one_result¶source

kirin.ir.nodes.stmt.Statement.expect_one_result

def expect_one_result() -> ResultValue

Check if the statement contain only one result, and return it

Returns

ResultValue

source

methodcheck_type¶source

kirin.ir.nodes.stmt.Statement.check_type

def check_type() -> None

Check the types of the Block. Raises Exception if the types are not correct. This method is called by the verify_type method, which will detect the source of the error in the IR. One should always call the verify_type method to verify the types of the IR.

Note

This method is generated by the @statement decorator. But can be overridden if needed.

source

methodcheck¶source

kirin.ir.nodes.stmt.Statement.check

def check() -> None

Check the statement. Raises Exception if the statement is not correct. This method is called by the verify method, which will detect the source of the error in the IR. One should always call the verify method to verify the IR.

The difference between check and check_type is that check is called at any time to check the structure of the IR by verify, while check_type is called after the type inference to check the types of the IR.

source

methodverify¶source

kirin.ir.nodes.stmt.Statement.verify

def verify() -> None

source

methodverify_type¶source

kirin.ir.nodes.stmt.Statement.verify_type

def verify_type() -> None

Verify the type of the statement.

Note

This API should be called after all the types are figured out (by typeinfer)

source