virtual_knitting_machine.knitting_machine_warnings.Knitting_Machine_Warning module

A module containing the base class for knitting machine warnings. This module provides the foundational warning class that all knitting machine-specific warnings inherit from, standardizing warning message formatting and handling behavior across the virtual knitting machine system.

get_user_warning_stack_level_from_virtual_knitting_machine_package()

Returns:

The stack level pointing to first caller outside this library.

Return type:

int

exception Knitting_Machine_Warning(message, ignore_instructions=False)

Bases: RuntimeWarning

Base class for warnings about the state of the knitting machine that can be handled gracefully. This class provides standardized warning message formatting and supports configurable instruction ignoring behavior for different types of machine state issues.

__init__(message, ignore_instructions=False)

Initialize a knitting machine warning with formatted message.

Parameters:

• message (str) – The descriptive warning message about the machine state issue.

• ignore_instructions (bool, optional) – Whether this warning indicates that the operation should be ignored. Defaults to False.

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception Passed_Machine_Error_Warning(exception, ignore_instructions=False)

Bases: Knitting_Machine_Warning

__init__(exception, ignore_instructions=False)

Initialize a knitting machine warning with formatted message.

Parameters:

• message (str) – The descriptive warning message about the machine state issue.

• ignore_instructions (bool, optional) – Whether this warning indicates that the operation should be ignored. Defaults to False.

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.