phantomwright 0.0.3__tar.gz

phantomwright-0.0.3/.gitignore

@@ -0,0 +1,106 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.idea/

phantomwright-0.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ASAS1314
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

phantomwright-0.0.3/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: phantomwright
+Version: 0.0.3
+Summary: Compose patchright + stealth JS + user behavior simulation + more extending
+Project-URL: homepage, https://github.com/ai-microsoft/phantom-wright
+Project-URL: changelog, https://github.com/ai-microsoft/phantom-wright/blob/main/CHANGELOG.md
+Author-email: Hang Yin <hangyin@microsoft.com>, Daniel Wan <benyuwan@microsoft.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: patchright==1.56.0
+Provides-Extra: black
+Requires-Dist: black>=25.9.0; extra == 'black'
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=1.2.0; extra == 'dev'
+Requires-Dist: pytest>=8.4.2; extra == 'dev'
+Description-Content-Type: text/markdown
+
+## Introduction
+
+Phantomwright is a library combining [patchright](https://pypi.org/project/patchright/) and [playwright-stealth](https://pypi.org/project/playwright-stealth/), we aim to:
+ + Wrap & Re-export API from patchright, provide basic stealth ability
+ + Provide the ability to extend playwright, thus you can use API to:
+    + Enable stealth injection script
+    + Do user simulation
++ (TODO) Setup the ability to add breakpoint into playwright-core and playwright-python
++ (TODO) More extending API support for recaptcha resolver, proxy management etc.
+
+### Initialization & Unit Test
+
+```shell
+    uv venv
+    .venv\Scripts\activate
+    uv sync --extra dev
+    uv run patchright install-deps
+    uv run patchright install
+    uv run pytest
+```
+
+### Clear VENV Installation
+
+```shell
+    uv venv --clear
+```
+
+### Thanks
+
++ [patchright](https://pypi.org/project/patchright/) 
++ [playwright-stealth](https://pypi.org/project/playwright-stealth/)

phantomwright-0.0.3/README.md

@@ -0,0 +1,31 @@
+## Introduction
+
+Phantomwright is a library combining [patchright](https://pypi.org/project/patchright/) and [playwright-stealth](https://pypi.org/project/playwright-stealth/), we aim to:
+ + Wrap & Re-export API from patchright, provide basic stealth ability
+ + Provide the ability to extend playwright, thus you can use API to:
+    + Enable stealth injection script
+    + Do user simulation
++ (TODO) Setup the ability to add breakpoint into playwright-core and playwright-python
++ (TODO) More extending API support for recaptcha resolver, proxy management etc.
+
+### Initialization & Unit Test
+
+```shell
+    uv venv
+    .venv\Scripts\activate
+    uv sync --extra dev
+    uv run patchright install-deps
+    uv run patchright install
+    uv run pytest
+```
+
+### Clear VENV Installation
+
+```shell
+    uv venv --clear
+```
+
+### Thanks
+
++ [patchright](https://pypi.org/project/patchright/) 
++ [playwright-stealth](https://pypi.org/project/playwright-stealth/)

phantomwright-0.0.3/phantomwright/__init__.py

@@ -0,0 +1,5 @@
+"""
+Patchright + Stealth Plugin + User Behavior Simulation = PhantomWright
+"""
+
+__version__ = "0.0.3"

phantomwright-0.0.3/phantomwright/_impl/_user_sim/_mouse_move_sim.py

@@ -0,0 +1,36 @@
+import random
+import logging
+import asyncio
+
+logger = logging.getLogger(__name__)
+
+async def async_mouse_move(page):
+    try:
+        await asyncio.sleep(random.uniform(0.5, 1.5))
+        viewport = page.viewport_size
+        if not viewport:
+            return
+        width, height = viewport['width'], viewport['height']
+        for _ in range(random.randint(3, 7)):
+            x = random.randint(100, width - 100)
+            y = random.randint(100, height - 100)
+            await page.mouse.move(x, y)
+            await asyncio.sleep(random.uniform(0.1, 0.3))
+    except Exception as e:
+        logger.error(f"Error simulating user activity: {e}")
+
+def sync_mouse_move(page):
+    try:
+        import time
+        time.sleep(random.uniform(0.5, 1.5))
+        viewport = page.viewport_size
+        if not viewport:
+            return
+        width, height = viewport['width'], viewport['height']
+        for _ in range(random.randint(3, 7)):
+            x = random.randint(100, width - 100)
+            y = random.randint(100, height - 100)
+            page.mouse.move(x, y)
+            time.sleep(random.uniform(0.1, 0.3))
+    except Exception as e:
+        logger.error(f"Error simulating user activity: {e}")

phantomwright-0.0.3/phantomwright/_impl/_user_sim/_mouse_wheel_sim.py

@@ -0,0 +1,18 @@
+import random
+import logging
+
+logger = logging.getLogger(__name__)
+
+async def async_mouse_wheel(page):
+    try:
+        scroll_amount = random.randint(100, 300)
+        await page.mouse.wheel(0, scroll_amount)
+    except Exception as e:
+        logger.error(f"Error simulating mouse wheel activity: {e}")
+
+def sync_mouse_wheel(page):
+    try:
+        scroll_amount = random.randint(100, 300)
+        page.mouse.wheel(0, scroll_amount)
+    except Exception as e:
+        logger.error(f"Error simulating mouse wheel activity: {e}")

phantomwright-0.0.3/phantomwright/async_api/__init__.py

@@ -0,0 +1,55 @@
+from patchright.async_api import expect, async_playwright, Accessibility, APIRequest, APIRequestContext, APIResponse, Browser, BrowserContext, BrowserType, CDPSession, ChromiumBrowserContext, ConsoleMessage, Cookie, Dialog, Download, ElementHandle, Error, FileChooser, FilePayload, FloatRect, Frame, FrameLocator, Geolocation, HttpCredentials, JSHandle, Keyboard, Locator, Mouse, Page, PdfMargins, Position, Playwright, ProxySettings, Request, ResourceTiming, Response, Route, Selectors, SourceLocation, StorageState, StorageStateCookie, TimeoutError, Touchscreen, Video, ViewportSize, WebError, WebSocket, WebSocketRoute, Worker
+from ._patch_goto import *
+from ._patch_evaluate import *
+
+__all__ = [
+    "expect",
+    "async_playwright",
+    "Accessibility",
+    "APIRequest",
+    "APIRequestContext",
+    "APIResponse",
+    "Browser",
+    "BrowserContext",
+    "BrowserType",
+    "CDPSession",
+    "ChromiumBrowserContext",
+    "ConsoleMessage",
+    "Cookie",
+    "Dialog",
+    "Download",
+    "ElementHandle",
+    "Error",
+    "FileChooser",
+    "FilePayload",
+    "FloatRect",
+    "Frame",
+    "FrameLocator",
+    "Geolocation",
+    "HttpCredentials",
+    "JSHandle",
+    "Keyboard",
+    "Locator",
+    "Mouse",
+    "Page",
+    "PdfMargins",
+    "Position",
+    "Playwright",
+    "ProxySettings",
+    "Request",
+    "ResourceTiming",
+    "Response",
+    "Route",
+    "Selectors",
+    "SourceLocation",
+    "StorageState",
+    "StorageStateCookie",
+    "TimeoutError",
+    "Touchscreen",
+    "Video",
+    "ViewportSize",
+    "WebError",
+    "WebSocket",
+    "WebSocketRoute",
+    "Worker",
+]

phantomwright-0.0.3/phantomwright/async_api/_patch_evaluate.py

@@ -0,0 +1,26 @@
+from functools import wraps
+from patchright.async_api import Page
+
+_original_evaluate = Page.evaluate
+
+
+@wraps(_original_evaluate)
+async def _hooked_evaluate(self, *args, **kwargs):
+    # Ensure isolated_context defaults to False if not provided
+    kwargs.setdefault("isolated_context", False)
+    return await _original_evaluate(self, *args, **kwargs)
+
+
+Page.evaluate = _hooked_evaluate
+
+_original_evaluate_handle = Page.evaluate_handle
+
+
+@wraps(_original_evaluate_handle)
+async def _hooked_evaluate_handle(self, *args, **kwargs):
+    # Ensure isolated_context defaults to False if not provided
+    kwargs.setdefault("isolated_context", False)
+    return await _original_evaluate_handle(self, *args, **kwargs)
+
+
+Page.evaluate_handle = _hooked_evaluate_handle

phantomwright-0.0.3/phantomwright/async_api/_patch_goto.py

@@ -0,0 +1,35 @@
+import asyncio
+from functools import wraps
+import logging
+import random
+from patchright.async_api import Page
+from phantomwright._impl._user_sim._mouse_move_sim import async_mouse_move
+from phantomwright._impl._user_sim._mouse_wheel_sim import async_mouse_wheel
+
+logger = logging.getLogger(__name__)
+
+
+async def _user_sim_hook(self, *args, **kwargs):
+    url = kwargs.get("url")
+    if url is None and args:
+        url = args[0]
+    logger.info(f"Navigating to {url} (async)")
+    await async_mouse_move(self)
+    await asyncio.sleep(random.uniform(0.1, 0.3))
+    await async_mouse_wheel(self)
+
+
+if not hasattr(Page.goto, "_pre_hooks"):
+    _original_goto = Page.goto
+
+    @wraps(_original_goto)
+    async def _hooked_goto(self, *args, **kwargs):
+        for hook in _hooked_goto._pre_hooks:
+            await hook(self, *args, **kwargs)
+        return await _original_goto(self, *args, **kwargs)
+
+    _hooked_goto._pre_hooks = []
+    Page.goto = _hooked_goto
+
+if _user_sim_hook not in Page.goto._pre_hooks:
+    Page.goto._pre_hooks.append(_user_sim_hook)

phantomwright-0.0.3/phantomwright/stealth/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+from .stealth import Stealth, ALL_EVASIONS_DISABLED_KWARGS

phantomwright-0.0.3/phantomwright/stealth/case_insensitive_dict.py

@@ -0,0 +1,77 @@
+from collections.abc import MutableMapping
+
+
+# straight from: https://github.com/kennethreitz/requests/blob/master/src/requests/structures.py
+class CaseInsensitiveDict(MutableMapping):
+    """A case-insensitive ``dict``-like object.
+
+    Implements all methods and operations of
+    ``MutableMapping`` as well as dict's ``copy``. Also
+    provides ``lower_items``.
+
+    All keys are expected to be strings. The structure remembers the
+    case of the last key to be set, and ``iter(instance)``,
+    ``keys()``, ``items()``, ``iterkeys()``, and ``iteritems()``
+    will contain case-sensitive keys. However, querying and contains
+    testing is case insensitive::
+
+        cid = CaseInsensitiveDict()
+        cid['Accept'] = 'application/json'
+        cid['aCCEPT'] == 'application/json'  # True
+        list(cid) == ['Accept']  # True
+
+    For example, ``headers['content-encoding']`` will return the
+    value of a ``'Content-Encoding'`` response header, regardless
+    of how the header name was originally stored.
+
+    If the constructor, ``.update``, or equality comparison
+    operations are given keys that have equal ``.lower()``s, the
+    behavior is undefined.
+    """
+
+    def __init__(self, data=None, **kwargs):
+        self._store = {}
+        if data is None:
+            data = {}
+        self.update(data, **kwargs)
+
+    def __setitem__(self, key, value):
+        # Use the lowercased key for lookups, but store the actual
+        # key alongside the value.
+        self._store[key.lower()] = (key, value)
+
+    def __getitem__(self, key):
+        return self._store[key.lower()][1]
+
+    def __delitem__(self, key):
+        del self._store[key.lower()]
+
+    def __iter__(self):
+        return (casedkey for casedkey, mappedvalue in self._store.values())
+
+    def __len__(self):
+        return len(self._store)
+
+    def lower_items(self):
+        """Like iteritems(), but with all lowercase keys."""
+        return ((lowerkey, keyval[1]) for (lowerkey, keyval) in self._store.items())
+
+    def __eq__(self, other):
+        from collections.abc import Mapping
+
+        if isinstance(other, Mapping):
+            other = CaseInsensitiveDict(other)
+        else:
+            return NotImplemented
+        # Compare insensitively
+        return dict(self.lower_items()) == dict(other.lower_items())
+
+    # Copy is required
+    def copy(self):
+        return CaseInsensitiveDict(self._store.values())
+
+    def __repr__(self):
+        return str(dict(self.items()))
+
+    def items(self):
+        pass

phantomwright-0.0.3/phantomwright/stealth/context_managers.py

@@ -0,0 +1,37 @@
+from patchright import async_api, sync_api
+
+
+class AsyncWrappingContextManager:
+    def __init__(self, stealth: "Stealth", manager: async_api.PlaywrightContextManager):
+        if isinstance(manager, sync_api.PlaywrightContextManager):
+            raise TypeError("You need to call 'use_sync' instead of 'use_async' for a sync Playwright context")
+        self.stealth = stealth
+        self.manager = manager
+
+    async def __aenter__(
+        self,
+    ) -> async_api.Playwright:
+        context = await self.manager.__aenter__()
+        self.stealth.hook_playwright_context(context)
+        return context
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
+        await self.manager.__aexit__(exc_type, exc_val, exc_tb)
+
+
+class SyncWrappingContextManager:
+    def __init__(self, stealth: "Stealth", manager: sync_api.PlaywrightContextManager):
+        if isinstance(manager, async_api.PlaywrightContextManager):
+            raise TypeError("You need to call 'use_async' instead of 'use_sync' for an async Playwright context")
+        self.stealth = stealth
+        self.manager = manager
+
+    def __enter__(
+        self,
+    ) -> sync_api.Playwright:
+        context = self.manager.__enter__()
+        self.stealth.hook_playwright_context(context)
+        return context
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        self.manager.__exit__(exc_type, exc_val, exc_tb)

phantomwright-0.0.3/phantomwright/stealth/js/evasions/chrome.app.js

@@ -0,0 +1,68 @@
+log("loading chrome.app.js");
+
+if (!window.chrome) {
+  // Use the exact property descriptor found in headful Chrome
+  // fetch it via `Object.getOwnPropertyDescriptor(window, 'chrome')`
+  Object.defineProperty(window, "chrome", {
+    writable: true,
+    enumerable: true,
+    configurable: false, // note!
+    value: {} // We'll extend that later
+  });
+}
+
+// app in window.chrome means we're running headful and don't need to mock anything
+if (!("app" in window.chrome)) {
+  const makeError = {
+    ErrorInInvocation: (fn) => {
+      const err = new TypeError(`Error in invocation of app.${fn}()`);
+      return utils.stripErrorWithAnchor(err, `at ${fn} (eval at <anonymous>`);
+    }
+  };
+
+  const APP_STATIC_DATA = JSON.parse(
+    `
+{
+  "isInstalled": false,
+  "InstallState": {
+    "DISABLED": "disabled",
+    "INSTALLED": "installed",
+    "NOT_INSTALLED": "not_installed"
+  },
+  "RunningState": {
+    "CANNOT_RUN": "cannot_run",
+    "READY_TO_RUN": "ready_to_run",
+    "RUNNING": "running"
+  }
+}
+        `.trim()
+  );
+
+  window.chrome.app = {
+    ...APP_STATIC_DATA,
+
+    get isInstalled() {
+      return false;
+    },
+
+    getDetails: function getDetails() {
+      if (arguments.length) {
+        throw makeError.ErrorInInvocation(`getDetails`);
+      }
+      return null;
+    },
+    getIsInstalled: function getDetails() {
+      if (arguments.length) {
+        throw makeError.ErrorInInvocation(`getIsInstalled`);
+      }
+      return false;
+    },
+    runningState: function getDetails() {
+      if (arguments.length) {
+        throw makeError.ErrorInInvocation(`runningState`);
+      }
+      return "cannot_run";
+    }
+  };
+  utils.patchToStringNested(window.chrome.app);
+}

phantomwright-0.0.3/phantomwright/stealth/js/evasions/chrome.csi.js

@@ -0,0 +1,29 @@
+log("loading chrome.csi.js");
+
+if (!window.chrome) {
+  // Use the exact property descriptor found in headful Chrome
+  // fetch it via `Object.getOwnPropertyDescriptor(window, 'chrome')`
+  Object.defineProperty(window, "chrome", {
+    writable: true,
+    enumerable: true,
+    configurable: false, // note!
+    value: {} // We'll extend that later
+  });
+}
+
+// Check if we're running headful and don't need to mock anything
+// Check that the Navigation Timing API v1 is available, we need that
+if (!("csi" in window.chrome) && window.performance?.timing) {
+  const { csi_timing } = window.performance;
+
+  log("loading chrome.csi.js");
+  window.chrome.csi = function() {
+    return {
+      onloadT: csi_timing?.domContentLoadedEventEnd,
+      startE: csi_timing?.navigationStart,
+      pageT: Date.now() - csi_timing?.navigationStart,
+      tran: 15 // transition? seems constant
+    };
+  };
+  utils.patchToString(window.chrome.csi);
+}

phantomwright-0.0.3/phantomwright/stealth/js/evasions/chrome.hairline.js

@@ -0,0 +1,14 @@
+log("loading chrome.hairline.js");
+// inspired by: https://intoli.com/blog/making-chrome-headless-undetectable/
+const elementDescriptor = Object.getOwnPropertyDescriptor(HTMLElement.prototype,
+  "offsetHeight");
+
+utils.replaceProperty(HTMLDivElement.prototype, "offsetHeight", {
+  get: function() {
+    // hmmm not sure about this
+    if (this.id === "modernizr") {
+      return 1;
+    }
+    return elementDescriptor.get.apply(this);
+  }
+});