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

seleniumbase/plugins/selenium_plugin.py

@@ -1,5 +1,6 @@
 """Selenium Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import sys
+from contextlib import suppress
 from nose.plugins import Plugin
 from seleniumbase import config as sb_config
 from seleniumbase.config import settings
@@ -42,10 +43,12 @@ class SeleniumBrowser(Plugin):
     --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.)
@@ -82,6 +85,7 @@ class SeleniumBrowser(Plugin):
     --dark  (Enable Chrome's Dark mode.)
     --devtools  (Open Chrome's DevTools when the browser opens.)
     --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.)
@@ -434,6 +438,15 @@ class SeleniumBrowser(Plugin):
                 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",
@@ -465,6 +478,17 @@ class SeleniumBrowser(Plugin):
                     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",
@@ -886,6 +910,17 @@ class SeleniumBrowser(Plugin):
                     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",
@@ -984,6 +1019,7 @@ class SeleniumBrowser(Plugin):
         browser = self.options.browser
         test.test.browser = browser
         test.test.headless = None
+        test.test.headless1 = None
         test.test.headless2 = None
         # As a shortcut, you can use "--edge" instead of "--browser=edge", etc,
         # but you can only specify one default browser. (Default: chrome)
@@ -1060,6 +1096,29 @@ class SeleniumBrowser(Plugin):
                 '\n  (Your browser choice was: "%s")\n' % browser
             )
             raise Exception(message)
+        window_position = self.options.window_position
+        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
         window_size = self.options.window_size
         if window_size:
             if window_size.count(",") != 1:
@@ -1099,9 +1158,13 @@ class SeleniumBrowser(Plugin):
         test.test.cap_file = self.options.cap_file
         test.test.cap_string = self.options.cap_string
         test.test.headless = self.options.headless
+        test.test.headless1 = self.options.headless1
+        if test.test.headless1:
+            test.test.headless = True
         test.test.headless2 = self.options.headless2
         if test.test.headless and test.test.browser == "safari":
             test.test.headless = False  # Safari doesn't use headless
+            test.test.headless1 = False
         if test.test.headless2 and test.test.browser == "firefox":
             test.test.headless2 = False  # Only for Chromium browsers
             test.test.headless = True  # Firefox has regular headless
@@ -1112,6 +1175,7 @@ class SeleniumBrowser(Plugin):
             self.options.headless2 = False
         test.test.headed = self.options.headed
         test.test.xvfb = self.options.xvfb
+        test.test.xvfb_metrics = self.options.xvfb_metrics
         test.test.locale_code = self.options.locale_code
         test.test.interval = self.options.interval
         test.test.start_page = self.options.start_page
@@ -1192,6 +1256,7 @@ class SeleniumBrowser(Plugin):
         test.test.dark_mode = self.options.dark_mode
         test.test.devtools = self.options.devtools
         test.test._disable_beforeunload = self.options._disable_beforeunload
+        test.test.window_position = self.options.window_position
         test.test.window_size = self.options.window_size
         test.test.maximize_option = self.options.maximize_option
         if self.options.save_screenshot and self.options.no_screenshot:
@@ -1244,8 +1309,10 @@ class SeleniumBrowser(Plugin):
         # Recorder Mode can still optimize scripts in --headless2 mode.
         if self.options.recorder_mode and self.options.headless:
             self.options.headless = False
+            self.options.headless1 = False
             self.options.headless2 = True
             test.test.headless = False
+            test.test.headless1 = False
             test.test.headless2 = True
         if not self.options.headless and not self.options.headless2:
             self.options.headed = True
@@ -1259,7 +1326,7 @@ class SeleniumBrowser(Plugin):
         ):
             width = settings.HEADLESS_START_WIDTH
             height = settings.HEADLESS_START_HEIGHT
-            try:
+            with suppress(Exception):
                 from sbvirtualdisplay import Display
 
                 self._xvfb_display = Display(visible=0, size=(width, height))
@@ -1267,8 +1334,6 @@ class SeleniumBrowser(Plugin):
                 sb_config._virtual_display = self._xvfb_display
                 self.headless_active = True
                 sb_config.headless_active = True
-            except Exception:
-                pass
         sb_config._is_timeout_changed = False
         sb_config._SMALL_TIMEOUT = settings.SMALL_TIMEOUT
         sb_config._LARGE_TIMEOUT = settings.LARGE_TIMEOUT
@@ -1301,7 +1366,7 @@ class SeleniumBrowser(Plugin):
             pass
         except Exception:
             pass
-        try:
+        with suppress(Exception):
             if (
                 hasattr(self, "_xvfb_display")
                 and self._xvfb_display
@@ -1318,5 +1383,3 @@ class SeleniumBrowser(Plugin):
             ):
                 sb_config._virtual_display.stop()
                 sb_config._virtual_display = None
-        except Exception:
-            pass

seleniumbase/undetected/__init__.py

@@ -10,6 +10,7 @@ import selenium.webdriver.chrome.service
 import selenium.webdriver.chrome.webdriver
 import selenium.webdriver.common.service
 import selenium.webdriver.remote.command
+from contextlib import suppress
 from .cdp import CDP
 from .cdp import PageElement
 from .dprocess import start_detached
@@ -201,11 +202,9 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
                 # Create a temporary folder for the user-data profile.
                 options.add_argument(arg)
         if not language:
-            try:
+            with suppress(Exception):
                 import locale
                 language = locale.getlocale()[0].replace("_", "-")
-            except Exception:
-                pass
             if (
                 not language
                 or "English" in language
@@ -242,7 +241,7 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
         )
         if hasattr(options, 'handle_prefs'):
             options.handle_prefs(user_data_dir)
-        try:
+        with suppress(Exception):
             import json
             with open(
                 os.path.join(
@@ -263,8 +262,6 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
                 fs.seek(0, 0)
                 fs.truncate()
                 json.dump(config, fs)
-        except Exception:
-            pass
         creationflags = 0
         if "win32" in sys.platform:
             creationflags = subprocess.CREATE_NO_WINDOW
@@ -293,8 +290,6 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
                     self.browser_pid = browser.pid
             service_ = None
             log_output = subprocess.PIPE
-            if sys.version_info < (3, 8):
-                log_output = os.devnull
             if patch_driver:
                 service_ = selenium.webdriver.chrome.service.Service(
                     executable_path=self.patcher.executable_path,
@@ -342,7 +337,7 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
 
     def _get_cdc_props(self):
         cdc_props = []
-        try:
+        with suppress(Exception):
             cdc_props = self.execute_script(
                 """
                 let objectToInspect = window,
