Refactoring

Author: mdmintz

seleniumbase/core/application_manager.py

@@ -1,14 +1,8 @@
-"""
-Method for generating application strings used in the Testcase Database.
-"""
-
 import time
 
 
 class ApplicationManager:
-    """
-    This class contains methods to generate application strings.
-    """
+    """Generating application strings for the Testcase Database."""
 
     @classmethod
     def generate_application_string(cls, test):

seleniumbase/core/proxy_helper.py

@@ -13,7 +13,7 @@ def create_proxy_ext(proxy_string, proxy_user, proxy_pass, zip_it=True):
     """Implementation of https://stackoverflow.com/a/35293284 for
     https://stackoverflow.com/questions/12848327/
     (Run Selenium on a proxy server that requires authentication.)
-    Solution involves creating & adding a Chromium extension on the fly.
+    Solution involves creating & adding a Chromium extension at runtime.
     CHROMIUM-ONLY! *** Only Chrome and Edge browsers are supported. ***
     """
     background_js = None
@@ -94,7 +94,7 @@ def create_proxy_ext(proxy_string, proxy_user, proxy_pass, zip_it=True):
     )
     import threading
 
-    lock = threading.RLock()  # Support multi-threaded test runs with Pytest
+    lock = threading.RLock()  # Support multi-threaded tests. Eg. "pytest -n=4"
     with lock:
         abs_path = os.path.abspath(".")
         downloads_path = os.path.join(abs_path, DOWNLOADS_DIR)

seleniumbase/fixtures/base_case.py

@@ -61,6 +61,7 @@ def test_anything(self):
 from selenium.webdriver.remote.remote_connection import LOGGER
 from seleniumbase import config as sb_config
 from seleniumbase.__version__ import __version__
+from seleniumbase.common import decorators
 from seleniumbase.config import settings
 from seleniumbase.core import download_helper
 from seleniumbase.core import log_helper
@@ -170,9 +171,9 @@ def open(self, url):
         self.__check_scope()
         self.__check_browser()
         if self.__needs_minimum_wait():
-            time.sleep(0.01)
+            time.sleep(0.025)
             if self.undetectable:
-                time.sleep(0.02)
+                time.sleep(0.025)
         pre_action_url = None
         try:
             pre_action_url = self.driver.current_url
@@ -3851,6 +3852,13 @@ def install_addon(self, xpi_file):
         xpi_path = os.path.abspath(xpi_file)
         self.driver.install_addon(xpi_path, temporary=True)
 
+    def activate_jquery(self):
+        """If "jQuery is not defined", use this method to activate it for use.
+        This happens because jQuery is not always defined on web sites."""
+        self.wait_for_ready_state_complete()
+        js_utils.activate_jquery(self.driver)
+        self.wait_for_ready_state_complete()
+
     def activate_demo_mode(self):
         self.demo_mode = True
 
@@ -4945,22 +4953,6 @@ def __process_recorded_behave_actions(self, srt_actions, colorama):
             out_file.close()
             print("Created recordings/features/steps/imported.py")
 
-    def activate_jquery(self):
-        """If "jQuery is not defined", use this method to activate it for use.
-        This happens because jQuery is not always defined on web sites."""
-        self.wait_for_ready_state_complete()
-        js_utils.activate_jquery(self.driver)
-        self.wait_for_ready_state_complete()
-
-    def __are_quotes_escaped(self, string):
-        return js_utils.are_quotes_escaped(string)
-
-    def __escape_quotes_if_needed(self, string):
-        return js_utils.escape_quotes_if_needed(string)
-
-    def __is_in_frame(self):
-        return js_utils.is_in_frame(self.driver)
-
     def bring_active_window_to_front(self):
         """Brings the active browser window to the front.
         This is useful when multiple drivers are being used."""
@@ -6813,16 +6805,8 @@ def get_chromedriver_version(self):
         return chromedriver_version
 
     def is_chromedriver_too_old(self):
-        """There are known issues with chromedriver versions below 73.
-        This can impact tests that need to hover over an element, or ones
-        that require a custom downloads folder ("./downloaded_files").
-        Due to the situation that newer versions of chromedriver require
-        an exact match to the version of Chrome, an "old" version of
-        chromedriver is installed by default. It is then up to the user
-        to upgrade to the correct version of chromedriver from there.
-        This method can be used to change test behavior when trying
-        to perform an action that is impacted by having an old version
-        of chromedriver installed."""
+        """Before chromedriver 73, there was no version check, which
+        means it's possible to run a new Chrome with old drivers."""
         self.__check_scope()
         self.__fail_if_not_using_chrome("is_chromedriver_too_old()")
         if int(self.get_chromedriver_version().split(".")[0]) < 73:
@@ -8189,9 +8173,6 @@ def _print(self, msg):
         else:
             print(msg)
 
-    def start_tour(self, name=None, interval=0):
-        self.play_tour(name=name, interval=interval)
-
     ############
 
     def add_css_link(self, css_link):
@@ -9960,7 +9941,6 @@ def play_tour(self, name=None, interval=0):
                 interval=interval,
             )
         else:
-            # "Shepherd"
             tour_helper.play_shepherd_tour(
                 self.driver,
                 self._tour_steps,
@@ -9969,6 +9949,10 @@ def play_tour(self, name=None, interval=0):
                 interval=interval,
             )
 
+    def start_tour(self, name=None, interval=0):
+        """Same as self.play_tour()"""
+        self.play_tour(name=name, interval=interval)
+
     def export_tour(self, name=None, filename="my_tour.js", url=None):
         """Exports a tour as a JS file.
         You can call self.export_tour() anywhere where you would
@@ -11425,6 +11409,17 @@ def quit_extra_driver(self, driver=None):
 
     ############
 
+    def __are_quotes_escaped(self, string):
+        return js_utils.are_quotes_escaped(string)
+
+    def __escape_quotes_if_needed(self, string):
+        return js_utils.escape_quotes_if_needed(string)
+
+    def __is_in_frame(self):
+        return js_utils.is_in_frame(self.driver)
+
+    ############
+
     def __assert_eq(self, *args, **kwargs):
         """Minified assert_equal() using only the list diff."""
         minified_exception = None
@@ -12826,8 +12821,6 @@ def __activate_virtual_display_as_needed(self):
 
     ############
 
-    from seleniumbase.common import decorators
-
     @decorators.deprecated("You should use re.escape() instead.")
     def jq_format(self, code):
         # DEPRECATED - re.escape() already performs the intended action.

seleniumbase/fixtures/shared_utils.py

@@ -1,6 +1,5 @@
-"""
-This module contains shared utility methods.
-"""
+"""Shared utility methods."""
+
 import subprocess
 import sys
 from seleniumbase.fixtures import constants
@@ -50,9 +49,7 @@ def get_terminal_width():
 
 
 def format_exc(exception, message):
-    """
-    Formats an exception message to make the output cleaner.
-    """
+    """Formats an exception message to make the output cleaner."""
     from selenium.common.exceptions import ElementNotVisibleException
     from selenium.common.exceptions import NoAlertPresentException
     from selenium.common.exceptions import NoSuchAttributeException