AutoMonkey 0.4.2__tar.gz → 0.4.4__tar.gz

{automonkey-0.4.2 → automonkey-0.4.4/AutoMonkey.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoMonkey
-Version: 0.4.2
+Version: 0.4.4
 Summary: Python Automation using Mouse and Keyboard, for the masses
 Author-email: Mihail-Cosmin Munteanu <munteanumihailcosmin@gmail.com>
 License: GNU General Public License v3 (GPLv3)
@@ -74,13 +74,21 @@ pip install git+https://github.com/MihailCosmin/AutoMonkey
 - clipboard
 - keyboard
 - screeninfo
-- pywin32
+- pywin32 (Windows only)
 - pillow
 - opencv-python
 - numpy
 - pytesseract
 - <a href="https://github.com/pywinauto/pywinauto">pywinauto</a> (Windows only, for the control actions)
 
+The control actions (`get_window`, `click_control`, `type_in_control`, ...) are **not** Windows-only:
+on Linux the same functions run on AT-SPI, with identical names and arguments, so a `chain` script
+needs no changes between the two. Windows gets pywinauto from pip (above); Linux uses distro packages
+instead of pip - `python3-gi`, `gir1.2-atspi-2.0`, `at-spi2-core` on Debian/Ubuntu/Raspberry Pi OS -
+plus accessibility enabled (`gsettings set org.gnome.desktop.interface toolkit-accessibility true`).
+Setup, the `control_type` → AT-SPI role mapping and the known Wayland limits are in
+*Control actions* → *Linux (AT-SPI)* under Usage. macOS is not implemented yet.
+
 # Usage
 Main function to be used is "chain"  
 

{automonkey-0.4.2 → automonkey-0.4.4}/AutoMonkey.egg-info/SOURCES.txt

@@ -51,4 +51,5 @@ tests/test_atspi_funcs.py
 tests/test_atspi_integration.py
 tests/test_key_funcs.py
 tests/test_mcp_launch.py
+tests/test_mouse_tracker.py
 tests/test_pywinauto_funcs.py

{automonkey-0.4.2/AutoMonkey.egg-info → automonkey-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoMonkey
-Version: 0.4.2
+Version: 0.4.4
 Summary: Python Automation using Mouse and Keyboard, for the masses
 Author-email: Mihail-Cosmin Munteanu <munteanumihailcosmin@gmail.com>
 License: GNU General Public License v3 (GPLv3)
@@ -74,13 +74,21 @@ pip install git+https://github.com/MihailCosmin/AutoMonkey
 - clipboard
 - keyboard
 - screeninfo
-- pywin32
+- pywin32 (Windows only)
 - pillow
 - opencv-python
 - numpy
 - pytesseract
 - <a href="https://github.com/pywinauto/pywinauto">pywinauto</a> (Windows only, for the control actions)
 
+The control actions (`get_window`, `click_control`, `type_in_control`, ...) are **not** Windows-only:
+on Linux the same functions run on AT-SPI, with identical names and arguments, so a `chain` script
+needs no changes between the two. Windows gets pywinauto from pip (above); Linux uses distro packages
+instead of pip - `python3-gi`, `gir1.2-atspi-2.0`, `at-spi2-core` on Debian/Ubuntu/Raspberry Pi OS -
+plus accessibility enabled (`gsettings set org.gnome.desktop.interface toolkit-accessibility true`).
+Setup, the `control_type` → AT-SPI role mapping and the known Wayland limits are in
+*Control actions* → *Linux (AT-SPI)* under Usage. macOS is not implemented yet.
+
 # Usage
 Main function to be used is "chain"  
 

{automonkey-0.4.2 → automonkey-0.4.4}/README.md

@@ -32,13 +32,21 @@ pip install git+https://github.com/MihailCosmin/AutoMonkey
 - clipboard
 - keyboard
 - screeninfo
-- pywin32
+- pywin32 (Windows only)
 - pillow
 - opencv-python
 - numpy
 - pytesseract
 - <a href="https://github.com/pywinauto/pywinauto">pywinauto</a> (Windows only, for the control actions)
 
+The control actions (`get_window`, `click_control`, `type_in_control`, ...) are **not** Windows-only:
+on Linux the same functions run on AT-SPI, with identical names and arguments, so a `chain` script
+needs no changes between the two. Windows gets pywinauto from pip (above); Linux uses distro packages
+instead of pip - `python3-gi`, `gir1.2-atspi-2.0`, `at-spi2-core` on Debian/Ubuntu/Raspberry Pi OS -
+plus accessibility enabled (`gsettings set org.gnome.desktop.interface toolkit-accessibility true`).
+Setup, the `control_type` → AT-SPI role mapping and the known Wayland limits are in
+*Control actions* → *Linux (AT-SPI)* under Usage. macOS is not implemented yet.
+
 # Usage
 Main function to be used is "chain"  
 

{automonkey-0.4.2 → automonkey-0.4.4}/automonkey/mouse_tracker.py

@@ -1,4 +1,5 @@
 from time import sleep
+from typing import Any
 
 from tkinter import Tk
 from tkinter import Canvas
@@ -24,38 +25,59 @@ def track_mouse():
         print("Tracking mouse position stopped")
 
 
-class PositionTracker:  # was Toplevel
-    """PositionTracker
+class PositionTracker:
+    """Full-screen overlay that shows the live cursor coordinates.
+
+    Constructing a tracker puts nothing on screen - the Tk window is built by
+    start(). (GitHub issue #3: the window used to be created in __init__, so
+    merely instantiating this class opened a stray empty window, and the
+    documented "tracker = PositionTracker(); tracker.start()" usage looked
+    broken. The coordinate display itself is unchanged and still drawn by the
+    overlay.)
     """
+
     def __init__(self, follow_mouse: bool = False):
         self.follow_mouse = follow_mouse
-        self.window = Tk()  # Was Tk()
-        self.window.canvas = None
+        # Deliberately not created here: the overlay is built by start(), so that
+        # constructing a tracker is side-effect free (issue #3). Annotated Any because
+        # Tk instances carry the ad-hoc .canvas attribute added in start().
+        self.window: Any = None
         self.coords = None
         self.get_coords = False
         self.after = None
 
     def start(self, get_coords: bool = False):
-        """Take the screenshot
+        """Show the overlay and display the live cursor coordinates.
+
+        get_coords=True lets the user pick a point with CTRL+Left Click; the
+        coordinates of that point are returned. Otherwise press ESC to end
+        tracking, and None is returned.
         """
-        if self.after:
+        if self.after is not None and self.window is not None:
             self.window.after_cancel(self.after)
+            self.after = None
+
+        self.get_coords = get_coords
+
+        if self.window is None:
+            self.window = Tk()
+            self.window.canvas = None
         if get_coords:
-            self.get_coords = True
             self.window.bind('<Control-Button-1>', lambda e: self.destroy_())
         else:
             self.window.bind('<Escape>', lambda e: self.destroy_())
         self.window.attributes('-fullscreen', True, '-alpha', 0.3)
         self.window.configure(bg='black')
 
-        self.window.canvas = Canvas(
-            self.window,
-            width=self.window.winfo_screenwidth(),
-            height=self.window.winfo_screenheight(),
-            cursor="crosshair"
-        )
-        self.window.canvas.configure(highlightthickness=0, bg='black')
-        self.window.canvas.pack()
+        if self.window.canvas is None:
+            self.window.canvas = Canvas(
+                self.window,
+                width=self.window.winfo_screenwidth(),
+                height=self.window.winfo_screenheight(),
+                cursor="crosshair"
+            )
+            self.window.canvas.configure(highlightthickness=0, bg='black')
+            self.window.canvas.pack()
 
         self.after = self.window.after(1, self._crosshair, None)
         self.window.mainloop()
@@ -129,5 +151,15 @@ class PositionTracker:  # was Toplevel
         return y_point - 100
 
     def destroy_(self):
-        self.window.after_cancel(self.after)
-        self.window.destroy()
+        """Close the overlay.
+
+        Safe on a tracker that was never started (it used to raise ValueError
+        from after_cancel(None)), and leaves the instance reusable: a later
+        start() builds a fresh window.
+        """
+        if self.after is not None and self.window is not None:
+            self.window.after_cancel(self.after)
+            self.after = None
+        if self.window is not None:
+            self.window.destroy()
+            self.window = None

{automonkey-0.4.2 → automonkey-0.4.4}/pyproject.toml

@@ -14,7 +14,7 @@ name = "AutoMonkey"
 # .github/workflows/python-package.yml, right after a successful upload to PyPI, so the
 # tree always holds the *next* version to be released. Bump it by hand with
 # `python bump_version.py` (patch) / `python bump_version.py --part minor` / `--set 1.0.0`.
-version = "0.4.2"
+version = "0.4.4"
 description = "Python Automation using Mouse and Keyboard, for the masses"
 readme = "README.md"
 requires-python = ">=3.8"

automonkey-0.4.4/tests/test_mouse_tracker.py

@@ -0,0 +1,62 @@
+"""Regression tests for GitHub issue #3 ("PositionTracker not working").
+
+The issue had two halves: merely constructing a PositionTracker opened a Tk
+window it shouldn't, and destroy_() blew up on an instance that was never
+started. The coordinate rendering was the part that already worked, and is
+covered by test_start_shows_the_cursor_coordinates.
+"""
+import pytest
+
+tkinter = pytest.importorskip("tkinter")
+
+from automonkey import PositionTracker  # noqa: E402
+
+
+def test_constructing_a_tracker_opens_no_window():
+    # Documented usage is `tracker = PositionTracker(); tracker.start()`, so nothing
+    # may appear on screen before start() runs.
+    root_before = tkinter._default_root
+    tracker = PositionTracker()
+    assert tracker.window is None
+    assert tkinter._default_root is root_before, "constructing created a Tk root"
+
+
+def test_destroy_is_safe_on_a_tracker_that_was_never_started():
+    tracker = PositionTracker()
+    tracker.destroy_()  # used to raise ValueError from after_cancel(None)
+    assert tracker.window is None
+
+
+def test_start_shows_the_cursor_coordinates():
+    tracker = PositionTracker(follow_mouse=False)
+    captured = {}
+    real_tk = tkinter.Tk
+
+    def tk_factory(*args, **kwargs):
+        """Hand back a real Tk root, primed to snapshot the canvas and close."""
+        root = real_tk(*args, **kwargs)
+
+        def grab_and_close():
+            canvas = tracker.window.canvas
+            captured["texts"] = [
+                canvas.itemcget(item, "text")
+                for item in canvas.find_all()
+                if canvas.type(item) == "text"
+            ]
+            tracker.destroy_()
+
+        root.after(500, grab_and_close)
+        return root
+
+    monkeypatch = pytest.MonkeyPatch()
+    monkeypatch.setattr("automonkey.mouse_tracker.Tk", tk_factory)
+    try:
+        tracker.start()
+    except tkinter.TclError as exc:  # no display available (headless CI without xvfb)
+        pytest.skip(f"no usable display: {exc}")
+    finally:
+        monkeypatch.undo()
+
+    texts = captured.get("texts", [])
+    assert any(t.startswith("x=") and ", y=" in t for t in texts), \
+        f"cursor coordinates were not drawn on the overlay, got {texts!r}"