@@ -355,8 +350,6 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
                 return result.filter(i => i.match(/^[a-z]{3}_[a-z]{22}_.*/i))
                 """
             )
-        except Exception:
-            pass
         return cdc_props
 
     def _hook_remove_cdc_props(self, cdc_props):
@@ -427,50 +420,38 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
         - Starts the chromedriver service that runs in the background.
         - Recreates the session."""
         if hasattr(self, "service"):
-            try:
+            with suppress(Exception):
                 self.service.stop()
-            except Exception:
-                pass
             if isinstance(timeout, str):
                 if timeout.lower() == "breakpoint":
                     breakpoint()  # To continue:
                     pass  # Type "c" & press ENTER!
             else:
                 time.sleep(timeout)
-            try:
+            with suppress(Exception):
                 self.service.start()
-            except Exception:
-                pass
             time.sleep(0.012)
-        try:
+        with suppress(Exception):
             self.start_session()
-        except Exception:
-            pass
         time.sleep(0.012)
 
     def disconnect(self):
         """Stops the chromedriver service that runs in the background.
         To use driver methods again, you MUST call driver.connect()"""
         if hasattr(self, "service"):
-            try:
+            with suppress(Exception):
                 self.service.stop()
-            except Exception:
-                pass
             time.sleep(0.012)
 
     def connect(self):
         """Starts the chromedriver service that runs in the background
         and recreates the session."""
         if hasattr(self, "service"):
-            try:
+            with suppress(Exception):
                 self.service.start()
-            except Exception:
-                pass
             time.sleep(0.012)
