seleniumbase 4.15.14__py3-none-any.whl → 4.16.0__py3-none-any.whl

seleniumbase/fixtures/page_actions.py

@@ -1,12 +1,10 @@
-"""
-This module contains a set of methods that can be used for page loads and
-for waiting for elements to appear on a page.
+"""This module contains useful methods for waiting on elements to load.
 
-These methods improve on and expand existing WebDriver commands.
+These methods improve and expand on existing WebDriver commands.
 Improvements include making WebDriver commands more robust and more reliable
 by giving page elements enough time to load before taking action on them.
 
-The default option for searching for elements is by CSS Selector.
+The default option for searching for elements is by "css selector".
 This can be changed by overriding the "By" parameter from this import:
 > from selenium.webdriver.common.by import By
 Options are:
@@ -19,7 +17,6 @@ By.XPATH               # "xpath"
 By.TAG_NAME            # "tag name"
 By.PARTIAL_LINK_TEXT   # "partial link text"
 """
-
 import codecs
 import os
 import time

seleniumbase/fixtures/page_utils.py

@@ -1,4 +1,4 @@
-"""This module contains useful utility methods."""
+"""This module contains useful utility methods"""
 import codecs
 import fasteners
 import os

seleniumbase/fixtures/shared_utils.py

@@ -1,13 +1,15 @@
-"""Shared utility methods."""
-import subprocess
+"""Shared utility methods"""
+import os
+import platform
 import sys
-from seleniumbase.config import settings
-from seleniumbase.fixtures import constants
+import time
 from seleniumbase import config as sb_config
+from seleniumbase.fixtures import constants
 
 
 def pip_install(package, version=None):
     import fasteners
+    import subprocess
 
     pip_install_lock = fasteners.InterProcessLock(
         constants.PipInstall.LOCKFILE
@@ -24,17 +26,30 @@ def pip_install(package, version=None):
             )
 
 
+def is_arm_mac():
+    """(M1 / M2 Macs use the ARM processor)"""
+    return (
+        "darwin" in sys.platform
+        and (
+            "arm" in platform.processor().lower()
+            or "arm64" in platform.version().lower()
+        )
+    )
+
+
+def is_mac():
+    return "darwin" in sys.platform
+
+
+def is_linux():
+    return "linux" in sys.platform
+
+
 def is_windows():
-    platform = sys.platform
-    if "win32" in platform or "win64" in platform or "x64" in platform:
-        return True
-    else:
-        return False
+    return "win32" in sys.platform
 
 
 def get_terminal_width():
-    import os
-
     width = 80  # default
     try:
         width = os.get_terminal_size().columns
@@ -48,72 +63,6 @@ def get_terminal_width():
     return width
 
 
-def display_proxy_warning(proxy_string):
-    import warnings
-
-    message = (
-        '\nWARNING: Proxy String ["%s"] is NOT in the expected '
-        '"ip_address:port" or "server:port" format, '
-        "(OR the key does not exist in "
-        "seleniumbase.config.proxy_list.PROXY_LIST)." % proxy_string
-    )
-    if settings.RAISE_INVALID_PROXY_STRING_EXCEPTION:
-        raise Exception(message)
-    else:
-        message += " *** DEFAULTING to NOT USING a Proxy Server! ***"
-        warnings.simplefilter("always", Warning)  # See Warnings
-        warnings.warn(message, category=Warning, stacklevel=2)
-        warnings.simplefilter("default", Warning)  # Set Default
-
-
-def validate_proxy_string(proxy_string):
-    import re
-    from seleniumbase.config import proxy_list
-    from seleniumbase.fixtures import page_utils
-
-    if proxy_string in proxy_list.PROXY_LIST.keys():
-        proxy_string = proxy_list.PROXY_LIST[proxy_string]
-        if not proxy_string:
-            return None
-    valid = False
-    val_ip = re.match(
-        r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:\d+$", proxy_string
-    )
-    if not val_ip:
-        if proxy_string.startswith("http://"):
-            proxy_string = proxy_string.split("http://")[1]
-        elif proxy_string.startswith("https://"):
-            proxy_string = proxy_string.split("https://")[1]
-        elif "://" in proxy_string:
-            if not proxy_string.startswith("socks4://") and not (
-                proxy_string.startswith("socks5://")
-            ):
-                proxy_string = proxy_string.split("://")[1]
-        chunks = proxy_string.split(":")
-        if len(chunks) == 2:
-            if re.match(r"^\d+$", chunks[1]):
-                if page_utils.is_valid_url("http://" + proxy_string):
-                    valid = True
-        elif len(chunks) == 3:
-            if re.match(r"^\d+$", chunks[2]):
-                if page_utils.is_valid_url("http:" + ":".join(chunks[1:])):
-                    if chunks[0] == "http":
-                        valid = True
-                    elif chunks[0] == "https":
-                        valid = True
-                    elif chunks[0] == "socks4":
-                        valid = True
-                    elif chunks[0] == "socks5":
-                        valid = True
-    else:
-        proxy_string = val_ip.group()
-        valid = True
-    if not valid:
-        display_proxy_warning(proxy_string)
-        proxy_string = None
-    return proxy_string
-
-
 def format_exc(exception, message):
     """Formats an exception message to make the output cleaner."""
     from selenium.common.exceptions import ElementNotVisibleException
@@ -198,8 +147,6 @@ def check_if_time_limit_exceeded():
         and sb_config.time_limit
         and not sb_config.recorder_mode
     ):
-        import time
-
         time_limit = sb_config.time_limit
         now_ms = int(time.time() * 1000)
         if now_ms > sb_config.start_time_ms + sb_config.time_limit_ms:

seleniumbase/fixtures/xpath_to_css.py

@@ -1,6 +1,4 @@
-"""
-Convert XPath selectors into CSS selectors
-"""
+"""Convert XPath selectors into CSS selectors"""
 import re
 
 _sub_regexes = {

seleniumbase/plugins/base_plugin.py

@@ -1,4 +1,4 @@
-"""The Nosetest plugin for setting base configuration and logging."""
+"""Base Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import ast
 import sys
 import time

