seleniumbase 4.30.8__py3-none-any.whl → 4.31.1__py3-none-any.whl

seleniumbase/plugins/pytest_plugin.py

@@ -4,6 +4,7 @@ import os
 import pytest
 import sys
 import time
+from contextlib import suppress
 from seleniumbase import config as sb_config
 from seleniumbase.config import settings
 from seleniumbase.core import log_helper
@@ -61,10 +62,12 @@ def pytest_addoption(parser):
     --sjw  (Skip JS Waits for readyState to be "complete" or Angular to load.)
     --wfa  (Wait for AngularJS to be done loading after specific web actions.)
     --pls=PLS  (Set pageLoadStrategy on Chrome: "normal", "eager", or "none".)
-    --headless  (Run tests in headless mode. The default arg on Linux OS.)
-    --headless2  (Use the new headless mode, which supports extensions.)
+    --headless  (The default headless mode. Linux uses this mode by default.)
+    --headless1  (Use Chrome's old headless mode. Fast, but has limitations.)
+    --headless2  (Use Chrome's new headless mode, which supports extensions.)
     --headed  (Run tests in headed/GUI mode on Linux OS, where not default.)
     --xvfb  (Run tests using the Xvfb virtual display server on Linux OS.)
+    --xvfb-metrics=STRING  (Set Xvfb display size on Linux: "Width,Height".)
     --locale=LOCALE_CODE  (Set the Language Locale Code for the web browser.)
     --interval=SECONDS  (The autoplay interval for presentations & tour steps)
     --start-page=URL  (The starting URL for the web browser when tests begin.)
@@ -109,6 +112,7 @@ def pytest_addoption(parser):
     --rcs | --reuse-class-session  (Reuse session for tests in class.)
     --crumbs  (Delete all cookies between tests reusing a session.)
     --disable-beforeunload  (Disable the "beforeunload" event on Chrome.)
+    --window-position=X,Y  (Set the browser's starting window position.)
     --window-size=WIDTH,HEIGHT  (Set the browser's starting window size.)
     --maximize  (Start tests with the browser window maximized.)
     --screenshot  (Save a screenshot at the end of each test.)
@@ -697,6 +701,15 @@ def pytest_addoption(parser):
                 UNLESS using a virtual display with Xvfb.
                 Default: False on Mac/Windows. True on Linux.""",
     )
+    parser.addoption(
+        "--headless1",
+        action="store_true",
+        dest="headless1",
+        default=False,
+        help="""This option activates the old headless mode,
+                which is faster, but has limitations.
+                (May be phased out by Chrome in the future.)""",
+    )
     parser.addoption(
         "--headless2",
         action="store_true",
@@ -728,6 +741,17 @@ def pytest_addoption(parser):
                 will no longer be enabled by default on Linux.
                 Default: False. (Linux-ONLY!)""",
     )
+    parser.addoption(
+        "--xvfb-metrics",
+        "--xvfb_metrics",
+        action="store",
+        dest="xvfb_metrics",
+        default=None,
+        help="""Customize the Xvfb metrics (Width,Height) on Linux.
+                Format: A comma-separated string with the 2 values.
+                Examples: "1920,1080" or "1366,768" or "1024,768".
+                Default: None. (None: "1366,768". Min: "1024,768".)""",
+    )
     parser.addoption(
         "--locale_code",
         "--locale-code",
@@ -1229,6 +1253,17 @@ def pytest_addoption(parser):
                 on Chromium browsers (Chrome or Edge).
                 This is already the default Firefox option.""",
     )
+    parser.addoption(
+        "--window-position",
+        "--window_position",
+        action="store",
+        dest="window_position",
+        default=None,
+        help="""The option to set the starting window x,y position
+                Format: A comma-separated string with the 2 values.
+                Example: "55,66"
+                Default: None. (Will use default values if None)""",
+    )
     parser.addoption(
         "--window-size",
         "--window_size",
@@ -1508,6 +1543,9 @@ def pytest_configure(config):
     sb_config.mobile_emulator = config.getoption("mobile_emulator")
     sb_config.device_metrics = config.getoption("device_metrics")
     sb_config.headless = config.getoption("headless")
+    sb_config.headless1 = config.getoption("headless1")
+    if sb_config.headless1:
+        sb_config.headless = True
     sb_config.headless2 = config.getoption("headless2")
     if sb_config.headless2 and sb_config.browser == "firefox":
         sb_config.headless2 = False  # Only for Chromium browsers
@@ -1516,6 +1554,7 @@ def pytest_configure(config):
         sb_config.headless2 = False  # Only for Chromium browsers
     sb_config.headed = config.getoption("headed")
     sb_config.xvfb = config.getoption("xvfb")
+    sb_config.xvfb_metrics = config.getoption("xvfb_metrics")
     sb_config.locale_code = config.getoption("locale_code")
     sb_config.interval = config.getoption("interval")
     sb_config.start_page = config.getoption("start_page")
@@ -1624,6 +1663,7 @@ def pytest_configure(config):
     sb_config.shared_driver = None  # The default driver for session reuse
     sb_config.crumbs = config.getoption("crumbs")
     sb_config._disable_beforeunload = config.getoption("_disable_beforeunload")
+    sb_config.window_position = config.getoption("window_position")
     sb_config.window_size = config.getoption("window_size")
     sb_config.maximize_option = config.getoption("maximize_option")
     sb_config.save_screenshot = config.getoption("save_screenshot")
@@ -1732,6 +1772,7 @@ def pytest_configure(config):
     # Recorder Mode can still optimize scripts in --headless2 mode.
     if sb_config.recorder_mode and sb_config.headless:
         sb_config.headless = False
+        sb_config.headless1 = False
         sb_config.headless2 = True
 
     if not sb_config.headless and not sb_config.headless2:
@@ -1752,6 +1793,7 @@ def pytest_configure(config):
 
     if sb_config.browser == "safari" and sb_config.headless:
         sb_config.headless = False  # Safari doesn't support headless mode
+        sb_config.headless1 = False
 
     if sb_config.dash_title:
         constants.Dashboard.TITLE = sb_config.dash_title.replace("_", " ")
@@ -1822,10 +1864,8 @@ def _create_dashboard_assets_():
     abs_path = os.path.abspath(".")
     assets_folder = os.path.join(abs_path, "assets")
     if not os.path.exists(assets_folder):
-        try:
+        with suppress(Exception):
             os.makedirs(assets_folder, exist_ok=True)
-        except Exception:
-            pass
     pytest_style_css = os.path.join(assets_folder, "pytest_style.css")
     add_pytest_style_css = True
     if os.path.exists(pytest_style_css):
@@ -1897,12 +1937,10 @@ def pytest_collection_finish(session):
         dash_path = os.path.join(os.getcwd(), "dashboard.html")
         dash_url = "file://" + dash_path.replace("\\", "/")
         star_len = len("Dashboard: ") + len(dash_url)
-        try:
+        with suppress(Exception):
             terminal_size = os.get_terminal_size().columns
             if terminal_size > 30 and star_len > terminal_size:
                 star_len = terminal_size
-        except Exception:
-            pass
         stars = "*" * star_len
         c1 = ""
         cr = ""
@@ -1944,11 +1982,11 @@ def pytest_runtest_teardown(item):
     (Has zero effect on tests using --reuse-session / --rs)"""
     if "--co" in sys_argv or "--collect-only" in sys_argv:
         return
-    try:
+    with suppress(Exception):
         if hasattr(item, "_testcase") or hasattr(sb_config, "_sb_pdb_driver"):
             if hasattr(item, "_testcase"):
                 self = item._testcase
-                try:
+                with suppress(Exception):
                     if (
                         hasattr(self, "driver")
                         and self.driver
@@ -1956,22 +1994,18 @@ def pytest_runtest_teardown(item):
                     ):
                         if not (is_windows or self.driver.service.process):
                             self.driver.quit()
-                except Exception:
-                    pass
             elif (
                 hasattr(sb_config, "_sb_pdb_driver")
                 and sb_config._sb_pdb_driver
             ):
-                try:
+                with suppress(Exception):
                     if (
                         not is_windows
                         or sb_config._sb_pdb_driver.service.process
                     ):
                         sb_config._sb_pdb_driver.quit()
                         sb_config._sb_pdb_driver = None
-                except Exception:
-                    pass
-        try:
+        with suppress(Exception):
             if (
                 hasattr(self, "_xvfb_display")
                 and self._xvfb_display
@@ -1988,10 +2022,6 @@ def pytest_runtest_teardown(item):
             ):
                 sb_config._virtual_display.stop()
                 sb_config._virtual_display = None
-        except Exception:
-            pass
-    except Exception:
-        pass
     if (
         (
             sb_config._has_exception
@@ -2372,7 +2402,7 @@ def pytest_runtest_makereport(item, call):
                     )
                 if log_path:
                     sb_config._log_fail_data()
-        try:
+        with suppress(Exception):
             extra_report = None
             if hasattr(item, "_testcase"):
                 extra_report = item._testcase._html_report_extra
@@ -2417,5 +2447,3 @@ def pytest_runtest_makereport(item, call):
                     "</script>" % constants.Dashboard.LIVE_JS
                 )
                 report.extra.append(pytest_html.extras.html(refresh_updates))
-        except Exception:
-            pass

seleniumbase/plugins/sb_manager.py

@@ -7,7 +7,7 @@ Usage --> ``with SB() as sb:``
 
 Example -->
 
-```
+```python
 from seleniumbase import SB
 
 with SB() as sb:  # Many args! Eg. SB(browser="edge")
@@ -32,8 +32,9 @@ def SB(
     rtf=None,  # Shortcut / Duplicate of "raise_test_failure".
     raise_test_failure=None,  # If "test" mode, raise Exception on 1st failure.
     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)
     locale_code=None,  # Set the Language Locale Code for the web browser.
     protocol=None,  # The Selenium Grid protocol: "http" or "https".
     servername=None,  # The Selenium Grid server/IP used for tests.
@@ -41,7 +42,7 @@ def SB(
     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.
@@ -79,10 +80,13 @@ def SB(
     wait_for_angularjs=None,  # Wait for AngularJS to load after some actions.
     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".
     device_metrics=None,  # Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio"
     xvfb=None,  # Run tests using the Xvfb virtual display server on Linux OS.
+    xvfb_metrics=None,  # Set Xvfb display size on Linux: "Width,Height".
     start_page=None,  # The starting URL for the web browser when tests begin.
     rec_print=None,  # If Recorder is enabled, prints output after tests end.
     rec_behave=None,  # Like Recorder Mode, but also generates behave-gherkin.
@@ -124,6 +128,125 @@ def SB(
     interval=None,  # SECONDS (Autoplay interval for SB Slides & Tour steps.)
     time_limit=None,  # SECONDS (Safely fail tests that exceed the time limit.)
 ):
+    """
+    * SeleniumBase as a Python Context Manager *
+
+    Example:
+    --------
+    .. code-block:: python
+        from seleniumbase import SB
+
+        with SB() as sb:  # Many args! Eg. SB(browser="edge")
+            sb.open("https://google.com/ncr")
+            sb.type('[name="q"]', "SeleniumBase on GitHub")
+            sb.submit('[name="q"]')
+            sb.click('a[href*="github.com/seleniumbase"]')
+            sb.highlight("div.Layout-main")
+            sb.highlight("div.Layout-sidebar")
+            sb.sleep(0.5)
+
+    Optional Parameters:
+    --------------------
+    test (bool):  Test Mode: Output, Logging, Continue on failure unless "rtf".
+    rtf (bool):  Shortcut / Duplicate of "raise_test_failure".
+    raise_test_failure (bool):  If "test" mode, raise Exception on 1st failure.
+    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)
+    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 multithreaded.
+    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_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.
+    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"}
+    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.
+    skip_js_waits (bool):  Skip JS Waits (readyState=="complete" and Angular).
+    wait_for_angularjs (bool):  Wait for AngularJS to load after some actions.
+    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".
+    device_metrics (w,h,pr):  Mobile metrics: "CSSWidth,CSSHeight,PixelRatio"
+    xvfb (bool):  Run tests using the Xvfb virtual display server on Linux OS.
+    xvfb_metrics (w,h):  Set Xvfb display size on Linux: "Width,Height".
+    start_page (str):  The starting URL for the web browser when tests begin.
+    rec_print (bool):  If Recorder is enabled, prints output after tests end.
+    rec_behave (bool):  Like Recorder Mode, but also generates behave-gherkin.
+    record_sleep (bool):  If Recorder enabled, also records self.sleep calls.
+    data (str):  Extra test data. Access with "self.data" in tests.
+    var1 (str):  Extra test data. Access with "self.var1" in tests.
+    var2 (str):  Extra test data. Access with "self.var2" in tests.
+    var3 (str):  Extra test data. Access with "self.var3" in tests.
+    variables (dict):  Extra test data. Access with "self.variables".
+    account (str):  Set account. Access with "self.account" in tests.
+    environment (str):  Set the test env. Access with "self.env" in tests.
+    headed (bool):  Run tests in headed/GUI mode on Linux, where not default.
+    maximize (bool):  Start tests with the browser window maximized.
+    disable_ws (bool):  Reverse of "enable_ws". (None and False are different)
+    disable_beforeunload (bool):  Disable the "beforeunload" event on Chromium.
+    settings_file (str):  A file for overriding default SeleniumBase settings.
+    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".
+    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".
+    sjw (bool):  Shortcut / Duplicate of "skip_js_waits".
+    wfa (bool):  Shortcut / Duplicate of "wait_for_angularjs".
+    save_screenshot (bool):  Save a screenshot at the end of each test.
+    no_screenshot (bool):  No screenshots saved unless tests directly ask it.
+    page_load_strategy (str):  Set Chrome PLS to "normal", "eager", or "none".
+    timeout_multiplier (float):  Multiplies the default timeout values.
+    js_checking_on (bool):  Check for JavaScript errors after page loads.
+    slow (bool):  Slow down the automation. Faster than using Demo Mode.
+    demo (bool):  Slow down and visually see test actions as they occur.
+    demo_sleep (float):  SECONDS (Set wait time after Slow & Demo Mode actions)
+    message_duration (float):  SECONDS (The time length for Messenger alerts.)
+    highlights (int):  Number of highlight animations for Demo Mode actions.
+    interval (float):  SECONDS (Autoplay interval for SB Slides & Tour steps.)
+    time_limit (float):  SECONDS (Safely fail tests that exceed the time limit)
+    """
     import os
     import sys
     import time
@@ -280,6 +403,13 @@ def SB(
             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
@@ -365,6 +495,48 @@ def SB(
                 break
             count += 1
     disable_features = d_f
+    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
+    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
+    x_m = xvfb_metrics
+    if x_m is None and "--xvfb-metrics" in arg_join:
+        count = 0
+        for arg in sys_argv:
+            if arg.startswith("--xvfb-metrics="):
+                x_m = arg.split("--xvfb-metrics=")[1]
+                break
+            elif arg == "--xvfb-metrics" and len(sys_argv) > count + 1:
+                x_m = sys_argv[count + 1]
+                if x_m.startswith("-"):
+                    x_m = None
+                break
+            count += 1
+    xvfb_metrics = x_m
     if agent is None and "--agent" in arg_join:
         count = 0
         for arg in sys_argv:
@@ -509,6 +681,7 @@ def SB(
         recorder_ext = True
     if recorder_mode and headless:
         headless = False
+        headless1 = False
         headless2 = True
     sb_config.proxy_driver = False
     if "--proxy-driver" in sys_argv or "--proxy_driver" in sys_argv:
@@ -638,6 +811,7 @@ def SB(
         save_screenshot = False  # "no_screenshot" has priority
     if browser == "safari" and headless:
         headless = False  # Safari doesn't support headless mode
+        headless1 = False
     if js_checking_on is None:
         if "--check-js" in sys_argv:
             js_checking_on = True
@@ -758,9 +932,11 @@ def SB(
         sb_config.is_nosetest = False
     sb_config.is_context_manager = True
     sb_config.headless = headless
+    sb_config.headless1 = headless1
     sb_config.headless2 = headless2
     sb_config.headed = headed
     sb_config.xvfb = xvfb
+    sb_config.xvfb_metrics = xvfb_metrics
     sb_config.start_page = start_page
     sb_config.locale_code = locale_code
     sb_config.protocol = protocol
@@ -803,7 +979,8 @@ def SB(
     sb_config.crumbs = False
     sb_config.final_debug = False
     sb_config.visual_baseline = False
-    sb_config.window_size = None
+    sb_config.window_position = window_position
+    sb_config.window_size = window_size
     sb_config.maximize_option = maximize_option
     sb_config._disable_beforeunload = _disable_beforeunload
     sb_config.save_screenshot = save_screenshot
@@ -861,9 +1038,11 @@ def SB(
     sb.is_nosetest = False
     sb.is_context_manager = sb_config.is_context_manager
     sb.headless = sb_config.headless
+    sb.headless1 = sb_config.headless1
     sb.headless2 = sb_config.headless2
     sb.headed = sb_config.headed
     sb.xvfb = sb_config.xvfb
+    sb.xvfb_metrics = sb_config.xvfb_metrics
     sb.start_page = sb_config.start_page
     sb.locale_code = sb_config.locale_code
     sb.protocol = sb_config.protocol
@@ -908,6 +1087,7 @@ def SB(
     sb._crumbs = sb_config.crumbs
     sb._final_debug = sb_config.final_debug
     sb.visual_baseline = sb_config.visual_baseline
+    sb.window_position = sb_config.window_position
     sb.window_size = sb_config.window_size
     sb.maximize_option = sb_config.maximize_option
     sb._disable_beforeunload = sb_config._disable_beforeunload