knit_script.knit_script_interpreter.statements.Push_Statement module

Statements that change the layer position of needles.

This module provides the Push_Statement class, which handles layer position modifications for needles in multi-sheet gauge configurations. It allows control over the stacking hierarchy of stitches, enabling complex knitting patterns that require specific layer arrangements.

class Push_Statement(parser_node, needles, push_val)

Bases: Statement

Pushes needles to specified layer positions in the stacking hierarchy.

This statement modifies the layering order of stitches on needles, allowing control over which stitches appear in front or back of others in the final knitted fabric. Supports absolute positioning to specific layers, relative movement by distance, and convenient front/back positioning.

The push operation is essential for complex multi-sheet knitting where the layer ordering affects the final fabric structure and appearance. After modifying layer positions, the statement automatically resets to the current sheet to ensure the changes are properly applied.

_needles

List of expressions that evaluate to needles whose layers should be repositioned.

Type:

list[Expression]

_push_val

The positioning instruction specification.

Type:

str | Expression | tuple[Expression, str]

__init__(parser_node, needles, push_val)

Initialize a push statement.

Parameters:

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

• needles (list[Expression]) – List of expressions that evaluate to needles whose layers should be repositioned.

• push_val (str | Expression | tuple[Expression, str]) – The positioning instruction, which can be a string for absolute positioning (“front” or “back”),

• integer (an Expression for absolute layer position as)

• of (or a tuple)

execute(context)

Execute the push operation on the specified needles.

Evaluates all needle expressions and applies the positioning operation to each needle’s layer in the gauged sheet record. Supports absolute positioning, relative movement, and convenient front/back shortcuts. After all modifications, resets to the current sheet to apply changes.

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