knit_script.knit_script_interpreter.statements.in_direction_statement module

Used to translate lists of knitting instructions in a single carriage pass.

This module provides the In_Direction_Statement class, which handles the execution of multiple needle instructions within a single carriage pass in a specified direction. It coordinates instruction evaluation, carriage pass creation, and proper handling of special operations like split instructions.

class In_Direction_Statement(parser_node, direction, instructions)

Bases: Statement

Statement that sets the machine direction for a set of instructions.

Creates a carriage pass with the specified direction and executes all needle instructions within that pass. Handles special cases like split operations that return second needles and provides proper scope management for direction changes.

This statement is fundamental to knit script execution, as it coordinates multiple needle operations that must be performed together in a single carriage pass. It ensures that all operations are compatible and executed in the correct sequence based on the specified direction.

_direction

Expression that evaluates to the carriage pass direction.

Type:

Expression

_instructions

List of needle instruction expressions to execute.

Type:

list[Needle_Instruction_Exp]

__init__(parser_node, direction, instructions)

Initialize a directional instruction statement.

Parameters:

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

• direction (Expression) – Expression that evaluates to the carriage pass direction for executing the instructions.

• instructions (list[Needle_Instruction_Exp]) – List of needle instruction expressions to execute in the specified direction.

execute(context)

Execute all instructions in the specified direction.

Evaluates the direction, processes all instructions into a carriage pass specification, and executes the pass. Handles special result handling for split operations and stores pass results for potential use by subsequent operations.

Parameters:

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

Raises:

No_Declared_Carrier_Exception – If no working carrier is set when instructions require one for yarn-based operations.

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