Separate out pyppeteer and playwright modules

Author: mcolella14

.gitignore

@@ -135,4 +135,6 @@ dmypy.json
 .pytype/
 
 # Cython debug symbols
-cython_debug/
+cython_debug/
+
+.vscode

pyppeteer_ghost_cursor/__init__.py

@@ -1,7 +1,28 @@
 import logging
 
-from pyppeteer_ghost_cursor.spoof import createCursor, get_path as path
-from pyppeteer_ghost_cursor.mouseHelper import installMouseHelper
-
 _logger = logging.getLogger(__name__)
 _logger.setLevel(logging.DEBUG)
+
+from .shared import path
+
+# To support deprecations
+def createCursor(*args, **kwargs):
+    from .pyppeteer import create_cursor
+
+    _logger.warning(
+        """DEPRECATION WARNING: 'createCursor' has been moved, please use the new version: 'from python_ghost_cursor.pyppeteer import create_cursor'.
+        This method will be removed in a future release.
+        """
+    )
+    return create_cursor(*args, **kwargs)
+
+
+def installMouseHelper(*args, **kwargs):
+    from .pyppeteer import install_mouse_helper
+
+    _logger.warning(
+        """DEPRECATION WARNING: 'installMouseHelper' has been moved, please use the new version: 'from python_ghost_cursor.pyppeteer import install_mouse_helper'.
+        This method will be removed in a future release.
+        """
+    )
+    return install_mouse_helper(*args, **kwargs)

pyppeteer_ghost_cursor/mouseHelper.py

@@ -0,0 +1,3 @@
+from pyppeteer_ghost_cursor import _logger
+from .spoof import create_cursor
+from .mouse_helper import install_mouse_helper

pyppeteer_ghost_cursor/playwright/async_api/__init__.py

@@ -0,0 +1,9 @@
+from pyppeteer.page import Page
+from typing import Coroutine
+from pathlib import Path
+
+
+async def install_mouse_helper(page: Page) -> Coroutine[None, None, None]:
+    await page.evaluateOnNewDocument(
+        Path(__file__).parent.joinpath("../js/mouseHelper.js").read_text()
+    )

pyppeteer_ghost_cursor/playwright/sync_api/__init__.py

@@ -1,13 +1,6 @@
-# TODO:
-# - Add click and moveTo
-# - Double check for completion
-# - Actually make a repo
-# - Publish
-
 import asyncio
 import logging
 import math
-import numpy as np
 import random
 from typing import Union, Coroutine, Optional, Dict, List
 from pyppeteer.page import Page
@@ -21,26 +14,17 @@
     # https://github.com/pyppeteer/pyppeteer/blob/dev/pyppeteer/element_handle.py
     from pyppeteer.element_handle import ElementHandle
 