seleniumbase/plugins/basic_test_info.py

@@ -1,4 +1,4 @@
-"""The plugin for saving basic test info for Selenium tests."""
+"""Test Info Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import os
 import codecs
 import time

seleniumbase/plugins/db_reporting_plugin.py

@@ -1,4 +1,4 @@
-"""The plugin for recording test results in the Testcase Database."""
+"""DB Reporting Plugin for SeleniumBase tests that use pynose / nosetests"""
 import time
 import uuid
 from nose.plugins import Plugin
@@ -76,7 +76,7 @@ class DBReporting(Plugin):
         self.testcase_manager.insert_execution_data(exec_payload)
 
     def startTest(self, test):
-        """At the start of the test, set the testcase details."""
+        """At the start of the test, set testcase details."""
         from seleniumbase.core.application_manager import ApplicationManager
         from seleniumbase.core.testcase_manager import TestcaseDataPayload
 

seleniumbase/plugins/driver_manager.py

@@ -111,6 +111,7 @@ def Driver(
     pls=None,  # Shortcut / Duplicate of "page_load_strategy".
 ):
     from seleniumbase.fixtures import constants
+    from seleniumbase.fixtures import shared_utils
 
     sys_argv = sys.argv
     browser_changes = 0
@@ -251,7 +252,7 @@ def Driver(
         recorder_mode = True
         recorder_ext = True
     if (
-        "linux" in sys.platform
+        shared_utils.is_linux()
         and not headed
         and not headless
         and not headless2

seleniumbase/plugins/page_source.py

@@ -1,4 +1,4 @@
-"""The plugin for capturing & storing the page source on errors & failures."""
+"""PageSource Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import os
 import codecs
 from nose.plugins import Plugin
