seleniumbase 4.30.7__py3-none-any.whl → 4.31.0__py3-none-any.whl

seleniumbase/fixtures/js_utils.py

@@ -2,6 +2,7 @@
 import re
 import requests
 import time
+from contextlib import suppress
 from selenium.common.exceptions import NoSuchElementException
 from selenium.common.exceptions import WebDriverException
 from selenium.webdriver.common.by import By
@@ -56,11 +57,9 @@ def execute_async_script(driver, script, timeout=settings.LARGE_TIMEOUT):
 def wait_for_angularjs(driver, timeout=settings.LARGE_TIMEOUT, **kwargs):
     if hasattr(settings, "SKIP_JS_WAITS") and settings.SKIP_JS_WAITS:
         return
-    try:
+    with suppress(Exception):
         # This closes pop-up alerts
         driver.execute_script("")
-    except Exception:
-        pass
     if (
         (hasattr(driver, "_is_using_uc") and driver._is_using_uc)
         or not settings.WAIT_FOR_ANGULARJS
@@ -92,10 +91,8 @@ def wait_for_angularjs(driver, timeout=settings.LARGE_TIMEOUT, **kwargs):
         "handler": handler,
         "suffix": suffix,
     }
-    try:
+    with suppress(Exception):
         execute_async_script(driver, script, timeout=timeout)
-    except Exception:
-        pass
 
 
 def convert_to_css_selector(selector, by=By.CSS_SELECTOR):
@@ -191,14 +188,12 @@ def raise_unable_to_load_jquery_exception(driver):
 def activate_jquery(driver):
     # If "jQuery is not defined" on a website, use this method to activate it.
     # This method is needed because jQuery is not always defined on web sites.
-    try:
+    with suppress(Exception):
         # Let's first find out if jQuery is already defined.
         driver.execute_script("jQuery('html');")
         # Since that command worked, jQuery is defined. Let's return.
         return
-    except Exception:
-        # jQuery is not currently defined. Let's proceed by defining it.
-        pass
+    # jQuery is not defined. It will be loaded in the next part.
     jquery_js = constants.JQuery.MIN_JS
     add_js_link(driver, jquery_js)
     for x in range(36):
@@ -390,11 +385,9 @@ def highlight(driver, selector, by="css selector", loops=4):
 
 
 def highlight_with_js(driver, selector, loops=4, o_bs=""):
-    try:
+    with suppress(Exception):
         # This closes any pop-up alerts
         driver.execute_script("")
-    except Exception:
-        pass
     if selector == "html":
         selector = "body"
     selector_no_spaces = selector.replace(" ", "")
@@ -490,11 +483,9 @@ def highlight_with_js(driver, selector, loops=4, o_bs=""):
 
 
 def highlight_element_with_js(driver, element, loops=4, o_bs=""):
-    try:
+    with suppress(Exception):
         # This closes any pop-up alerts
         driver.execute_script("")
