knit_script.knit_script_interpreter.expressions.formatted_string module

Produces formatted strings.

This module provides the Formatted_String_Value class, which implements formatted string expressions following Python f-string conventions. It handles the evaluation and concatenation of mixed string literals and expressions within formatted string contexts.

class Formatted_String_Value(parser_node, expressions)

Bases: Expression

Follows python fstring conventions.

The Formatted_String_Value class implements formatted string expressions that mirror Python’s f-string functionality. It takes a list of expressions that represent the components of a formatted string (both literal string parts and embedded expressions) and evaluates them in sequence to produce a concatenated result.

This allows knit script programs to use dynamic string formatting similar to Python f-strings,

where expressions can be embedded within string literals and evaluated at runtime to produce formatted output.

expressions

List of expressions in order for string formatting, including both string literals and embedded expressions.

Type:

list[Expression]

__init__(parser_node, expressions)

Initialize the Formatted_String_Value.

Parameters:

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

• expressions (list[Expression]) – List of expressions in order for string formatting, representing the components of the formatted string.

evaluate(context)

Evaluate the expression to produce a formatted string.

Evaluates each component expression in sequence and concatenates their string representations to produce the final formatted string result.

Parameters:

context (Knit_Script_Context) – The current context of the knit_script_interpreter.

Returns:

The concatenated result of evaluating all component expressions and converting them to strings.

Return type:

str

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 evaluate methods in subclasses with appropriate error handling decorator.

This method is called whenever a class inherits from Expression. It checks if the subclass defines its own evaluate method and wraps it with the appropriate decorator.

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