@@ -7,7 +7,7 @@ from seleniumbase.core import log_helper
 
 
 class PageSource(Plugin):
-    """Capture the page source when a test fails or raises an error."""
+    """Capture the page source after a test fails."""
     name = "page_source"  # Usage: --with-page_source
     logfile_name = settings.PAGE_SOURCE_NAME
 
@@ -24,7 +24,6 @@ class PageSource(Plugin):
         try:
             page_source = test.driver.page_source
         except Exception:
-            # Since we can't get the page source from here, skip saving it
             return
         test_logpath = self.options.log_path + "/" + test.id()
         if not os.path.exists(test_logpath):
@@ -41,7 +40,6 @@ class PageSource(Plugin):
         try:
             page_source = test.driver.page_source
         except Exception:
-            # Since we can't get the page source from here, don't save it.
             return
         test_logpath = self.options.log_path + "/" + test.id()
         if not os.path.exists(test_logpath):

seleniumbase/plugins/pytest_plugin.py

@@ -8,10 +8,8 @@ from seleniumbase import config as sb_config
 from seleniumbase.config import settings
 from seleniumbase.core import log_helper
 from seleniumbase.fixtures import constants
+from seleniumbase.fixtures import shared_utils
 
-is_windows = False
-if sys.platform in ["win32", "win64", "x64"]:
-    is_windows = True
 python3_11_or_newer = False
 if sys.version_info >= (3, 11):
     python3_11_or_newer = True
