knit_script.knit_script_interpreter.statements.instruction_statements module

Statements that produce knitout for machine level instructions.

This module provides statement classes for machine-level operations that generate specific knitout instructions. It includes statements for pausing machine execution and other machine control operations that operate at the machine level rather than on specific needles.

class Pause_Statement(parser_node)

Bases: Statement

An instruction that pauses the knitting machine.

Generates a pause instruction in the knitout, causing the machine to stop execution until manually resumed. This is useful for manual interventions, inspection points, or when operator input is required during the knitting process.

The pause statement provides a way to create breakpoints in the knitting process where the machine will halt and wait for operator intervention before continuing with the remaining instructions.

__init__(parser_node)

Initialize a pause statement.

Parameters:

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

execute(context)

Execute the pause by writing a pause instruction to knitout.

Generates a pause instruction and adds it to the knitout output, which will cause the knitting machine to halt execution at this point.

Parameters:

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

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__

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