Skip to content
This repository has been archived by the owner on Dec 13, 2022. It is now read-only.

Commit

Permalink
cleanup function names
Browse files Browse the repository at this point in the history
  • Loading branch information
@spyoungtech
spyoungtech committed Nov 14, 2022
1 parent 11dcc0c commit ee5c185
Show file tree
Hide file tree
Showing 5 changed files with 183 additions and 179 deletions.
10 changes: 5 additions & 5 deletions ahk/_async/engine.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ async def list_windows(
else:
args.append('')
args.append('')
resp = await self._transport.function_call('WindowList', args, engine=self, blocking=blocking)
resp = await self._transport.function_call('AHKWindowList', args, engine=self, blocking=blocking)
return resp

# fmt: off
Expand All @@ -504,7 +504,7 @@ async def get_mouse_position(self, *, blocking: bool = True) -> Union[Tuple[int,
async def get_mouse_position(
self, *, blocking: bool = True
) -> Union[Tuple[int, int], AsyncFutureResult[Tuple[int, int]]]:
resp = await self._transport.function_call('MouseGetPos', blocking=blocking)
resp = await self._transport.function_call('AHKMouseGetPos', blocking=blocking)
return resp

# fmt: off
Expand Down Expand Up @@ -539,7 +539,7 @@ async def mouse_move(
args = [str(x), str(y), str(speed)]
if relative:
args.append('R')
resp = await self._transport.function_call('MouseMove', args, blocking=blocking)
resp = await self._transport.function_call('AHKMouseMove', args, blocking=blocking)
return resp

async def a_run_script(self, script_text: str, decode: bool = True, blocking: bool = True, **runkwargs: Any) -> str:
Expand Down Expand Up @@ -705,7 +705,7 @@ async def key_wait(
if options:
args.append(options)

resp = await self._transport.function_call('KeyWait', args)
resp = await self._transport.function_call('AHKKeyWait', args)
return resp

# async def mouse_position(self):
Expand Down Expand Up @@ -2204,7 +2204,7 @@ async def image_search(
args.append(s)
else:
args.append(image_path)
resp = await self._transport.function_call('ImageSearch', args, blocking=blocking)
resp = await self._transport.function_call('AHKImageSearch', args, blocking=blocking)
return resp

async def mouse_drag(
Expand Down
161 changes: 80 additions & 81 deletions ahk/_async/transport.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,82 +65,81 @@ def result(self, timeout: Optional[float] = None) -> T_SyncFuture:


FunctionName = Literal[
Literal['AHKControlGetPos'],
Literal['AHKControlClick'],
Literal['AHKControlGetText'],
Literal['AHKGetTitleMatchMode'],
Literal['AHKGetTitleMatchSpeed'],
Literal['AHKSetDetectHiddenWindows'],
Literal['AHKSetTitleMatchMode'],
Literal['AHKWinSetTitle'],
Literal['AHKWinExist'],
Literal['ImageSearch'],
Literal['PixelGetColor'],
Literal['PixelSearch'],
Literal['MouseGetPos'],
Literal['AHKKeyState'],
Literal['MouseMove'],
Literal['CoordMode'],
Literal['Click'],
Literal['MouseClickDrag'],
Literal['KeyWait'],
Literal['SetKeyDelay'],
Literal['AHKSend'],
Literal['AHKSendRaw'],
Literal['AHKSendInput'],
Literal['AHKSendEvent'],
Literal['AHKSendPlay'],
Literal['SetCapsLockState'],
Literal['AHKWinGetTitle'],
Literal['WinGetClass'],
Literal['AHKWinGetText'],
Literal['WinActivate'],
Literal['WinActivateBottom'],
Literal['AHKWinClose'],
Literal['WinHide'],
Literal['WinKill'],
Literal['WinMaximize'],
Literal['WinMinimize'],
Literal['WinRestore'],
Literal['WinShow'],
Literal['WindowList'],
Literal['WinSend'],
Literal['WinSendRaw'],
Literal['AHKControlSend'],
Literal['FromMouse'],
Literal['WinGet'],
Literal['WinSet'],
Literal['AHKWinSetAlwaysOnTop'],
Literal['AHKWinIsAlwaysOnTop'],
Literal['AHKWinSetTop'],
Literal['AHKWinSetBottom'],
Literal['AHKWinSetDisable'],
Literal['AHKWinSetEnable'],
Literal['AHKWinSetRedraw'],
Literal['WinSetTitle'],
Literal['AHKWinSetTransparent'],
Literal['AHKWinSetTransColor'],
Literal['AHKWinSetStyle'],
Literal['AHKWinSetExStyle'],
Literal['AHKWinSetRegion'],
Literal['WinIsAlwaysOnTop'],
Literal['WinClick'],
Literal['AHKWinMove'],
Literal['AHKWinGetPos'],
Literal['AHKWinGetID'],
Literal['AHKWinGetIDLast'],
Literal['AHKWinGetPID'],
Literal['AHKWinGetProcessName'],
Literal['AHKWinGetProcessPath'],
Literal['AHKWinGetCount'],
Literal['AHKWinGetList'],
Literal['AHKWinGetMinMax'],
Literal['AHKWinGetControlList'],
Literal['AHKWinGetControlListHwnd'],
Literal['AHKWinGetTransparent'],
Literal['AHKWinGetTransColor'],
Literal['AHKWinGetStyle'],
Literal['AHKWinGetExStyle'],
'AHKControlClick',
'AHKControlGetPos',
'AHKControlGetText',
'AHKControlSend',
'AHKGetTitleMatchMode',
'AHKGetTitleMatchSpeed',
'AHKImageSearch',
'AHKKeyState',
'AHKKeyWait',
'AHKMouseGetPos',
'AHKMouseMove',
'AHKSend',
'AHKSendEvent',
'AHKSendInput',
'AHKSendPlay',
'AHKSendRaw',
'AHKSetDetectHiddenWindows',
'AHKSetTitleMatchMode',
'AHKWinClose',
'AHKWinExist',
'AHKWinGetControlList',
'AHKWinGetControlListHwnd',
'AHKWinGetCount',
'AHKWinGetExStyle',
'AHKWinGetID',
'AHKWinGetIDLast',
'AHKWinGetList',
'AHKWinGetMinMax',
'AHKWinGetPID',
'AHKWinGetPos',
'AHKWinGetProcessName',
'AHKWinGetProcessPath',
'AHKWinGetStyle',
'AHKWinGetText',
'AHKWinGetTitle',
'AHKWinGetTransColor',
'AHKWinGetTransparent',
'AHKWinIsAlwaysOnTop',
'AHKWinMove',
'AHKWinSetAlwaysOnTop',
'AHKWinSetBottom',
'AHKWinSetDisable',
'AHKWinSetEnable',
'AHKWinSetExStyle',
'AHKWinSetRedraw',
'AHKWinSetRegion',
'AHKWinSetStyle',
'AHKWinSetTitle',
'AHKWinSetTop',
'AHKWinSetTransColor',
'AHKWinSetTransparent',
'AHKWindowList',
'Click',
'CoordMode',
'FromMouse',
'MouseClickDrag',
'PixelGetColor',
'PixelSearch',
'SetCapsLockState',
'SetKeyDelay',
'WinActivate',
'WinActivateBottom',
'WinClick',
'WinGet',
'WinGetClass',
'WinHide',
'WinKill',
'WinMaximize',
'WinMinimize',
'WinRestore',
'WinSend',
'WinSendRaw',
'WinSet',
'WinSetTitle',
'WinShow',
]


Expand Down Expand Up @@ -296,25 +295,25 @@ async def init(self) -> None:
@overload
async def function_call(self, function_name: Literal['AHKWinExist'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[bool, AsyncFutureResult[bool]]: ...
@overload
async def function_call(self, function_name: Literal['ImageSearch'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[Tuple[int, int], None, AsyncFutureResult[Union[Tuple[int, int], None]]]: ...
async def function_call(self, function_name: Literal['AHKImageSearch'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[Tuple[int, int], None, AsyncFutureResult[Union[Tuple[int, int], None]]]: ...
@overload
async def function_call(self, function_name: Literal['PixelGetColor'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[str, AsyncFutureResult[str]]: ...
@overload
async def function_call(self, function_name: Literal['PixelSearch'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[Tuple[int, int], AsyncFutureResult[Tuple[int, int]]]: ...
@overload
async def function_call(self, function_name: Literal['MouseGetPos'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[Tuple[int, int], AsyncFutureResult[Tuple[int, int]]]: ...
async def function_call(self, function_name: Literal['AHKMouseGetPos'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[Tuple[int, int], AsyncFutureResult[Tuple[int, int]]]: ...
@overload
async def function_call(self, function_name: Literal['AHKKeyState'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[bool, AsyncFutureResult[bool]]: ...
@overload
async def function_call(self, function_name: Literal['MouseMove'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
async def function_call(self, function_name: Literal['AHKMouseMove'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
async def function_call(self, function_name: Literal['CoordMode'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
async def function_call(self, function_name: Literal['Click'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
async def function_call(self, function_name: Literal['MouseClickDrag'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
async def function_call(self, function_name: Literal['KeyWait'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[int, AsyncFutureResult[int]]: ...
async def function_call(self, function_name: Literal['AHKKeyWait'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[int, AsyncFutureResult[int]]: ...
@overload
async def function_call(self, function_name: Literal['SetKeyDelay'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
Expand Down Expand Up @@ -354,7 +353,7 @@ async def function_call(self, function_name: Literal['WinRestore'], args: Option
@overload
async def function_call(self, function_name: Literal['WinShow'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
async def function_call(self, function_name: Literal['WindowList'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[List[AsyncWindow], AsyncFutureResult[List[AsyncWindow]]]: ...
async def function_call(self, function_name: Literal['AHKWindowList'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[List[AsyncWindow], AsyncFutureResult[List[AsyncWindow]]]: ...
@overload
async def function_call(self, function_name: Literal['WinSend'], args: Optional[List[str]] = None, *, blocking: bool = True, engine: Optional[AsyncAHK] = None) -> Union[None, AsyncFutureResult[None]]: ...
@overload
Expand Down
20 changes: 13 additions & 7 deletions ahk/_sync/engine.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ def list_windows(
else:
args.append('')
args.append('')
resp = self._transport.function_call('WindowList', args, engine=self, blocking=blocking)
resp = self._transport.function_call('AHKWindowList', args, engine=self, blocking=blocking)
return resp

# fmt: off
Expand All @@ -503,7 +503,7 @@ def get_mouse_position(self, *, blocking: bool = True) -> Union[Tuple[int, int],
def get_mouse_position(
self, *, blocking: bool = True
) -> Union[Tuple[int, int], FutureResult[Tuple[int, int]]]:
resp = self._transport.function_call('MouseGetPos', blocking=blocking)
resp = self._transport.function_call('AHKMouseGetPos', blocking=blocking)
return resp

# fmt: off
Expand Down Expand Up @@ -538,12 +538,13 @@ def mouse_move(
args = [str(x), str(y), str(speed)]
if relative:
args.append('R')
resp = self._transport.function_call('MouseMove', args, blocking=blocking)
resp = self._transport.function_call('AHKMouseMove', args, blocking=blocking)
return resp

def a_run_script(self, script_text: str, decode: bool = True, blocking: bool = True, **runkwargs: Any) -> str:
raise NotImplementedError()

# fmt: off
@overload
def get_active_window(self) -> Optional[Window]: ...
@overload
Expand All @@ -552,8 +553,13 @@ def get_active_window(self, blocking: Literal[True]) -> Optional[Window]: ...
def get_active_window(self, blocking: Literal[False]) -> FutureResult[Optional[Window]]: ...
@overload
def get_active_window(self, blocking: bool = True) -> Union[Optional[Window], FutureResult[Optional[Window]]]: ...
def get_active_window(self, blocking: bool = True) -> Union[Optional[Window], FutureResult[Optional[Window]]]:
return self.win_get(title='A', detect_hidden_windows=False, title_match_mode=(1, 'Fast'), blocking=blocking)
# fmt: on
def get_active_window(
self, blocking: bool = True
) -> Union[Optional[Window], FutureResult[Optional[Window]]]:
return self.win_get(
title='A', detect_hidden_windows=False, title_match_mode=(1, 'Fast'), blocking=blocking
)

def find_windows(
self, func: Optional[Callable[[Window], bool]] = None, **kwargs: Any
Expand Down Expand Up @@ -698,7 +704,7 @@ def key_wait(
if options:
args.append(options)

resp = self._transport.function_call('KeyWait', args)
resp = self._transport.function_call('AHKKeyWait', args)
return resp

# async def mouse_position(self):
Expand Down Expand Up @@ -2197,7 +2203,7 @@ def image_search(
args.append(s)
else:
args.append(image_path)
resp = self._transport.function_call('ImageSearch', args, blocking=blocking)
resp = self._transport.function_call('AHKImageSearch', args, blocking=blocking)
return resp

def mouse_drag(
Expand Down
Loading

0 comments on commit ee5c185

Please sign in to comment.