Merge pull request #2166 from seleniumbase/graphics-library-and-colorama-refactoring

Refactor Colorama, update graphics library, and add raw `driver` methods

Author: mdmintz

README.md

@@ -698,7 +698,7 @@ pytest test_coffee_cart.py --trace
 --dashboard  # (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 --dash-title=STRING  # (Set the title shown for the generated dashboard.)
 --enable-3d-apis  # (Enables WebGL and 3D APIs.)
---swiftshader  # (Use Chrome's "--use-gl=swiftshader" feature.)
+--swiftshader  # (Chrome "--use-gl=angle" / "--use-angle=swiftshader-webgl")
 --incognito  # (Enable Chrome's Incognito mode.)
 --guest  # (Enable Chrome's Guest mode.)
 --dark  # (Enable Chrome's Dark mode.)

examples/raw_parameter_script.py

@@ -117,8 +117,8 @@
     sb.proxy_string = None
     sb.proxy_bypass_list = None
     sb.proxy_pac_url = None
+    sb._swiftshader = False
     sb.multi_proxy = False
-    sb.swiftshader = False
     sb.ad_block_on = False
     sb.highlights = None
     sb.interval = None

examples/test_chromedriver.py

@@ -1,6 +1,7 @@
 """This test is only for Chrome!
 (Verify that your chromedriver is compatible with your version of Chrome.)"""
 import colorama
+import sys
 from seleniumbase import BaseCase
 BaseCase.main(__name__, __file__)
 
@@ -15,7 +16,13 @@ def test_chromedriver_matches_chrome(self):
         major_chrome_version = chrome_version.split(".")[0]
         chromedriver_version = self.get_chromedriver_version()
         major_chromedriver_version = chromedriver_version.split(".")[0]
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
         c3 = colorama.Fore.BLUE + colorama.Back.LIGHTYELLOW_EX

examples/translations/dutch_test_1.py

@@ -6,14 +6,14 @@
 class MijnTestklasse(Testgeval):
     def test_voorbeeld_1(self):
         self.openen("https://nl.wikipedia.org/wiki/Hoofdpagina")
-        self.controleren_element('a[title*="hoofdpagina gaan"]')
+        self.controleren_element('a[title*="Welkom voor nieuwkomers"]')
         self.controleren_tekst("Welkom op Wikipedia", "td.hp-welkom")
-        self.typ("#searchInput", "Stroopwafel")
-        self.klik("#searchButton")
+        self.typ("#searchform input", "Stroopwafel")
+        self.klik("#searchform button")
         self.controleren_tekst("Stroopwafel", "#firstHeading")
         self.controleren_element('img[src*="Stroopwafels"]')
-        self.typ("#searchInput", "Rijksmuseum Amsterdam")
-        self.klik("#searchButton")
+        self.typ("#searchform input", "Rijksmuseum Amsterdam")
+        self.klik("#searchform button")
         self.controleren_tekst("Rijksmuseum", "#firstHeading")
         self.controleren_element('img[src*="Rijksmuseum"]')
         self.terug()

help_docs/customizing_test_runs.md

@@ -178,7 +178,7 @@ pytest my_first_test.py --settings-file=custom_settings.py
 --dashboard  # (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 --dash-title=STRING  # (Set the title shown for the generated dashboard.)
 --enable-3d-apis  # (Enables WebGL and 3D APIs.)
---swiftshader  # (Use Chrome's "--use-gl=swiftshader" feature.)
+--swiftshader  # (Chrome "--use-gl=angle" / "--use-angle=swiftshader-webgl")
 --incognito  # (Enable Chrome's Incognito mode.)
 --guest  # (Enable Chrome's Guest mode.)
 --dark  # (Enable Chrome's Dark mode.)

mkdocs.yml

@@ -180,6 +180,6 @@ nav:
 extra:
   analytics:
     provider: google
-    # property: G-P5KFWRNLRN
-    property: UA-167313767-1
-# google_analytics: ['UA-167313767-1', 'seleniumbase.io']
+    property: G-P5KFWRNLRN
+    # property: UA-167313767-1
+# google_analytics: ['G-P5KFWRNLRN', 'seleniumbase.io']

mkdocs_build/requirements.txt

@@ -1,12 +1,12 @@
 # mkdocs dependencies for generating the seleniumbase.io website
 # Minimum Python version: 3.8 (for generating docs only)
 
