Message

exception ahk.message.OutOfMessageTypes[source]
class ahk.message.BytesLineReadable(*args, **kwargs)[source]
readline()[source]
Return type:

bytes

__init__(*args, **kwargs)
ahk.message.is_window_control_list_response(resp_obj)[source]
Parameters:

resp_obj (object) –

Return type:

TypeGuard[Tuple[str, List[Tuple[str, str]]]]

ahk.message.is_winget_response_type(obj)[source]
Parameters:

obj (object) –

Return type:

TypeGuard[Union[StringResponseMessage, IntegerResponseMessage, WindowListResponseMessage, WindowControlListResponseMessage]]

ahk.message.tom_generator()[source]
Return type:

Generator[bytes, None, None]

class ahk.message.ResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

classmethod fqn()[source]
Return type:

str

__init__(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

classmethod from_bytes(b, engine=None)[source]
Parameters:

  • b (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

Return type:

ResponseMessageTypes

to_bytes()[source]
Return type:

bytes

abstract unpack()[source]
Return type:

Any

class ahk.message.TupleResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

Tuple[Any, ...]

class ahk.message.CoordinateResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

Coordinates

class ahk.message.IntegerResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

int

class ahk.message.BooleanResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

bool

class ahk.message.StringResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

str

class ahk.message.WindowListResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

Union[List[Window], List[AsyncWindow]]

class ahk.message.NoValueResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

None

class ahk.message.ExceptionResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

NoReturn

class ahk.message.WindowControlListResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

Union[List[AsyncControl], List[Control]]

class ahk.message.WindowResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

Union[Window, AsyncWindow]

class ahk.message.PositionResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

Position

class ahk.message.FloatResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

float

class ahk.message.TimeoutResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

class ahk.message.B64BinaryResponseMessage(raw_content, engine=None)[source]
Parameters:

  • raw_content (bytes) –

  • engine (Optional[Union[AsyncAHK[Any], AHK[Any]]]) –

unpack()[source]
Return type:

bytes

class ahk.message.RequestMessage(function_name, args=None)[source]
Parameters:

  • function_name (str) –

  • args (Optional[List[str]]) –

__init__(function_name, args=None)[source]
Parameters:

  • function_name (str) –

  • args (Optional[List[str]]) –

format()[source]
Return type:

bytes