@@ -99,8 +97,8 @@ def pytest_addoption(parser):
     --incognito  (Enable Chrome's Incognito mode.)
     --guest  (Enable Chrome's Guest mode.)
     --devtools  (Open Chrome's DevTools when the browser opens.)
-    --reuse-session | --rs  (Reuse browser session for all tests.)
-    --reuse-class-session | --rcs  (Reuse session for tests in class.)
+    --rs | --reuse-session  (Reuse browser session for all tests.)
+    --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-size=WIDTH,HEIGHT  (Set the browser's starting window size.)
@@ -1854,7 +1852,10 @@ def pytest_runtest_teardown(item):
                         and self.driver
                         and "--pdb" not in sys_argv
                     ):
-                        if not is_windows or self.driver.service.process:
+                        if not (
+                            shared_utils.is_windows()
+                            or self.driver.service.process
+                        ):
                             self.driver.quit()
                 except Exception:
                     pass
@@ -1864,7 +1865,7 @@ def pytest_runtest_teardown(item):
             ):
                 try:
                     if (
-                        not is_windows
+                        not shared_utils.is_windows()
                         or sb_config._sb_pdb_driver.service.process
                     ):
                         sb_config._sb_pdb_driver.quit()
@@ -1982,7 +1983,7 @@ def _perform_pytest_unconfigure_():
         if sb_config.shared_driver:
             try:
                 if (
-                    not is_windows
+                    not shared_utils.is_windows()
                     or sb_config.browser == "ie"
                     or sb_config.shared_driver.service.process
                 ):

seleniumbase/plugins/s3_logging_plugin.py

@@ -1,8 +1,6 @@
-"""The S3 Plugin for uploading test logs to the S3 bucket specified."""
+"""S3 Logging Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import uuid
-import logging
 import os
-from seleniumbase.core.s3_manager import S3LoggingBucket
 from nose.plugins import Plugin
 
 
@@ -14,25 +12,38 @@ class S3Logging(Plugin):
         """Get the options."""
         super().configure(options, conf)
         self.options = options
+        self.test_id = None
+
+    def save_data_to_logs(self, data, file_name):
+        from seleniumbase.fixtures import page_utils
+
+        test_logpath = os.path.join(self.options.log_path, self.test_id)
+        file_name = str(file_name)
+        destination_folder = test_logpath
+        page_utils._save_data_as(data, destination_folder, file_name)
 
     def afterTest(self, test):
-        """After each testcase, upload logs to the S3 bucket."""
+        """Upload logs to the S3 bucket after tests complete."""
+        from seleniumbase.core.s3_manager import S3LoggingBucket
+
+        self.test_id = test.test.id()
         s3_bucket = S3LoggingBucket()
         guid = str(uuid.uuid4().hex)
-        path = os.path.join(self.options.log_path, test.test.id())
+        path = os.path.join(self.options.log_path, self.test_id)
         uploaded_files = []
         for logfile in os.listdir(path):
             logfile_name = "%s/%s/%s" % (
                 guid,
-                test.test.id(),
+                self.test_id,
                 logfile.split(path)[-1],
             )
             s3_bucket.upload_file(logfile_name, os.path.join(path, logfile))
             uploaded_files.append(logfile_name)
         s3_bucket.save_uploaded_file_names(uploaded_files)
-        index_file = s3_bucket.upload_index_file(test.id(), guid)
-        print("\n\n*** Log files uploaded: ***\n%s\n" % index_file)
-        logging.error("\n\n*** Log files uploaded: ***\n%s\n" % index_file)
+        index_file = s3_bucket.upload_index_file(
+            test.id(), guid, path, self.save_data_to_logs
+        )
+        print("\n*** Log files uploaded: ***\n%s\n" % index_file)
 
         # If the SB database plugin is also being used,
         # attach a link to the logs index database row.

seleniumbase/plugins/sb_manager.py

@@ -329,11 +329,11 @@ def SB(
             record_sleep = True
         else:
             record_sleep = False
-    if "linux" not in sys.platform:
+    if not shared_utils.is_linux():
         # The Xvfb virtual display server is for Linux OS Only!
         xvfb = False
     if (
-        "linux" in sys.platform
+        shared_utils.is_linux()
         and not headed
         and not headless
         and not headless2

seleniumbase/plugins/screen_shots.py

@@ -1,11 +1,11 @@
-"""The screenshot plugin for selenium tests that run with nosetests."""
+"""Screenshot Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import os
 from nose.plugins import Plugin
 from seleniumbase.config import settings
 
 
 class ScreenShots(Plugin):
-    """This plugin takes a screenshot when a test fails or raises an error."""
+    """This plugin takes a screenshot when a test fails."""
     name = "screen_shots"
     logfile_name = settings.SCREENSHOT_NAME
 

seleniumbase/plugins/selenium_plugin.py

@@ -1,14 +1,11 @@
-"""The Nosetest plugin for setting Selenium test configuration."""
+"""Selenium Plugin for SeleniumBase tests that run with pynose / nosetests"""
 import sys
 from nose.plugins import Plugin
 from seleniumbase import config as sb_config
 from seleniumbase.config import settings
 from seleniumbase.core import proxy_helper
 from seleniumbase.fixtures import constants
-
-is_windows = False
-if sys.platform in ["win32", "win64", "x64"]:
-    is_windows = True
+from seleniumbase.fixtures import shared_utils
 
 
 class SeleniumBrowser(Plugin):
@@ -1150,7 +1147,7 @@ class SeleniumBrowser(Plugin):
             if str(self.options.port) == "443":
                 test.test.protocol = "https"
         if (
-            "linux" in sys.platform
+            shared_utils.is_linux()
             and not self.options.headed
             and not self.options.headless
             and not self.options.headless2
@@ -1198,7 +1195,7 @@ class SeleniumBrowser(Plugin):
         sb_config.headless_active = False
         self.headless_active = False
         if (
-            "linux" in sys.platform
+            shared_utils.is_linux()
             and (not self.options.headed or self.options.xvfb)
         ):
             width = settings.HEADLESS_START_WIDTH
@@ -1235,7 +1232,7 @@ class SeleniumBrowser(Plugin):
         try:
             # If the browser window is still open, close it now.
             if (
-                not is_windows
+                not shared_utils.is_windows()
                 or test.test.browser == "ie"
                 or self.driver.service.process
             ):