-regex>=2023.8.8
+regex>=2023.10.3
 PyYAML>=6.0.1
 pymdown-extensions>=10.3
 pipdeptree>=2.13.0
 python-dateutil>=2.8.2
-Markdown==3.4.4
+Markdown==3.5
 markdown2==2.4.10
 MarkupSafe==2.1.3
 Jinja2==3.1.2
@@ -15,12 +15,12 @@ ghp-import==2.1.0
 watchdog==3.0.0
 cairocffi==1.6.1
 pathspec==0.11.2
-Babel==2.12.1
+Babel==2.13.0
 paginate==0.5.6
 pyquery==2.0.0
 readtime==3.0.0
 mkdocs==1.5.3
-mkdocs-material==9.4.2
+mkdocs-material==9.4.4
 mkdocs-exclude-search==0.6.5
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.2

requirements.txt

@@ -7,7 +7,7 @@ attrs>=23.1.0
 certifi>=2023.7.22
 filelock>=3.12.2;python_version<"3.8"
 filelock>=3.12.4;python_version>="3.8"
-platformdirs>=3.10.0
+platformdirs>=3.11.0
 parse>=1.19.1
 parse-type>=0.6.2
 six==1.16.0
@@ -63,7 +63,7 @@ rich==13.6.0
 
 coverage==6.2;python_version<"3.7"
 coverage==7.2.7;python_version>="3.7" and python_version<"3.8"
-coverage==7.3.1;python_version>="3.8"
+coverage==7.3.2;python_version>="3.8"
 pytest-cov==4.0.0;python_version<"3.7"
 pytest-cov==4.1.0;python_version>="3.7"
 flake8==5.0.4;python_version<"3.9"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.19.1"
+__version__ = "4.19.2"

seleniumbase/behave/behave_sb.py

@@ -111,6 +111,8 @@
 from seleniumbase.fixtures import constants
 from seleniumbase.fixtures import shared_utils
 
+is_linux = shared_utils.is_linux()
+is_windows = shared_utils.is_windows()
 sb_config.__base_class = None
 
 
@@ -829,10 +831,10 @@ def get_configured_sb(context):
             '\n  (Your browser choice was: "%s")\n' % sb.browser
         )
     # The Xvfb virtual display server is for Linux OS Only.