-    except Exception:
-        pass
     script = (
         """arguments[0].style.boxShadow =
         '0px 0px 6px 6px rgba(128, 128, 128, 0.5)';"""
@@ -566,11 +557,9 @@ def highlight_element_with_js(driver, element, loops=4, o_bs=""):
 
 
 def highlight_with_jquery(driver, selector, loops=4, o_bs=""):
-    try:
+    with suppress(Exception):
         # This closes any pop-up alerts
         driver.execute_script("")
-    except Exception:
-        pass
     if selector == "html":
         selector = "body"
     selector_no_spaces = selector.replace(" ", "")
@@ -908,11 +897,9 @@ def set_messenger_theme(
         time.sleep(0.03)
         activate_messenger(driver)
         time.sleep(0.15)
-        try:
+        with suppress(Exception):
             driver.execute_script(msg_style)
             time.sleep(0.02)
-        except Exception:
-            pass
     time.sleep(0.05)
 
 
@@ -949,7 +936,7 @@ def post_messenger_success_message(driver, message, msg_dur=None):
     if not msg_dur:
         msg_dur = settings.DEFAULT_MESSAGE_DURATION
     msg_dur = float(msg_dur)
-    try:
+    with suppress(Exception):
         theme = "future"
         location = "bottom_right"
         if hasattr(sb_config, "mobile_emulator") and sb_config.mobile_emulator:
@@ -957,28 +944,22 @@ def post_messenger_success_message(driver, message, msg_dur=None):
         set_messenger_theme(driver, theme=theme, location=location)
         post_message(driver, message, msg_dur, style="success")
         time.sleep(msg_dur + 0.07)
-    except Exception:
-        pass
 
 
 def post_messenger_error_message(driver, message, msg_dur=None):
     if not msg_dur:
         msg_dur = settings.DEFAULT_MESSAGE_DURATION
     msg_dur = float(msg_dur)
-    try:
+    with suppress(Exception):
         set_messenger_theme(driver, theme="block", location="top_center")
         post_message(driver, message, msg_dur, style="error")
         time.sleep(msg_dur + 0.07)
-    except Exception:
-        pass
 
 
 def highlight_with_js_2(driver, message, selector, o_bs, msg_dur):
-    try:
+    with suppress(Exception):
         # This closes any pop-up alerts
         driver.execute_script("")
-    except Exception:
-        pass
     if selector == "html":
         selector = "body"
     selector_no_spaces = selector.replace(" ", "")
@@ -991,11 +972,9 @@ def highlight_with_js_2(driver, message, selector, o_bs, msg_dur):
         else:
             early_exit = True  # Changing the box-shadow changes the selector
         if early_exit:
-            try:
+            with suppress(Exception):
                 activate_jquery(driver)
                 post_messenger_success_message(driver, message, msg_dur)
-            except Exception:
-                pass
             return
     script = (
         """document.querySelector('%s').style.boxShadow =
@@ -1047,11 +1026,9 @@ def highlight_with_js_2(driver, message, selector, o_bs, msg_dur):
     except Exception:
         return
     time.sleep(0.0181)
-    try:
+    with suppress(Exception):
         activate_jquery(driver)
         post_messenger_success_message(driver, message, msg_dur)
-    except Exception:
-        pass
     script = """document.querySelector('%s').style.boxShadow = '%s';""" % (
         selector,
         o_bs,
@@ -1063,11 +1040,9 @@ def highlight_with_js_2(driver, message, selector, o_bs, msg_dur):
 
 
 def highlight_element_with_js_2(driver, message, element, o_bs, msg_dur):
-    try:
+    with suppress(Exception):
         # This closes any pop-up alerts
         driver.execute_script("")
-    except Exception:
-        pass
     script = (
         """arguments[0].style.boxShadow =
         '0px 0px 6px 6px rgba(128, 128, 128, 0.5)';"""
@@ -1113,11 +1088,9 @@ def highlight_element_with_js_2(driver, message, element, o_bs, msg_dur):
     except Exception:
         return
     time.sleep(0.0181)
-    try:
+    with suppress(Exception):
         activate_jquery(driver)
         post_messenger_success_message(driver, message, msg_dur)
-    except Exception:
-        pass
     script = """arguments[0].style.boxShadow = '%s';""" % (o_bs)
     try:
         driver.execute_script(script, element)
@@ -1138,11 +1111,9 @@ def highlight_with_jquery_2(driver, message, selector, o_bs, msg_dur):
         else:
             early_exit = True  # Changing the box-shadow changes the selector
         if early_exit:
-            try:
+            with suppress(Exception):
                 activate_jquery(driver)
                 post_messenger_success_message(driver, message, msg_dur)
-            except Exception:
-                pass
             return
     script = (
         """jQuery('%s').css('box-shadow',
@@ -1195,11 +1166,9 @@ def highlight_with_jquery_2(driver, message, selector, o_bs, msg_dur):
         return
     time.sleep(0.0181)
 
-    try:
+    with suppress(Exception):
         activate_jquery(driver)
         post_messenger_success_message(driver, message, msg_dur)
-    except Exception:
-        pass
 
     script = """jQuery('%s').css('box-shadow', '%s');""" % (selector, o_bs)
     try:
@@ -1484,12 +1453,10 @@ def get_drag_and_drop_with_offset_script(selector, x, y):
 
 
 def clear_out_console_logs(driver):
-    try:
+    with suppress(Exception):
         # Clear out the current page log before navigating to a new page
         # (To make sure that assert_no_js_errors() uses current results)
         driver.get_log("browser")
-    except Exception:
-        pass
 
 
 def _jq_format(code):

seleniumbase/fixtures/page_actions.py

@@ -21,6 +21,7 @@ import codecs
 import fasteners
 import os
 import time
+from contextlib import suppress
 from selenium.common.exceptions import ElementNotInteractableException
 from selenium.common.exceptions import ElementNotVisibleException
 from selenium.common.exceptions import NoAlertPresentException
@@ -1409,12 +1410,10 @@ def switch_to_frame(driver, frame, timeout=settings.SMALL_TIMEOUT):
                 else:
                     by = "css selector"
                 if is_element_visible(driver, frame, by=by):
-                    try:
+                    with suppress(Exception):
                         element = driver.find_element(by=by, value=frame)
                         driver.switch_to.frame(element)
                         return True
-                    except Exception:
-                        pass
             now_ms = time.time() * 1000.0
             if now_ms >= stop_ms:
                 break
@@ -1548,12 +1547,10 @@ def click_if_visible(
     if is_element_visible(driver, selector, by=by):
         click(driver, selector, by=by, timeout=1)
     elif timeout > 0:
-        try:
+        with suppress(Exception):
             wait_for_element_visible(
                 driver, selector, by=by, timeout=timeout
             )
-        except Exception:
-            pass
         if is_element_visible(driver, selector, by=by):
             click(driver, selector, by=by, timeout=1)
 

seleniumbase/fixtures/page_utils.py

@@ -16,7 +16,7 @@ def get_domain_url(url):
     Into this:
     https://blog.xkcd.com
     """
-    if not url.startswith("http://") and not url.startswith("https://"):
+    if not url.startswith(("http://", "https://")):
         return url
     url_header = url.split("://")[0]
     simple_url = url.split("://")[1]
@@ -40,45 +40,25 @@ def swap_selector_and_by_if_reversed(selector, by):
 
 def is_xpath_selector(selector):
     """Determine if a selector is an xpath selector."""
-    if (
-        selector.startswith("/")
-        or selector.startswith("./")
-        or selector.startswith("(")
-    ):
-        return True
-    return False
+    return selector.startswith(("/", "./", "("))
 
 
 def is_link_text_selector(selector):
     """Determine if a selector is a link text selector."""
-    if (
-        selector.startswith("link=")
-        or selector.startswith("link_text=")
-        or selector.startswith("text=")
-    ):
-        return True
-    return False
+    return selector.startswith(("link=", "link_text=", "text="))
 
 
 def is_partial_link_text_selector(selector):
     """Determine if a selector is a partial link text selector."""
-    if (
-        selector.startswith("partial_link=")
-        or selector.startswith("partial_link_text=")
-        or selector.startswith("partial_text=")
-        or selector.startswith("p_link=")
-        or selector.startswith("p_link_text=")
-        or selector.startswith("p_text=")
-    ):
-        return True
-    return False
+    return selector.startswith((
+        "partial_link=", "partial_link_text=", "partial_text=",
+        "p_link=", "p_link_text=", "p_text="
+    ))
 
 
 def is_name_selector(selector):
     """Determine if a selector is a name selector."""
-    if selector.startswith("name=") or selector.startswith("&"):
-        return True
-    return False
+    return selector.startswith(("name=", "&"))
 
 
 def recalculate_selector(selector, by, xp_ok=True):
@@ -108,10 +88,9 @@ def recalculate_selector(selector, by, xp_ok=True):
         name = get_name_from_selector(selector)
         selector = '[name="%s"]' % name
         by = By.CSS_SELECTOR
-    if xp_ok:
-        if ":contains(" in selector and by == By.CSS_SELECTOR:
-            selector = css_to_xpath.convert_css_to_xpath(selector)
-            by = By.XPATH
+    if xp_ok and ":contains(" in selector and by == By.CSS_SELECTOR:
+        selector = css_to_xpath.convert_css_to_xpath(selector)
+        by = By.XPATH
     if by == "":
         by = By.CSS_SELECTOR
     if not is_valid_by(by):
@@ -130,21 +109,10 @@ def looks_like_a_page_url(url):
     possible typos when calling self.get(url), which will try to
     navigate to the page if a URL is detected, but will instead call
     self.get_element(URL_AS_A_SELECTOR) if the input is not a URL."""
-    if (
-        url.startswith("http:")
-        or url.startswith("https:")
-        or url.startswith("://")
-        or url.startswith("about:")
-        or url.startswith("blob:")
-        or url.startswith("chrome:")
-        or url.startswith("data:")
-        or url.startswith("edge:")
-        or url.startswith("file:")
-        or url.startswith("view-source:")
-    ):
-        return True
-    else:
-        return False
+    return url.startswith((
+        "http:", "https:", "://", "about:", "blob:", "chrome:",
+        "data:", "edge:", "file:", "view-source:"
+    ))
 
 
 def get_link_text_from_selector(selector):
@@ -195,18 +163,12 @@ def is_valid_url(url):
         r"(?:/?|[/?]\S+)$",
         re.IGNORECASE,
     )
-    if (
+    return (
         regex.match(url)
-        or url.startswith("about:")
-        or url.startswith("blob:")
-        or url.startswith("chrome:")
-        or url.startswith("data:")
-        or url.startswith("edge:")
-        or url.startswith("file:")
-    ):
-        return True
-    else:
-        return False
+        or url.startswith((
+            "about:", "blob:", "chrome:", "data:", "edge:", "file:"
+        ))
+    )
 
 
 def _get_unique_links(page_url, soup):

seleniumbase/plugins/base_plugin.py

@@ -2,6 +2,7 @@
 import ast
 import sys
 import time
+from contextlib import suppress
 from nose.plugins import Plugin
 from seleniumbase import config as sb_config
 from seleniumbase.config import settings
@@ -305,14 +306,12 @@ class Base(Plugin):
         if python3_11_or_newer and py311_patch2:
             # Handle a bug on Python 3.11 where exceptions aren't seen
             sb_config._browser_version = None
-            try:
+            with suppress(Exception):
                 test._BaseCase__set_last_page_screenshot()
                 test._BaseCase__set_last_page_url()
                 test._BaseCase__set_last_page_source()
                 sb_config._browser_version = test._get_browser_version()
                 test._log_fail_data()
-            except Exception:
-                pass
             sb_config._excinfo_tb = err
             log_path = None
             if hasattr(sb_config, "_test_logpath"):

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()
@@ -75,7 +75,7 @@ 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.
@@ -115,6 +115,8 @@ 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
@@ -131,7 +133,98 @@ def Driver(
     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:  # Choose from "chrome", "edge", "firefox", or "safari".
+    headless:  # The original headless mode for Chromium and Firefox.
+    headless2:  # Chromium's new headless mode. (Has more features)
+    headed:  # Run tests in headed/GUI mode on Linux, where not default.
+    locale_code:  # Set the Language Locale Code for the web browser.
+    protocol:  # The Selenium Grid protocol: "http" or "https".
+    servername:  # The Selenium Grid server/IP used for tests.
+    port:  # The Selenium Grid port used by the test server.
+    proxy:  # Use proxy. Format: "SERVER:PORT" or "USER:PASS@SERVER:PORT".
+    proxy_bypass_list:  # Skip proxy when using the listed domains.
+    proxy_pac_url:  # Use PAC file. (Format: URL or USERNAME:PASSWORD@URL)
+    multi_proxy:  # Allow multiple proxies with auth when multi-threaded.
+    agent:  # Modify the web browser's User-Agent string.
+    cap_file:  # The desired capabilities to use with a Selenium Grid.
+    cap_string:  # The desired capabilities to use with a Selenium Grid.
+    recorder_ext:  # Enables the SeleniumBase Recorder Chromium extension.
+    disable_js:  # Disable JavaScript on websites. Pages might break!
+    disable_csp:  # Disable the Content Security Policy of websites.
+    enable_ws:  # Enable Web Security on Chromium-based browsers.
+    disable_ws:  # Reverse of "enable_ws". (None and False are different)
+    enable_sync:  # Enable "Chrome Sync" on websites.
+    use_auto_ext:  # Use Chrome's automation extension.
+    undetectable:  # Use undetected-chromedriver to evade bot-detection.
+    uc_cdp_events:  # Capture CDP events in undetected-chromedriver mode.
+    uc_subprocess:  # Use undetected-chromedriver as a subprocess.
+    log_cdp_events:  # Capture {"performance": "ALL", "browser": "ALL"}
+    no_sandbox:  # (DEPRECATED) - "--no-sandbox" is always used now.
+    disable_gpu:  # (DEPRECATED) - GPU is disabled if not "swiftshader".
+    incognito:  # Enable Chromium's Incognito mode.
+    guest_mode:  # Enable Chromium's Guest mode.
+    dark_mode:  # Enable Chromium's Dark mode.
+    devtools:  # Open Chromium's DevTools when the browser opens.
+    remote_debug:  # Enable Chrome's Debugger on "http://localhost:9222".
+    enable_3d_apis:  # Enable WebGL and 3D APIs.
+    swiftshader:  # Chrome: --use-gl=angle / --use-angle=swiftshader-webgl
+    ad_block_on:  # Block some types of display ads from loading.
+    host_resolver_rules:  # Set host-resolver-rules, comma-separated.
+    block_images:  # Block images from loading during tests.
+    do_not_track:  # Tell websites that you don't want to be tracked.
+    chromium_arg:  # "ARG=N,ARG2" (Set Chromium args, ","-separated.)
+    firefox_arg:  # "ARG=N,ARG2" (Set Firefox args, comma-separated.)
+    firefox_pref:  # SET (Set Firefox PREFERENCE:VALUE set, ","-separated)
+    user_data_dir:  # Set the Chrome user data directory to use.
+    extension_zip:  # Load a Chrome Extension .zip|.crx, comma-separated.
+    extension_dir:  # Load a Chrome Extension directory, comma-separated.
+    disable_features:  # "F1,F2" (Disable Chrome features, ","-separated.)
+    binary_location:  # Set path of the Chromium browser binary to use.
+    driver_version:  # Set the chromedriver or uc_driver version to use.
+    page_load_strategy:  # Set Chrome PLS to "normal", "eager", or "none".
+    use_wire:  # Use selenium-wire's webdriver over selenium webdriver.
+    external_pdf:  # Set Chrome "plugins.always_open_pdf_externally":True.
+    window_position:  # Set the browser's starting window position: "X,Y"
+    window_size:  # Set the browser's starting window size: "Width,Height"
+    is_mobile:  # Use the mobile device emulator while running tests.
+    mobile:  # Shortcut / Duplicate of "is_mobile".
+    d_width:  # Set device width
+    d_height:  # Set device height
+    d_p_r:  # Set device pixel ratio
+    uc:  # Shortcut / Duplicate of "undetectable".
+    undetected:  # Shortcut / Duplicate of "undetectable".
+    uc_cdp:  # Shortcut / Duplicate of "uc_cdp_events".
+    uc_sub:  # Shortcut / Duplicate of "uc_subprocess".
+    log_cdp:  # Shortcut / Duplicate of "log_cdp_events".
+    ad_block:  # Shortcut / Duplicate of "ad_block_on".
+    server:  # Shortcut / Duplicate of "servername".
+    guest:  # Shortcut / Duplicate of "guest_mode".
+    wire:  # Shortcut / Duplicate of "use_wire".
+    pls:  # Shortcut / Duplicate of "page_load_strategy".
+    """
     from seleniumbase import config as sb_config
+    from seleniumbase.config import settings
     from seleniumbase.fixtures import constants
     from seleniumbase.fixtures import shared_utils
 
@@ -329,6 +422,79 @@ def Driver(
                 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
+        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
+    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: