seleniumbase 4.24.11__py3-none-any.whl → 4.33.15__py3-none-any.whl

seleniumbase/plugins/driver_manager.py

@@ -7,7 +7,7 @@ Usage --> ``with DriverContext() as driver:``
 
 Example -->
 
-```
+```python
 from seleniumbase import DriverContext
 
 with DriverContext() as driver:
@@ -27,7 +27,7 @@ Usage --> ``driver = Driver()``
 
 Example -->
 
-```
+```python
 from seleniumbase import Driver
 
 driver = Driver()
@@ -36,6 +36,7 @@ driver.get("https://google.com/ncr")
 
 ###########################################################################
 """
+import os
 import sys
 
 
@@ -64,8 +65,9 @@ class DriverContext():
 
 def Driver(
     browser=None,  # Choose from "chrome", "edge", "firefox", or "safari".
-    headless=None,  # The original headless mode for Chromium and Firefox.
-    headless2=None,  # Chromium's new headless mode. (Has more features)
+    headless=None,  # Use the default headless mode for Chromium and Firefox.
+    headless1=None,  # Use Chromium's old headless mode. (Fast, but limited)
+    headless2=None,  # Use Chromium's new headless mode. (Has more features)
     headed=None,  # Run tests in headed/GUI mode on Linux, where not default.
     locale_code=None,  # Set the Language Locale Code for the web browser.
     protocol=None,  # The Selenium Grid protocol: "http" or "https".
@@ -74,12 +76,13 @@ def Driver(
     proxy=None,  # Use proxy. Format: "SERVER:PORT" or "USER:PASS@SERVER:PORT".
     proxy_bypass_list=None,  # Skip proxy when using the listed domains.
     proxy_pac_url=None,  # Use PAC file. (Format: URL or USERNAME:PASSWORD@URL)
-    multi_proxy=False,  # Allow multiple proxies with auth when multi-threaded.
+    multi_proxy=None,  # Allow multiple proxies with auth when multi-threaded.
     agent=None,  # Modify the web browser's User-Agent string.
     cap_file=None,  # The desired capabilities to use with a Selenium Grid.
     cap_string=None,  # The desired capabilities to use with a Selenium Grid.
     recorder_ext=None,  # Enables the SeleniumBase Recorder Chromium extension.
-    disable_js=None,  # Disable JavaScript on websites. Pages might break!
+    disable_cookies=None,  # Disable Cookies on websites. (Pages might break!)
+    disable_js=None,  # Disable JavaScript on websites. (Pages might break!)
     disable_csp=None,  # Disable the Content Security Policy of websites.
     enable_ws=None,  # Enable Web Security on Chromium-based browsers.
     disable_ws=None,  # Reverse of "enable_ws". (None and False are different)
@@ -114,20 +117,125 @@ def Driver(
     page_load_strategy=None,  # Set Chrome PLS to "normal", "eager", or "none".
     use_wire=None,  # Use selenium-wire's webdriver over selenium webdriver.
     external_pdf=None,  # Set Chrome "plugins.always_open_pdf_externally":True.
+    window_position=None,  # Set the browser's starting window position: "X,Y"
+    window_size=None,  # Set the browser's starting window size: "Width,Height"
     is_mobile=None,  # Use the mobile device emulator while running tests.
     mobile=None,  # Shortcut / Duplicate of "is_mobile".
     d_width=None,  # Set device width
     d_height=None,  # Set device height
     d_p_r=None,  # Set device pixel ratio
+    position=None,  # Shortcut / Duplicate of "window_position".
+    size=None,  # Shortcut / Duplicate of "window_size".
     uc=None,  # Shortcut / Duplicate of "undetectable".
     undetected=None,  # Shortcut / Duplicate of "undetectable".
     uc_cdp=None,  # Shortcut / Duplicate of "uc_cdp_events".
     uc_sub=None,  # Shortcut / Duplicate of "uc_subprocess".
+    locale=None,  # Shortcut / Duplicate of "locale_code".
     log_cdp=None,  # Shortcut / Duplicate of "log_cdp_events".
+    ad_block=None,  # Shortcut / Duplicate of "ad_block_on".
+    server=None,  # Shortcut / Duplicate of "servername".
+    guest=None,  # Shortcut / Duplicate of "guest_mode".
     wire=None,  # Shortcut / Duplicate of "use_wire".
     pls=None,  # Shortcut / Duplicate of "page_load_strategy".
 ):
+    """
+    * SeleniumBase Driver as a Python Context Manager or a returnable object. *
+
+    Example 1: (context manager format)
+    -----------------------------------
+    .. code-block:: python
+        from seleniumbase import DriverContext
+
+        with DriverContext() as driver:
+            driver.get("https://google.com/ncr")
+
+    Example 2: (as a Python returnable)
+    -----------------------------------
+    .. code-block:: python
+        from seleniumbase import Driver
+
+        driver = Driver()
+        driver.get("https://google.com/ncr")
+
+    Optional Parameters:
+    --------------------
+    browser (str):  Choose from "chrome", "edge", "firefox", or "safari".
+    headless (bool):  Use the default headless mode for Chromium and Firefox.
+    headless1 (bool):  Use Chromium's old headless mode. (Fast, but limited)
+    headless2 (bool):  Use Chromium's new headless mode. (Has more features)
+    headed (bool):  Run tests in headed/GUI mode on Linux, where not default.
+    locale_code (str):  Set the Language Locale Code for the web browser.
+    protocol (str):  The Selenium Grid protocol: "http" or "https".
+    servername (str):  The Selenium Grid server/IP used for tests.
+    port (int):  The Selenium Grid port used by the test server.
+    proxy (str):  Use proxy. Format: "SERVER:PORT" or "USER:PASS@SERVER:PORT".
+    proxy_bypass_list (str):  Skip proxy when using the listed domains.
+    proxy_pac_url (str):  Use PAC file. (Format: URL or USERNAME:PASSWORD@URL)
+    multi_proxy (bool):  Allow multiple proxies with auth when multi-threaded.
+    agent (str):  Modify the web browser's User-Agent string.
+    cap_file (str):  The desired capabilities to use with a Selenium Grid.
+    cap_string (str):  The desired capabilities to use with a Selenium Grid.
+    recorder_ext (bool):  Enables the SeleniumBase Recorder Chromium extension.
+    disable_cookies (bool):  Disable Cookies on websites. (Pages might break!)
+    disable_js (bool):  Disable JavaScript on websites. (Pages might break!)
+    disable_csp (bool):  Disable the Content Security Policy of websites.
+    enable_ws (bool):  Enable Web Security on Chromium-based browsers.
+    disable_ws (bool):  Reverse of "enable_ws". (None and False are different)
+    enable_sync (bool):  Enable "Chrome Sync" on websites.
+    use_auto_ext (bool):  Use Chrome's automation extension.
+    undetectable (bool):  Use undetected-chromedriver to evade bot-detection.
+    uc_cdp_events (bool):  Capture CDP events in undetected-chromedriver mode.
+    uc_subprocess (bool):  Use undetected-chromedriver as a subprocess.
+    log_cdp_events (bool):  Capture {"performance": "ALL", "browser": "ALL"}
+    no_sandbox (bool):  (DEPRECATED) - "--no-sandbox" is always used now.
+    disable_gpu (bool):  (DEPRECATED) - GPU is disabled if not "swiftshader".
+    incognito (bool):  Enable Chromium's Incognito mode.
+    guest_mode (bool):  Enable Chromium's Guest mode.
+    dark_mode (bool):  Enable Chromium's Dark mode.
+    devtools (bool):  Open Chromium's DevTools when the browser opens.
+    remote_debug (bool):  Enable Chrome's Debugger on "http://localhost:9222".
+    enable_3d_apis (bool):  Enable WebGL and 3D APIs.
+    swiftshader (bool):  Chrome: --use-gl=angle / --use-angle=swiftshader-webgl
+    ad_block_on (bool):  Block some types of display ads from loading.
+    host_resolver_rules (str):  Set host-resolver-rules, comma-separated.
+    block_images (bool):  Block images from loading during tests.
+    do_not_track (bool):  Tell websites that you don't want to be tracked.
+    chromium_arg (str):  "ARG=N,ARG2" (Set Chromium args, ","-separated.)
+    firefox_arg (str):  "ARG=N,ARG2" (Set Firefox args, comma-separated.)
+    firefox_pref (str):  SET (Set Firefox PREFERENCE:VALUE set, ","-separated)
+    user_data_dir (str):  Set the Chrome user data directory to use.
+    extension_zip (str):  Load a Chrome Extension .zip|.crx, comma-separated.
+    extension_dir (str):  Load a Chrome Extension directory, comma-separated.
+    disable_features (str):  "F1,F2" (Disable Chrome features, ","-separated.)
+    binary_location (str):  Set path of the Chromium browser binary to use.
+    driver_version (str):  Set the chromedriver or uc_driver version to use.
+    page_load_strategy (str):  Set Chrome PLS to "normal", "eager", or "none".
+    use_wire (bool):  Use selenium-wire's webdriver over selenium webdriver.
+    external_pdf (bool):  Set Chrome "plugins.always_open_pdf_externally":True
+    window_position (x,y):  Set the browser's starting window position: "X,Y"
+    window_size (w,h):  Set the browser's starting window size: "Width,Height"
+    is_mobile (bool):  Use the mobile device emulator while running tests.
+    mobile (bool):  Shortcut / Duplicate of "is_mobile".
+    d_width (int):  Set device width
+    d_height (int):  Set device height
+    d_p_r (float):  Set device pixel ratio
+    position (x,y):  Shortcut / Duplicate of "window_position".
+    size (w,h):  Shortcut / Duplicate of "window_size".
+    uc (bool):  Shortcut / Duplicate of "undetectable".
+    undetected (bool):  Shortcut / Duplicate of "undetectable".
+    uc_cdp (bool):  Shortcut / Duplicate of "uc_cdp_events".
+    uc_sub (bool):  Shortcut / Duplicate of "uc_subprocess".
+    locale (str):  Shortcut / Duplicate of "locale_code".
+    log_cdp (bool):  Shortcut / Duplicate of "log_cdp_events".
+    ad_block (bool):  Shortcut / Duplicate of "ad_block_on".
+    server (str):  Shortcut / Duplicate of "servername".
+    guest (bool):  Shortcut / Duplicate of "guest_mode".
+    wire (bool):  Shortcut / Duplicate of "use_wire".
+    pls (str):  Shortcut / Duplicate of "page_load_strategy".
+    """
     from seleniumbase import config as sb_config
+    from seleniumbase.config import settings
+    from seleniumbase.core import browser_launcher
     from seleniumbase.fixtures import constants
     from seleniumbase.fixtures import shared_utils
 
@@ -239,6 +347,13 @@ def Driver(
             headless = True
         else:
             headless = False
+    if headless1 is None:
+        if "--headless1" in sys_argv:
+            headless1 = True
+        else:
+            headless1 = False
+    if headless1:
+        headless = True
     if headless2 is None:
         if "--headless2" in sys_argv:
             headless2 = True
@@ -246,6 +361,8 @@ def Driver(
             headless2 = False
     if protocol is None:
         protocol = "http"  # For the Selenium Grid only!
+    if server is not None and servername is None:
+        servername = server
     if servername is None:
         servername = "localhost"  # For the Selenium Grid only!
     use_grid = False
@@ -259,6 +376,8 @@ def Driver(
             incognito = True
         else:
             incognito = False
+    if guest is not None and guest_mode is None:
+        guest_mode = guest
     if guest_mode is None:
         if "--guest" in sys_argv:
             guest_mode = True
@@ -295,28 +414,121 @@ def Driver(
                 proxy_string = proxy_string[1:-1]
     c_a = chromium_arg
     if c_a is None and "--chromium-arg" in arg_join:
-        if "--chromium-arg=" in arg_join:
-            c_a = arg_join.split("--chromium-arg=")[1].split(" ")[0]
-        elif "--chromium-arg " in arg_join:
-            c_a = arg_join.split("--chromium-arg ")[1].split(" ")[0]
-        if c_a:
-            if c_a.startswith('"') and c_a.endswith('"'):
-                c_a = c_a[1:-1]
-            elif c_a.startswith("'") and c_a.endswith("'"):
-                c_a = c_a[1:-1]
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--chromium-arg="):
+                c_a = arg.split("--chromium-arg=")[1]
+                break
+            elif arg == "--chromium-arg" and len(sys_argv) > count + 1:
+                c_a = sys_argv[count + 1]
+                if c_a.startswith("-"):
+                    c_a = None
+                break
+            count += 1
     chromium_arg = c_a
     d_f = disable_features
     if d_f is None and "--disable-features" in arg_join:
-        if "--disable-features=" in arg_join:
-            d_f = arg_join.split("--disable-features=")[1].split(" ")[0]
-        elif "--disable-features " in arg_join:
-            d_f = arg_join.split("--disable-features ")[1].split(" ")[0]
-        if d_f:
-            if d_f.startswith('"') and d_f.endswith('"'):
-                d_f = d_f[1:-1]
-            elif c_a.startswith("'") and d_f.endswith("'"):
-                d_f = d_f[1:-1]
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--disable-features="):
+                d_f = arg.split("--disable-features=")[1]
+                break
+            elif arg == "--disable-features" and len(sys_argv) > count + 1:
+                d_f = sys_argv[count + 1]
+                if d_f.startswith("-"):
+                    d_f = None
+                break
+            count += 1
     disable_features = d_f
+    if window_position is None and position is not None:
+        window_position = position
+    w_p = window_position
+    if w_p is None and "--window-position" in arg_join:
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--window-position="):
+                w_p = arg.split("--window-position=")[1]
+                break
+            elif arg == "--window-position" and len(sys_argv) > count + 1:
+                w_p = sys_argv[count + 1]
+                if w_p.startswith("-"):
+                    w_p = None
+                break
+            count += 1
+    window_position = w_p
+    if window_position:
+        if window_position.count(",") != 1:
+            message = (
+                '\n\n  window_position expects an "x,y" string!'
+                '\n  (Your input was: "%s")\n' % window_position
+            )
+            raise Exception(message)
+        window_position = window_position.replace(" ", "")
+        win_x = None
+        win_y = None
+        try:
+            win_x = int(window_position.split(",")[0])
+            win_y = int(window_position.split(",")[1])
+        except Exception:
+            message = (
+                '\n\n  Expecting integer values for "x,y"!'
+                '\n  (window_position input was: "%s")\n'
+                % window_position
+            )
+            raise Exception(message)
+        settings.WINDOW_START_X = win_x
+        settings.WINDOW_START_Y = win_y
+    if window_size is None and size is not None:
+        window_size = size
+    w_s = window_size
+    if w_s is None and "--window-size" in arg_join:
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--window-size="):
+                w_s = arg.split("--window-size=")[1]
+                break
+            elif arg == "--window-size" and len(sys_argv) > count + 1:
+                w_s = sys_argv[count + 1]
+                if w_s.startswith("-"):
+                    w_s = None
+                break
+            count += 1
+    window_size = w_s
+    if window_size:
+        if window_size.count(",") != 1:
+            message = (
+                '\n\n  window_size expects a "width,height" string!'
+                '\n  (Your input was: "%s")\n' % window_size
+            )
+            raise Exception(message)
+        window_size = window_size.replace(" ", "")
+        width = None
+        height = None
+        try:
+            width = int(window_size.split(",")[0])
+            height = int(window_size.split(",")[1])
+        except Exception:
+            message = (
+                '\n\n  Expecting integer values for "width,height"!'
+                '\n  (window_size input was: "%s")\n' % window_size
+            )
+            raise Exception(message)
+        settings.CHROME_START_WIDTH = width
+        settings.CHROME_START_HEIGHT = height
+        settings.HEADLESS_START_WIDTH = width
+        settings.HEADLESS_START_HEIGHT = height
+    if agent is None and "--agent" in arg_join:
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--agent="):
+                agent = arg.split("--agent=")[1]
+                break
+            elif arg == "--agent" and len(sys_argv) > count + 1:
+                agent = sys_argv[count + 1]
+                if agent.startswith("-"):
+                    agent = None
+                break
+            count += 1
     user_agent = agent
     recorder_mode = False
     if recorder_ext:
@@ -328,31 +540,6 @@ def Driver(
     ):
         recorder_mode = True
         recorder_ext = True
-    if (
-        shared_utils.is_linux()
-        and not headed
-        and not headless
-        and not headless2
-    ):
-        headless = True
-    if recorder_mode and headless:
-        headless = False
-        headless2 = True
-    if headless2 and browser == "firefox":
-        headless2 = False  # Only for Chromium browsers
-        headless = True  # Firefox has regular headless
-    elif browser not in ["chrome", "edge"]:
-        headless2 = False  # Only for Chromium browsers
-    if disable_csp is None:
-        disable_csp = False
-    if (
-        (enable_ws is None and disable_ws is None)
-        or (disable_ws is not None and not disable_ws)
-        or (enable_ws is not None and enable_ws)
-    ):
-        enable_ws = True
-    else:
-        enable_ws = False
     if (
         undetectable
         or undetected
@@ -363,11 +550,7 @@ def Driver(
         or uc_sub
     ):
         undetectable = True
-    if (
-        (undetectable or undetected or uc)
-        and (uc_subprocess is None)
-        and (uc_sub is None)
-    ):
+    if undetectable or undetected or uc:
         uc_subprocess = True  # Use UC as a subprocess by default.
     elif (
         "--undetectable" in sys_argv
@@ -408,6 +591,67 @@ def Driver(
         uc_cdp_events = True
     else:
         uc_cdp_events = False
+    if undetectable and browser != "chrome":
+        message = (
+            '\n  Undetected-Chromedriver Mode ONLY supports Chrome!'
+            '\n  ("uc=True" / "undetectable=True" / "--uc")'
+            '\n  (Your browser choice was: "%s".)'
+            '\n  (Will use "%s" without UC Mode.)\n' % (browser, browser)
+        )
+        print(message)
+    if headed is None:
+        # Override the default headless mode on Linux if set.
+        if "--gui" in sys_argv or "--headed" in sys_argv:
+            headed = True
+        else:
+            headed = False
+    if (
+        shared_utils.is_linux()
+        and not headed
+        and not headless
+        and not headless2
+        and (
+            not undetectable
+            or "DISPLAY" not in os.environ.keys()
+            or not os.environ["DISPLAY"]
+        )
+    ):
+        headless = True
+    if recorder_mode and headless:
+        headless = False
+        headless1 = False
+        headless2 = True
+    if headless2 and browser == "firefox":
+        headless2 = False  # Only for Chromium browsers
+        headless = True  # Firefox has regular headless
+    elif browser not in ["chrome", "edge"]:
+        headless2 = False  # Only for Chromium browsers
+    if disable_csp is None:
+        if (
+            "--disable-csp" in sys_argv
+            or "--no-csp" in sys_argv
+            or "--dcsp" in sys_argv
+        ):
+            disable_csp = True
+        else:
+            disable_csp = False
+    if (
+        (enable_ws is None and disable_ws is None)
+        and (
+            "--disable-web-security" in sys_argv
+            or "--disable-ws" in sys_argv
+            or "--dws" in sys_argv
+        )
+    ):
+        enable_ws = False
+    elif (
+        (enable_ws is None and disable_ws is None)
+        or (disable_ws is not None and not disable_ws)
+        or (enable_ws is not None and enable_ws)
+    ):
+        enable_ws = True
+    else:
+        enable_ws = False
     if log_cdp_events is None and log_cdp is None:
         if (
             "--log-cdp-events" in sys_argv
@@ -427,6 +671,11 @@ def Driver(
             use_auto_ext = True
         else:
             use_auto_ext = False
+    if disable_cookies is None:
+        if "--disable-cookies" in sys_argv:
+            disable_cookies = True
+        else:
+            disable_cookies = False
     if disable_js is None:
         if "--disable-js" in sys_argv:
             disable_js = True
@@ -434,6 +683,13 @@ def Driver(
             disable_js = False
     if pls is not None and page_load_strategy is None:
         page_load_strategy = pls
+    if not page_load_strategy and "--pls=" in arg_join:
+        if "--pls=none" in sys_argv or '--pls="none"' in sys_argv:
+            page_load_strategy = "none"
+        elif "--pls=eager" in sys_argv or '--pls="eager"' in sys_argv:
+            page_load_strategy = "eager"
+        elif "--pls=normal" in sys_argv or '--pls="normal"' in sys_argv:
+            page_load_strategy = "normal"
     if page_load_strategy is not None:
         if page_load_strategy.lower() not in ["normal", "eager", "none"]:
             raise Exception(
@@ -485,6 +741,10 @@ def Driver(
             swiftshader = True
         else:
             swiftshader = False
+    if locale is not None and locale_code is None:
+        locale_code = locale
+    if ad_block is not None and ad_block_on is None:
+        ad_block_on = ad_block
     if ad_block_on is None:
         if "--ad-block" in sys_argv or "--ad_block" in sys_argv:
             ad_block_on = True
@@ -499,20 +759,33 @@ def Driver(
             host_resolver_rules = (
                 arg_join.split("--host_resolver_rules=")[1].split('"')[0]
             )
-    if driver_version is None:
-        if "--driver-version=" in arg_join:
-            driver_version = (
-                arg_join.split("--driver-version=")[1].split(" ")[0]
-            )
-        elif "--driver_version=" in arg_join:
-            driver_version = (
-                arg_join.split("--driver_version=")[1].split(" ")[0]
-            )
+    if driver_version is None and "--driver-version" in arg_join:
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--driver-version="):
+                driver_version = arg.split("--driver-version=")[1]
+                break
+            elif arg == "--driver-version" and len(sys_argv) > count + 1:
+                driver_version = sys_argv[count + 1]
+                if driver_version.startswith("-"):
+                    driver_version = None
+                break
+            count += 1
+    if driver_version is None and "--driver_version" in arg_join:
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--driver_version="):
+                driver_version = arg.split("--driver_version=")[1]
+                break
+            elif arg == "--driver_version" and len(sys_argv) > count + 1:
+                driver_version = sys_argv[count + 1]
+                if driver_version.startswith("-"):
+                    driver_version = None
+                break
+            count += 1
     browser_name = browser
 
     # Launch a web browser
-    from seleniumbase.core import browser_launcher
-
     driver = browser_launcher.get_driver(
         browser_name=browser_name,
         headless=headless,
@@ -529,6 +802,7 @@ def Driver(
         cap_file=cap_file,
         cap_string=cap_string,
         recorder_ext=recorder_ext,
+        disable_cookies=disable_cookies,
         disable_js=disable_js,
         disable_csp=disable_csp,
         enable_ws=enable_ws,
@@ -540,6 +814,7 @@ def Driver(
         log_cdp_events=log_cdp_events,
         no_sandbox=no_sandbox,
         disable_gpu=disable_gpu,
+        headless1=headless1,
         headless2=headless2,
         incognito=incognito,
         guest_mode=guest_mode,