knit_script.knit_script_interpreter.statements.code_block_statements module

Manages blocks of code executed in a new scope.

This module provides the Code_Block statement class, which handles the execution of multiple statements within a new variable scope. It manages scope creation, statement execution, and proper handling of return values and scope cleanup.

class Code_Block(parser_node, statements)[source]

Bases: Scoped_Statement

Used for executing any block of code in a new scope.

Creates a new variable scope, executes all statements in order, then restores the previous scope. Handles return statements properly by preserving return values across scope boundaries.

This class is fundamental to knit script’s scoping system, providing isolation for variables while allowing controlled inheritance of changes.

The code block ensures that variables defined within the block don’t interfere with the outer scope unless explicitly designed to do so.

It supports early termination through return statements and properly propagates return values to the appropriate scope level.

__init__(parser_node, statements)[source]

Initialize a code block.

Parameters:
  • parser_node (LRStackNode) – The parser node from the abstract syntax tree.

  • statements (list[Statement]) – Ordered list of statements to execute within the new scope.

classmethod __class_getitem__(params)

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo(Generic[T]): ….

classmethod __init_subclass__(**kwargs)

Automatically wrap execute methods in subclasses with appropriate error handling and debugging decorators.

This method is called whenever a class inherits from Statement. It checks if the subclass defines its own execute method and wraps it with the appropriate decorators

Parameters:

**kwargs (Any) – Additional keyword arguments passed to super().__init_subclass__

execute(context)

Execute any pre-scope actions and then executing the sub-scoped statement(s) within a new scope. If any statement triggers a return, execution stops early and the return value is preserved.

Parameters:

context (Knit_Script_Context) – The current execution context of the knit script interpreter.

property file_name: str | None

Returns: str | None: The file name of the knitscript program this was parsed from or None if the program was passed as a string.

property line_number: int

Get the line number of the symbol that generated this statement.

Returns:

The line number where this element appears in the source file.

Return type:

int

property local_path: str | None

Returns: str | None: The path to the directory containing the file from which this element was parsed or None if the value was parsed from a python string.

property location: Location

Get the location of this symbol in KnitScript file.

Returns:

The location of this symbol in the source file, including file name, line number, and position information.

Return type:

Location

property location_str: str

Returns: str: The string referencing the line number and possible file name information about this element.

property position_context: str

The position context string is the string from the knitscript program from which this element was parsed. The context string will begin at the start of this element and continue to the end of the line of knitscript or a semicolon on new line are reached.

Returns:

The string used to contextualize this element in the knitscript program.

Return type:

str

pre_scope_action(context)

An action taken before execution of the subscope statement (e.g., assigning local variables).

This method should be overridden by subclasses that take actions before executing the sub-scoped statement(s).

Parameters:

context (Knit_Script_Context) – The current execution context of the knit script interpreter.

Returns:

True if the statements should follow execution of the pre-amble, False otherwise.

Return type:

bool