-from pyppeteer_ghost_cursor.math import (
+from pyppeteer_ghost_cursor.shared.math import (
     Vector,
-    magnitude,
-    direction,
     origin,
-    bezierCurve,
     overshoot,
 )
+from pyppeteer_ghost_cursor.shared.spoof import path, shouldOvershoot
 
 
 logger = logging.getLogger(__name__)
 
 
-def fitts(distance: float, width: float) -> float:
-    a = 0
-    b = 2
-    id_ = math.log2(distance / width + 1)
-    return a + b * id_
-
-
 def getRandomBoxPoint(box: Dict, paddingPercentage: Optional[float] = None) -> Vector:
     """Get a random point on a box"""
     paddingWidth = paddingHeight = 0
@@ -124,40 +108,6 @@ async def getElementBox(
     return elementBox
 
 
-def path(
-    start: Vector, end: Union[Dict, Vector], spreadOverride: Optional[float] = None
-) -> List[Vector]:
-    defaultWidth = 100
-    minSteps = 25
-    if isinstance(end, dict):
-        width = end["width"]
-        end = Vector(end["x"], end["y"])
-    else:
-        width = defaultWidth
-    curve = bezierCurve(start, end, spreadOverride)
-    length = curve.length * 0.8
-    baseTime = random.random() * minSteps
-    steps = math.ceil((math.log2(fitts(length, width) + 1) + baseTime) * 3)
-    s_vals = np.linspace(0.0, 1.0, steps)
-    points = curve.evaluate_multi(s_vals)
-    vectors = []
-    for i in range(steps):
-        vectors.append(Vector(points[0][i], points[1][i]))
-    return clampPositive(vectors)
-
-
-def clampPositive(vectors: List[Vector]) -> List[Vector]:
-    clamp0 = lambda elem: max(0, elem)
-    return [Vector(clamp0(el.x), clamp0(el.y)) for el in vectors]
-
-
-overshootThreshold = 500
-
-
-def shouldOvershoot(a: Vector, b: Vector) -> bool:
-    return magnitude(direction(a, b)) > overshootThreshold
-
-
 class GhostCursor:
     def __init__(self, page, start: Vector):
         self.page = page
@@ -294,18 +244,13 @@ async def moveTo(self, destination: dict) -> Coroutine[None, None, None]:
         self.toggleRandomMove(True)
 
 
-def createCursor(
+def create_cursor(
     page, start: Union[Vector, Dict] = origin, performRandomMoves: bool = False
-) -> Coroutine[None, None, GhostCursor]:
+) -> GhostCursor:
     if isinstance(start, dict):
         start = Vector(**start)
     cursor = GhostCursor(page, start)
     if performRandomMoves:
         # Start random mouse movements. Do not await the promise but return immediately
         asyncio.ensure_future(cursor.randomMove())  # fire and forget
     return cursor
-
-
-def get_path(start: Dict, end: Dict) -> List[Dict]:
-    vectors = path(Vector(**start), Vector(**end))
-    return [el.__dict__ for el in vectors]

pyppeteer_ghost_cursor/pyppeteer/__init__.py

@@ -0,0 +1 @@
+from .spoof import get_path as path

pyppeteer_ghost_cursor/pyppeteer/mouse_helper.py

@@ -0,0 +1,53 @@
+import math
+import random
+import numpy as np
+from typing import Union, Optional, Dict, List
+from pyppeteer_ghost_cursor.shared.math import (
+    Vector,
+    magnitude,
+    direction,
+    bezierCurve,
+)
+
+def fitts(distance: float, width: float) -> float:
+    a = 0
+    b = 2
+    id_ = math.log2(distance / width + 1)
+    return a + b * id_
+
+def path(
+    start: Vector, end: Union[Dict, Vector], spreadOverride: Optional[float] = None
+) -> List[Vector]:
+    defaultWidth = 100
+    minSteps = 25
+    if isinstance(end, dict):
+        width = end["width"]
+        end = Vector(end["x"], end["y"])
+    else:
+        width = defaultWidth
+    curve = bezierCurve(start, end, spreadOverride)
+    length = curve.length * 0.8
+    baseTime = random.random() * minSteps
+    steps = math.ceil((math.log2(fitts(length, width) + 1) + baseTime) * 3)
+    s_vals = np.linspace(0.0, 1.0, steps)
+    points = curve.evaluate_multi(s_vals)
+    vectors = []
+    for i in range(steps):
+        vectors.append(Vector(points[0][i], points[1][i]))
+    return clampPositive(vectors)
+
+
+def clampPositive(vectors: List[Vector]) -> List[Vector]:
+    clamp0 = lambda elem: max(0, elem)
+    return [Vector(clamp0(el.x), clamp0(el.y)) for el in vectors]
+
+
+overshootThreshold = 500
+
+
+def shouldOvershoot(a: Vector, b: Vector) -> bool:
+    return magnitude(direction(a, b)) > overshootThreshold
+
+def get_path(start: Dict, end: Dict) -> List[Dict]:
+    vectors = path(Vector(**start), Vector(**end))
+    return [el.__dict__ for el in vectors]