knit_script.knit_script_interpreter.statements.Print module

Print Statements.

This module provides the Print statement class, which handles output operations in knit script programs. It evaluates expressions and outputs their values both to the console for debugging and to the knitout as comments for documentation and traceability.

class Print(parser_node, string)

Bases: Statement

Prints content to Python console and knitout comments.

Evaluates an expression and prints the result both to the Python console (prefixed with “KS:”) and as a comment line in the generated knitout.

This provides both immediate feedback during script execution and documentation in the final knitout file.

The print statement is essential for debugging knit script programs and for adding explanatory comments to the generated knitout that help document the knitting process and make the output more understandable.

_string

The expression to evaluate and print.

Type:

Expression

__init__(parser_node, string)

Initialize a print statement.

Parameters:

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

• string (Expression) – The expression to evaluate and print to both console and knitout.

execute(context)

Execute the print by evaluating and outputting the expression.

Evaluates the string expression, prints it to the console with “KS:” prefix, and adds it as a comment to the knitout with proper line break handling for multi-line content.

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