-        try:
+        with suppress(Exception):
             self.start_session()
-        except Exception:
-            pass
         time.sleep(0.012)
 
     def start_session(self, capabilities=None):
@@ -496,12 +477,10 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
         if hasattr(self, "service") and getattr(self.service, "process", None):
             logger.debug("Stopping webdriver service")
             self.service.stop()
-        try:
+        with suppress(Exception):
             if self.reactor and isinstance(self.reactor, Reactor):
                 logger.debug("Shutting down Reactor")
                 self.reactor.event.set()
-        except Exception:
-            pass
         if (
             hasattr(self, "keep_user_data_dir")
             and hasattr(self, "user_data_dir")
@@ -530,18 +509,14 @@ class Chrome(selenium.webdriver.chrome.webdriver.WebDriver):
         self.patcher = None
 
     def __del__(self):
-        try:
+        with suppress(Exception):
             if "win32" in sys.platform:
                 self.stop_client()
                 self.command_executor.close()
             else:
                 super().quit()
-        except Exception:
-            pass
-        try:
+        with suppress(Exception):
             self.quit()
-        except Exception:
-            pass
 
     def __enter__(self):
         return self

seleniumbase/undetected/dprocess.py

@@ -3,7 +3,10 @@ import os
 import sys
 import atexit
 import logging
+import platform
+from contextlib import suppress
 from subprocess import PIPE
+from subprocess import Popen
 
 CREATE_NEW_PROCESS_GROUP = 0x00000200
 DETACHED_PROCESS = 0x00000008
@@ -37,9 +40,6 @@ def start_detached(executable, *args):
 def _start_detached(executable, *args, writer=None):
     # Configure Launch
     kwargs = {}
-    import platform
-    from subprocess import Popen
-
     if platform.system() == "Windows":
         kwargs.update(
             creationflags=DETACHED_PROCESS | CREATE_NEW_PROCESS_GROUP
@@ -58,11 +58,9 @@ def _cleanup():
     import signal
 
     for pid in REGISTERED:
-        try:
+        with suppress(Exception):
             logging.getLogger(__name__).debug("cleaning up pid %d " % pid)
             os.kill(pid, signal.SIGTERM)
-        except Exception:
-            pass
 
 
 atexit.register(_cleanup)

seleniumbase/undetected/options.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 import json
 import os
+from contextlib import suppress
 from selenium.webdriver.chromium.options import ChromiumOptions
 
 
@@ -49,7 +50,7 @@ class ChromeOptions(ChromiumOptions):
                     undot_prefs, self._undot_key(key, value)
                 )
             prefs_file = os.path.join(default_path, "Preferences")
-            try:
+            with suppress(Exception):
                 if os.path.exists(prefs_file):
                     with open(
                         prefs_file, encoding="utf-8", mode="r", errors="ignore"
@@ -57,13 +58,9 @@ class ChromeOptions(ChromiumOptions):
                         undot_prefs = self._merge_nested(
                             json.load(f), undot_prefs
                         )
-            except Exception:
-                pass
-            try:
+            with suppress(Exception):
                 with open(prefs_file, encoding="utf-8", mode="w") as f:
                     json.dump(undot_prefs, f)
-            except Exception:
-                pass
             # Remove experimental_options to avoid errors
             del self._experimental_options["prefs"]
         exclude_switches = self.experimental_options.get("excludeSwitches")

seleniumbase/undetected/patcher.py

@@ -8,6 +8,7 @@ import string
 import sys
 import time
 import zipfile
+from contextlib import suppress
 
 logger = logging.getLogger(__name__)
 IS_POSIX = sys.platform.startswith(("darwin", "cygwin", "linux"))
@@ -53,10 +54,8 @@ class Patcher(object):
         self.executable_path = None
         prefix = "undetected"
         if not os.path.exists(self.data_path):
-            try:
+            with suppress(Exception):
                 os.makedirs(self.data_path, exist_ok=True)
-            except Exception:
-                pass
         if not executable_path:
             self.executable_path = os.path.join(
                 self.data_path, "_".join([prefix, self.exe_name])