knitout_interpreter.knitout_language.knitout_actions module

Actions for reducing in Knitout Parser

typed_action(func)[source]

Wrapper that applies @action decorator while preserving types.

Parameters:: func (F) – Function to be decorated with the action decorator.
Returns:: Wrapped function.
Return type:: F

no_op(_, __, value, com)[source]

Extracts the content of a no op comment

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
value (Knitout_Instruction) – The no-op commented instruction.
com (str | None) – Additional comment to the instruction

Returns:

The No-op comment for the given instruction.

Return type:

Knitout_Comment_Line

break_point(_, __, content)[source]

Extracts the content of a break point with a comment.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
content (str | None) – The content of the comment of the breakpoint.

Returns:

The breakpoint.

Return type:

Knitout_BreakPoint

comment(_, __, content)[source]

Extracts the content of a comment.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
content (str | None) – The content of the comment.

Returns:

The content of the comment.

Return type:

str | None

comment_line(_, __, content)[source]

Extracts the content of a comment.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
content (str) – The content of the comment.

Returns:

The comment line.

Return type:

Knitout_Comment_Line

code_line(_, __, c, com)[source]

Creates a knitout line with optional comment.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
c (Knitout_Line | None) – The knitout line to execute, if any.
com (str | None) – The comment to append to the knitout line.

Returns:

The knitout line created or None if no values are given.

Return type:

Knitout_Line | None

magic_string(_, __, v)[source]

Creates a knitout version line.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
v (int) – Version number.

Returns:

The version line knitout line.

Return type:

Knitout_Version_Line

header_line(_, __, h_op)[source]

Returns a header line operation.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
h_op (Knitout_Header_Line) – Operation on the line.

Returns:

The header operation.

Return type:

Knitout_Header_Line

machine_op(_, __, m)[source]

Creates a machine header line.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
m (str) – The machine name as a string.

Returns:

The machine declaration operation.

Return type:

Machine_Header_Line

gauge_op(_, __, g)[source]

Creates a gauge header line.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
g (int) – Gauge value.

Returns:

The gauge header.

Return type:

Gauge_Header_Line

yarn_op(_, __, cid, color)[source]

Creates a yarn header line.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
cid (int) – The carrier to assign the yarn too.
color (str) – The yarn color.

Returns:

Comment of yarn declaration.

Return type:

Knitout_Comment_Line

carriers_op(_, __, CS)[source]

Creates a carriers header line.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
CS (Yarn_Carrier_Set) – The carriers that are available.

Returns:

Carrier declaration.

Return type:

Carriers_Header_Line

position_op(_, __, p)[source]

Creates a position header line.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
p (str) – The position of operations.

Returns:

The position declaration.

Return type:

Position_Header_Line

in_op(_, __, c)[source]

Creates an in instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
c (int) – The carrier to bring in.

Returns:

In operation on a carrier set.

Return type:

In_Instruction

inhook_op(_, __, c)[source]

Creates an inhook instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
c (int) – The carrier to hook in.

Returns:

Inhook operation on carrier set.

Return type:

Inhook_Instruction

releasehook_op(_, __, c)[source]

Creates a releasehook instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
c (int) – Carrier set.

Returns:

Releasehook operation on carrier set.

Return type:

Releasehook_Instruction

out_op(_, __, c)[source]

Creates an out instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
c (int) – Carrier set.

Returns:

Out operation on the carrier set.

Return type:

Out_Instruction

outhook_op(_, __, c)[source]

Creates an outhook instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
c (int) – Carrier set.

Returns:

Outhook operation on the carrier set.

Return type:

Outhook_Instruction

rack_op(_, __, R)[source]

Creates a rack instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
R (float) – Rack value.

Returns:

Rack operation.

Return type:

Rack_Instruction

knit_op(_, __, D, N, CS)[source]

Creates a knit instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
D (str) – Direction operates in.
N (Needle_Specification) – Needle to operate on.
CS (Yarn_Carrier_Set) – A carrier set.

Returns:

Knit operation.

Return type:

Knit_Instruction

tuck_op(_, __, D, N, CS)[source]

Creates a tuck instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
D (str) – Direction operates in.
N (Needle_Specification) – Needle to operate on.
CS (Yarn_Carrier_Set) – A carrier set.

Returns:

Tuck operation.

Return type:

Tuck_Instruction

miss_op(_, __, D, N, CS)[source]

Creates a miss instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
D (str) – Direction to operate in.
N (Needle_Specification) – Needle to operate on.
CS (Yarn_Carrier_Set) – A carrier set.

Returns:

Miss operation.

Return type:

Miss_Instruction

kick_op(_, __, D, N, CS)[source]

Creates a kick instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
D (str) – The direction to operate in.
N (Needle_Specification) – The needle to position the kickback.
CS (Yarn_Carrier_Set) – The carrier set to kick.

Returns:

The specified Kick Operation.

Return type:

Kick_Instruction

split_op(_, __, D, N, N2, CS)[source]

Creates a split instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
D (str) – Direction operates in.
N (Needle_Specification) – Needle to operate on.
N2 (Needle_Specification) – Second needle to move to.
CS (Yarn_Carrier_Set) – A carrier set.

Returns:

Split operation.

Return type:

Split_Instruction

drop_op(_, __, N)[source]

Creates a drop instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
N (Needle_Specification) – Needle to drop from.

Returns:

Drop operation.

Return type:

Drop_Instruction

xfer_op(_, __, N, N2)[source]

Creates a transfer instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
N (Needle_Specification) – Needle to transfer from.
N2 (Needle_Specification) – Needle to transfer to.

Returns:

Xfer operation.

Return type:

Xfer_Instruction

pause_op(_, __)[source]

Creates a pause instruction.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.

Returns:

Pause operation.

Return type:

Pause_Instruction

identifier(_, node)[source]

Returns an identifier string.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
node (str) – Identifier string.

Returns:

The identifier string.

Return type:

str

float_exp(_, node)[source]

Converts a string to a float.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
node (str) – Float string.

Returns:

Float conversion.

Return type:

float

int_exp(_, node)[source]

Converts a string to an integer.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
node (str) – Integer string.

Returns:

Integer conversion.

Return type:

int

needle_id(_, node)[source]

Creates a needle from a string representation.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
node (str) – String of the given needle.

Returns:

The Needle represented by this string.

Return type:

Needle_Specification

carrier_set(_, __, carriers)[source]

Creates a yarn carrier set.

Parameters:

_ (LRStackNode) – The stack node element being processed by this action.
__ (list) – A list of values found for this action.
carriers (list[int]) – Carriers in set.

Returns:

Carrier set.

Return type:

Yarn_Carrier_Set