chore: formatting

Author: Mattwmaster58

CHANGELOG.md

@@ -1,14 +1,15 @@
 2.0.0
- - __breaking change__: more consistent naming all around
- - __breaking change__: Stealth object only takes kwargs now
- - new methods to hook context: Stealth.use_async and Stealth.use_sync
+
+- __breaking change__: more consistent naming all around
+- __breaking change__: Stealth object only takes kwargs now
+- new methods to hook context: Stealth.use_async and Stealth.use_sync
     - this allows us to patch CLI options as well, which are often better at faking than JS
- - chore: name options consistently
- - fix: scripts will not crash if in headful mode f9f84861
- - ft: use replaceProperty util which copies existing property descriptors 2b9b4b39
- - fix: remove deprecated pkg_resources usage (to support Python 3.12) (#2)
- - fix: navigator_platform typo (#1)
- - ft: better type hinted functions
- - ft: User-Agent and Sec-CH-UA spoofing
- - chore: remove chrome.run_on_unsecure_origins option (didn't see a purpose)
- - ft: sane navigator.platform default override
+- chore: name options consistently
+- fix: scripts will not crash if in headful mode f9f84861
+- ft: use replaceProperty util which copies existing property descriptors 2b9b4b39
+- fix: remove deprecated pkg_resources usage (to support Python 3.12) (#2)
+- fix: navigator_platform typo (#1)
+- ft: better type hinted functions
+- ft: User-Agent and Sec-CH-UA spoofing
+- chore: remove chrome.run_on_unsecure_origins option (didn't see a purpose)
+- ft: sane navigator.platform default override

README.md

@@ -1,24 +1,31 @@
 # playwright_stealth
 
-Fork of AtuboDad's port of [puppeteer-extra-plugin-stealth](https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth), with some improvements. Don't expect this to bypass anything but the simplest of bot detection methods. Consider this a proof-of-concept starting point.
+Fork of AtuboDad's port
+of [puppeteer-extra-plugin-stealth](https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth),
+with some improvements. Don't expect this to bypass anything but the simplest of bot detection methods. Consider this a
+proof-of-concept starting point.
 
-I've merged some of the outstanding PRs, added some features, and cleaned up the API surface. See the [changelog](./CHANGELOG.md). The latest major version includes breaking changes.
+I've merged some of the outstanding PRs, added some features, and cleaned up the API surface. See
+the [changelog](./CHANGELOG.md). The latest major version includes breaking changes.
 
 ## Install
 
 Install from PyPi:
+
 ```
 $ pip install playwright-stealth
 ```
 
 ## Example Usage
 
 ### Recommended Usage
+
 ```python
 import asyncio
 from playwright.async_api import async_playwright
 from playwright_stealth import Stealth
 
+
 async def main():
     # This is the recommended usage. All pages created will have stealth applied:
     async with Stealth().use_async(async_playwright()) as p:
@@ -27,39 +34,42 @@ async def main():
 
         webdriver_status = await page.evaluate("navigator.webdriver")
         print("from new_page: ", webdriver_status)
-        
+
         different_context = await browser.new_context()
         page_from_different_context = await different_context.new_page()
 
         different_context_status = await page_from_different_context.evaluate("navigator.webdriver")
         print("from new_context: ", different_context_status)
 
+
 asyncio.run(main())
 ```
 
 ### Specifying config options and applying evasions manually to an entire context
+
 ```python
 import asyncio
 from playwright.async_api import async_playwright
 from playwright_stealth import Stealth, ALL_EVASIONS_DISABLED_KWARGS
 
+
 async def advanced_example():
     # Custom configuration with specific languages
     custom_languages = ("fr-FR", "fr")
     stealth = Stealth(
         navigator_languages_override=custom_languages,
         init_scripts_only=True
     )
-    
+
     async with async_playwright() as p:
         browser = await p.chromium.launch()
         context = await browser.new_context()
         await stealth.apply_stealth_async(context)
-        
+
         # Test stealth on multiple pages
         page_1 = await context.new_page()
         page_2 = await context.new_page()
-        
+
         # Verify language settings
         for i, page in enumerate([page_1, page_2], 1):
             is_mocked = await page.evaluate("navigator.languages") == custom_languages
@@ -68,18 +78,21 @@ async def advanced_example():
     # Example of selective evasion usage
     no_evasions = Stealth(**ALL_EVASIONS_DISABLED_KWARGS)
     single_evasion = Stealth(**{**ALL_EVASIONS_DISABLED_KWARGS, "navigator_webdriver": True})
-    
+
     print("Total evasions (none):", len(no_evasions.script_payload))
     print("Total evasions (single):", len(single_evasion.script_payload))
 
+
 asyncio.run(advanced_example())
 ```
 
 ## Todo
- - make this work with playwright.launch_persistent_context
-   - the difficult because sometimes we sniff the UA if an override isn't provided, and this is difficult to do when launch_persistent_context is launched
- - sec-platform (we have navigator_platform)
- - docs
+
+- make this work with playwright.launch_persistent_context
+    - the difficult because sometimes we sniff the UA if an override isn't provided, and this is difficult to do when
+      launch_persistent_context is launched
+- sec-platform (we have navigator_platform)
+- docs
 
 ## A set of Test results
 

playwright_stealth/context_managers.py

@@ -9,7 +9,7 @@ def __init__(self, stealth: "Stealth", manager: async_api.PlaywrightContextManag
         self.manager = manager
 
     async def __aenter__(
-        self,
+            self,
     ) -> async_api.Playwright:
         context = await self.manager.__aenter__()
         self.stealth.hook_playwright_context(context)
@@ -27,7 +27,7 @@ def __init__(self, stealth: "Stealth", manager: sync_api.PlaywrightContextManage
         self.manager = manager
 
     def __enter__(
-        self,
+            self,
     ) -> sync_api.Playwright:
         context = self.manager.__enter__()
         self.stealth.hook_playwright_context(context)

playwright_stealth/js/evasions/chrome.app.js

@@ -7,7 +7,7 @@ if (!window.chrome) {
     writable: true,
     enumerable: true,
     configurable: false, // note!
-    value: {}, // We'll extend that later
+    value: {} // We'll extend that later
   });
 }
 
@@ -17,7 +17,7 @@ if (!("app" in window.chrome)) {
     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(
@@ -62,7 +62,7 @@ if (!("app" in window.chrome)) {
         throw makeError.ErrorInInvocation(`runningState`);
       }
       return "cannot_run";
-    },
+    }
   };
   utils.patchToStringNested(window.chrome.app);
 }

playwright_stealth/js/evasions/chrome.csi.js

@@ -7,7 +7,7 @@ if (!window.chrome) {
     writable: true,
     enumerable: true,
     configurable: false, // note!
-    value: {}, // We'll extend that later
+    value: {} // We'll extend that later
   });
 }
 
@@ -17,12 +17,12 @@ if (!("csi" in window.chrome) && window.performance?.timing) {
   const { csi_timing } = window.performance;
 
   log("loading chrome.csi.js");
-  window.chrome.csi = function () {
+  window.chrome.csi = function() {
     return {
       onloadT: csi_timing?.domContentLoadedEventEnd,
       startE: csi_timing?.navigationStart,
       pageT: Date.now() - csi_timing?.navigationStart,
-      tran: 15, // transition? seems constant
+      tran: 15 // transition? seems constant
     };
   };
   utils.patchToString(window.chrome.csi);

playwright_stealth/js/evasions/chrome.hairline.js

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

playwright_stealth/js/evasions/chrome.load.times.js

@@ -7,7 +7,7 @@ if (!window.chrome) {
     writable: true,
     enumerable: true,
     configurable: false, // note!
-    value: {}, // We'll extend that later
+    value: {} // We'll extend that later
   });
 }
 
@@ -24,23 +24,28 @@ if (window.performance?.timing || window.PerformancePaintTiming) {
   // let's harden the code to not fail then:
   const ntEntryFallback = {
     nextHopProtocol: "h2",
-    type: "other",
+    type: "other"
   };
 
   // The API exposes some funky info regarding the connection
   const protocolInfo = {
     get connectionInfo() {
-      const ntEntry = performance.getEntriesByType("navigation")[0] || ntEntryFallback;
+      const ntEntry = performance.getEntriesByType("navigation")[0] ||
+        ntEntryFallback;
       return ntEntry.nextHopProtocol;
     },
     get npnNegotiatedProtocol() {
       // NPN is deprecated in favor of ALPN, but this implementation returns the
       // HTTP/2 or HTTP2+QUIC/39 requests negotiated via ALPN.
-      const ntEntry = performance.getEntriesByType("navigation")[0] || ntEntryFallback;
-      return ["h2", "hq"].includes(ntEntry.nextHopProtocol) ? ntEntry.nextHopProtocol : "unknown";
+      const ntEntry = performance.getEntriesByType("navigation")[0] ||
+        ntEntryFallback;
+      return ["h2", "hq"].includes(ntEntry.nextHopProtocol) ?
+        ntEntry.nextHopProtocol :
+        "unknown";
     },
     get navigationType() {
-      const ntEntry = performance.getEntriesByType("navigation")[0] || ntEntryFallback;
+      const ntEntry = performance.getEntriesByType("navigation")[0] ||
+        ntEntryFallback;
       return ntEntry.type;
     },
     get wasAlternateProtocolAvailable() {
@@ -52,15 +57,17 @@ if (window.performance?.timing || window.PerformancePaintTiming) {
     get wasFetchedViaSpdy() {
       // SPDY is deprecated in favor of HTTP/2, but this implementation returns
       // true for HTTP/2 or HTTP2+QUIC/39 as well.
-      const ntEntry = performance.getEntriesByType("navigation")[0] || ntEntryFallback;
+      const ntEntry = performance.getEntriesByType("navigation")[0] ||
+        ntEntryFallback;
       return ["h2", "hq"].includes(ntEntry.nextHopProtocol);
     },
     get wasNpnNegotiated() {
       // NPN is deprecated in favor of ALPN, but this implementation returns true
       // for HTTP/2 or HTTP2+QUIC/39 requests negotiated via ALPN.
-      const ntEntry = performance.getEntriesByType("navigation")[0] || ntEntryFallback;
+      const ntEntry = performance.getEntriesByType("navigation")[0] ||
+        ntEntryFallback;
       return ["h2", "hq"].includes(ntEntry.nextHopProtocol);
-    },
+    }
   };
 
   const { timing } = window.performance;
@@ -93,16 +100,16 @@ if (window.performance?.timing || window.PerformancePaintTiming) {
     },
     get firstPaintTime() {
       const fpEntry = performance.getEntriesByType("paint")[0] || {
-        startTime: timing.loadEventEnd / 1000, // Fallback if no navigation occured (`about:blank`)
+        startTime: timing.loadEventEnd / 1000 // Fallback if no navigation occured (`about:blank`)
       };
       return toFixed((fpEntry.startTime + performance.timeOrigin) / 1000, 3);
-    },
+    }
   };
 
-  window.chrome.loadTimes = function () {
+  window.chrome.loadTimes = function() {
     return {
       ...protocolInfo,
-      ...timingInfo,
+      ...timingInfo
     };
   };
   utils.patchToString(window.chrome.loadTimes);