-    if sb.xvfb and not shared_utils.is_linux():
+    if sb.xvfb and not is_linux:
         sb.xvfb = False
     if (
-        shared_utils.is_linux()
+        is_linux
         and not sb.headed
         and not sb.headless
         and not sb.headless2
@@ -1020,7 +1022,7 @@ def dashboard_pre_processing():
     filename = None
     feature_name = None
     scenario_name = None
-    if shared_utils.is_windows():
+    if is_windows:
         output = output.decode("latin1")
     else:
         output = output.decode("utf-8")
@@ -1129,8 +1131,11 @@ def behave_dashboard_prepare():
         stars = "*" * star_len
         c1 = ""
         cr = ""
-        if not shared_utils.is_linux():
-            colorama.init(autoreset=True)
+        if not is_linux:
+            if is_windows and hasattr(colorama, "just_fix_windows_console"):
+                colorama.just_fix_windows_console()
+            else:
+                colorama.init(autoreset=True)
             c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
             cr = colorama.Style.RESET_ALL
         print("Dashboard: %s%s%s\n%s" % (c1, dash_path, cr, stars))
@@ -1144,7 +1149,7 @@ def _perform_behave_unconfigure_():
         if sb_config.shared_driver:
             try:
                 if (
-                    not shared_utils.is_windows()
+                    not is_windows
                     or sb_config.browser == "ie"
                     or sb_config.shared_driver.service.process
                 ):
@@ -1221,7 +1226,7 @@ def do_final_driver_cleanup_as_needed():
     try:
         if hasattr(sb_config, "last_driver") and sb_config.last_driver:
             if (
-                not shared_utils.is_windows()
+                not is_windows
                 or sb_config.browser == "ie"
                 or sb_config.last_driver.service.process
             ):
@@ -1245,8 +1250,11 @@ def _perform_behave_terminal_summary_():
     equals = "=" * (equals_len + 2)
     c2 = ""
     cr = ""
-    if not shared_utils.is_linux():
-        colorama.init(autoreset=True)
+    if not is_linux:
+        if is_windows and hasattr(colorama, "just_fix_windows_console"):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c2 = colorama.Fore.MAGENTA + colorama.Back.LIGHTYELLOW_EX
         cr = colorama.Style.RESET_ALL
     if sb_config.dashboard:

seleniumbase/console_scripts/logo_helper.py

@@ -3,6 +3,7 @@
     http://www.patorjk.com/software/taag/#p=display&f=Slant&t=SeleniumBase """
 
 import colorama
+import sys
 
 r"""
    ______     __           _                  ____
@@ -14,7 +15,13 @@
 
 
 def get_seleniumbase_logo():
-    colorama.init(autoreset=True)
+    if (
+        "win32" in sys.platform
+        and hasattr(colorama, "just_fix_windows_console")
+    ):
+        colorama.just_fix_windows_console()
+    else:
+        colorama.init(autoreset=True)
     c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
     c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
     c3 = colorama.Back.CYAN

seleniumbase/console_scripts/run.py

@@ -41,8 +41,12 @@
 import time
 from seleniumbase.config import settings
 from seleniumbase.fixtures import constants
+from seleniumbase.fixtures import shared_utils
 
-colorama.init(autoreset=True)
+if shared_utils.is_windows() and hasattr(colorama, "just_fix_windows_console"):
+    colorama.just_fix_windows_console()
+else:
+    colorama.init(autoreset=True)
 
 
 def show_usage():
@@ -1330,7 +1334,6 @@ def main():
         show_detailed_help()
     else:
         show_usage()
-        colorama.init(autoreset=True)
         c5 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
         c7 = colorama.Fore.BLACK + colorama.Back.MAGENTA
         cr = colorama.Style.RESET_ALL

seleniumbase/console_scripts/sb_behave_gui.py

@@ -38,7 +38,13 @@ def set_colors(use_colors):
     c6 = ""
     cr = ""
     if use_colors:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c0 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
         c2 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX

seleniumbase/console_scripts/sb_caseplans.py

@@ -42,7 +42,13 @@ def set_colors(use_colors):
     c5 = ""
     cr = ""
     if use_colors:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c0 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
         c2 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX

seleniumbase/console_scripts/sb_commander.py

@@ -42,7 +42,13 @@ def set_colors(use_colors):
     c5 = ""
     cr = ""
     if use_colors:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c0 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
         c2 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX

seleniumbase/console_scripts/sb_install.py

@@ -293,7 +293,10 @@ def main(override=None, intel_for_uc=None, force_uc=None):
     use_version = ""
     new_file = ""
     f_name = ""
-    colorama.init(autoreset=True)
+    if IS_WINDOWS and hasattr(colorama, "just_fix_windows_console"):
+        colorama.just_fix_windows_console()
+    else:
+        colorama.init(autoreset=True)
     c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
     c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
     c3 = colorama.Fore.BLUE + colorama.Back.LIGHTYELLOW_EX

seleniumbase/console_scripts/sb_mkchart.py

@@ -62,7 +62,13 @@ def main():
     c7 = ""
     cr = ""
     if "linux" not in sys.platform:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c5 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
         c7 = colorama.Fore.BLACK + colorama.Back.MAGENTA

seleniumbase/console_scripts/sb_mkdir.py

@@ -54,7 +54,13 @@ def main():
     c7 = ""
     cr = ""
     if "linux" not in sys.platform:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c5 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
         c7 = colorama.Fore.BLACK + colorama.Back.MAGENTA

seleniumbase/console_scripts/sb_mkfile.py

@@ -92,7 +92,13 @@ def main():
     c7 = ""
     cr = ""
     if "linux" not in sys.platform:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c5 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
         c7 = colorama.Fore.BLACK + colorama.Back.MAGENTA

seleniumbase/console_scripts/sb_mkpres.py

@@ -62,7 +62,13 @@ def main():
     c7 = ""
     cr = ""
     if "linux" not in sys.platform:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c5 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
         c7 = colorama.Fore.BLACK + colorama.Back.MAGENTA

seleniumbase/console_scripts/sb_mkrec.py

@@ -71,7 +71,13 @@ def set_colors(use_colors):
     c7 = ""
     cr = ""
     if use_colors:
-        colorama.init(autoreset=True)
+        if (
+            "win32" in sys.platform
+            and hasattr(colorama, "just_fix_windows_console")
+        ):
+            colorama.just_fix_windows_console()
+        else:
+            colorama.init(autoreset=True)
         c0 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
         c1 = colorama.Fore.RED + colorama.Back.LIGHTYELLOW_EX
         c2 = colorama.Fore.LIGHTRED_EX + colorama.Back.LIGHTYELLOW_EX