initial generic version typing

ahk/__init__.py

@@ -25,7 +25,7 @@
     'MsgBoxModality',
 ]
 
-_global_instance: Optional[AHK] = None
+_global_instance: Optional[AHK[None]] = None
 
 
 def __getattr__(name: str) -> Any:

ahk/_async/window.py

@@ -10,6 +10,7 @@
 from typing import Sequence
 from typing import Tuple
 from typing import TYPE_CHECKING
+from typing import TypeVar
 from typing import Union
 
 from ahk.message import Position
@@ -45,10 +46,12 @@ class WindowNotFoundException(Exception):
     'Use of the {0} property setter is not supported in the async API. Use the set_{0} instead.'
 )
 
+T_EngineVersion = TypeVar('T_EngineVersion', bound=Optional[Literal['v1', 'v2']])
+
 
 class AsyncWindow:
-    def __init__(self, engine: AsyncAHK, ahk_id: str):
-        self._engine: AsyncAHK = engine
+    def __init__(self, engine: AsyncAHK[T_EngineVersion], ahk_id: str):
+        self._engine: AsyncAHK[T_EngineVersion] = engine
         if not ahk_id:
             raise ValueError(f'Invalid ahk_id: {ahk_id!r}')
         self._ahk_id: str = ahk_id
@@ -381,10 +384,12 @@ async def get_position(self, *, blocking: Literal[False]) -> AsyncFutureResult[O
     @overload
     async def get_position(self, *, blocking: Literal[True]) -> Position: ...
     @overload
-    async def get_position(self, *, blocking: bool = True) -> Union[Position, AsyncFutureResult[Optional[Position]]]: ...
+    async def get_position(self, *, blocking: bool = True) -> Union[Position, AsyncFutureResult[Optional[Position]], AsyncFutureResult[Position]]: ...
     # fmt: on
-    async def get_position(self, *, blocking: bool = True) -> Union[Position, AsyncFutureResult[Optional[Position]]]:
-        resp = await self._engine.win_get_position(
+    async def get_position(
+        self, *, blocking: bool = True
+    ) -> Union[Position, AsyncFutureResult[Optional[Position]], AsyncFutureResult[Position]]:
+        resp = await self._engine.win_get_position(  # type: ignore[misc] # this appears to be a mypy bug
             title=f'ahk_id {self._ahk_id}',
             blocking=blocking,
             detect_hidden_windows=True,
@@ -652,11 +657,11 @@ async def move(
         )
 
     @classmethod
-    async def from_pid(cls, engine: AsyncAHK, pid: int) -> Optional[AsyncWindow]:
+    async def from_pid(cls, engine: AsyncAHK[Any], pid: int) -> Optional[AsyncWindow]:
         return await engine.win_get(title=f'ahk_pid {pid}')
 
     @classmethod
-    async def from_mouse_position(cls, engine: AsyncAHK) -> Optional[AsyncWindow]:
+    async def from_mouse_position(cls, engine: AsyncAHK[Any]) -> Optional[AsyncWindow]:
         return await engine.win_get_from_mouse_position()
 
 

ahk/_sync/window.py

@@ -10,6 +10,7 @@
 from typing import Sequence
 from typing import Tuple
 from typing import TYPE_CHECKING
+from typing import TypeVar
 from typing import Union
 
 from ahk.message import Position
@@ -41,10 +42,12 @@ class WindowNotFoundException(Exception):
     'Use of the {0} property setter is not supported in the async API. Use the set_{0} instead.'
 )
 
+T_EngineVersion = TypeVar('T_EngineVersion', bound=Optional[Literal['v1', 'v2']])
+
 
 class Window:
-    def __init__(self, engine: AHK, ahk_id: str):
-        self._engine: AHK = engine
+    def __init__(self, engine: AHK[T_EngineVersion], ahk_id: str):
+        self._engine: AHK[T_EngineVersion] = engine
         if not ahk_id:
             raise ValueError(f'Invalid ahk_id: {ahk_id!r}')
         self._ahk_id: str = ahk_id
@@ -289,7 +292,9 @@ def send(self, keys: str, control: str = '', *, blocking: Literal[True]) -> None
     @overload
     def send(self, keys: str, control: str = '', *, blocking: bool = True) -> Union[None, FutureResult[None]]: ...
     # fmt: on
-    def send(self, keys: str, control: str = '', *, blocking: bool = True) -> Union[None, FutureResult[None]]:
+    def send(
+        self, keys: str, control: str = '', *, blocking: bool = True
+    ) -> Union[None, FutureResult[None]]:
         return self._engine.control_send(
             keys=keys,
             control=control,
@@ -358,10 +363,12 @@ def get_position(self, *, blocking: Literal[False]) -> FutureResult[Optional[Pos
     @overload
     def get_position(self, *, blocking: Literal[True]) -> Position: ...
     @overload
-    def get_position(self, *, blocking: bool = True) -> Union[Position, FutureResult[Optional[Position]]]: ...
+    def get_position(self, *, blocking: bool = True) -> Union[Position, FutureResult[Optional[Position]], FutureResult[Position]]: ...
     # fmt: on
-    def get_position(self, *, blocking: bool = True) -> Union[Position, FutureResult[Optional[Position]]]:
-        resp = self._engine.win_get_position(
+    def get_position(
+        self, *, blocking: bool = True
+    ) -> Union[Position, FutureResult[Optional[Position]], FutureResult[Position]]:
+        resp = self._engine.win_get_position(  # type: ignore[misc] # this appears to be a mypy bug
             title=f'ahk_id {self._ahk_id}',
             blocking=blocking,
             detect_hidden_windows=True,
@@ -629,11 +636,11 @@ def move(
         )
 
     @classmethod
-    def from_pid(cls, engine: AHK, pid: int) -> Optional[Window]:
+    def from_pid(cls, engine: AHK[Any], pid: int) -> Optional[Window]:
         return engine.win_get(title=f'ahk_pid {pid}')
 
     @classmethod
-    def from_mouse_position(cls, engine: AHK) -> Optional[Window]:
+    def from_mouse_position(cls, engine: AHK[Any]) -> Optional[Window]:
         return engine.win_get_from_mouse_position()
 
 

ahk/extensions.py

@@ -34,7 +34,7 @@ class _ExtensionEntry:
 if typing.TYPE_CHECKING:
     from ahk import AHK, AsyncAHK
 
-    TAHK = TypeVar('TAHK', bound=typing.Union[AHK, AsyncAHK])
+    TAHK = TypeVar('TAHK', bound=typing.Union[AHK[Any], AsyncAHK[Any]])
 
 
 @dataclass

ahk/message.py

@@ -114,9 +114,9 @@ def __init_subclass__(cls: Type[T_ResponseMessageType], **kwargs: Any) -> None:
         _message_registry[tom] = cls
         super().__init_subclass__(**kwargs)
 
-    def __init__(self, raw_content: bytes, engine: Optional[Union[AsyncAHK, AHK]] = None):
+    def __init__(self, raw_content: bytes, engine: Optional[Union[AsyncAHK[Any], AHK[Any]]] = None):
         self._raw_content: bytes = raw_content
-        self._engine: Optional[Union[AsyncAHK, AHK]] = engine
+        self._engine: Optional[Union[AsyncAHK[Any], AHK[Any]]] = engine
 
     def __repr__(self) -> str:
         return f'ResponseMessage<fqn={self.fqn()!r}>'
@@ -130,7 +130,7 @@ def _tom_lookup(tom: bytes) -> 'ResponseMessageClassTypes':
 
     @classmethod
     def from_bytes(
-        cls: Type[T_ResponseMessageType], b: bytes, engine: Optional[Union[AsyncAHK, AHK]] = None
+        cls: Type[T_ResponseMessageType], b: bytes, engine: Optional[Union[AsyncAHK[Any], AHK[Any]]] = None
     ) -> 'ResponseMessageTypes':
         tom, _, message_bytes = b.split(b'\n', 2)
         klass = cls._tom_lookup(tom)