Add Dark Mode option

Author: mdmintz

examples/raw_parameter_script.py

@@ -52,6 +52,7 @@
     sb.user_agent = None
     sb.incognito = False
     sb.guest_mode = False
+    sb.dark_mode = False
     sb.devtools = False
     sb.mobile_emulator = False
     sb.device_metrics = None

seleniumbase/behave/behave_sb.py

@@ -81,6 +81,7 @@
 -D swiftshader  (Use Chrome's SwiftShader Graphics Library.)
 -D incognito  (Enable Chrome's Incognito mode.)
 -D guest  (Enable Chrome's Guest mode.)
+-D dark  (Enable Chrome's Dark mode.)
 -D devtools  (Open Chrome's DevTools when the browser opens.)
 -D rs | -D reuse-session  (Reuse browser session for all tests.)
 -D rcs | -D reuse-class-session  (Reuse session for tests in class/feature)
@@ -156,6 +157,7 @@ def get_configured_sb(context):
     sb.user_agent = None
     sb.incognito = False
     sb.guest_mode = False
+    sb.dark_mode = False
     sb.devtools = False
     sb.mobile_emulator = False
     sb.device_metrics = None
@@ -417,6 +419,10 @@ def get_configured_sb(context):
         if low_key in ["guest", "guest-mode", "guest_mode"]:
             sb.guest_mode = True
             continue
+        # Handle: -D dark / dark-mode / dark_mode
+        if low_key in ["dark", "dark-mode", "dark_mode"]:
+            sb.dark_mode = True
+            continue
         # Handle: -D devtools / open-devtools / open_devtools
         if low_key in ["devtools", "open-devtools", "open_devtools"]:
             sb.devtools = True

seleniumbase/core/browser_launcher.py

@@ -510,6 +510,7 @@ def _set_chrome_options(
     headless2,
     incognito,
     guest_mode,
+    dark_mode,
     devtools,
     remote_debug,
     enable_3d_apis,
@@ -662,6 +663,8 @@ def _set_chrome_options(
             chrome_options.add_argument("--guest")
         else:
             pass
+    if dark_mode:
+        chrome_options.add_argument("--enable-features=WebContentsForceDark")
     if user_data_dir and not is_using_uc(undetectable, browser_name):
         abs_path = os.path.abspath(user_data_dir)
         chrome_options.add_argument("--user-data-dir=%s" % abs_path)
@@ -1067,6 +1070,7 @@ def get_driver(
     headless2=False,
     incognito=False,
     guest_mode=False,
+    dark_mode=False,
     devtools=False,
     remote_debug=False,
     enable_3d_apis=False,
@@ -1273,6 +1277,7 @@ def get_driver(
             headless2,
             incognito,
             guest_mode,
+            dark_mode,
             devtools,
             remote_debug,
             enable_3d_apis,
@@ -1324,6 +1329,7 @@ def get_driver(
             headless2,
             incognito,
             guest_mode,
+            dark_mode,
             devtools,
             remote_debug,
             enable_3d_apis,
@@ -1379,6 +1385,7 @@ def get_remote_driver(
     headless2,
     incognito,
     guest_mode,
+    dark_mode,
     devtools,
     remote_debug,
     enable_3d_apis,
@@ -1499,6 +1506,7 @@ def get_remote_driver(
             headless2,
             incognito,
             guest_mode,
+            dark_mode,
             devtools,
             remote_debug,
             enable_3d_apis,
@@ -1688,6 +1696,7 @@ def get_remote_driver(
             headless2,
             incognito,
             guest_mode,
+            dark_mode,
             devtools,
             remote_debug,
             enable_3d_apis,
@@ -1809,6 +1818,7 @@ def get_remote_driver(
             headless2,
             incognito,
             guest_mode,
+            dark_mode,
             devtools,
             remote_debug,
             enable_3d_apis,
@@ -1928,6 +1938,7 @@ def get_local_driver(
     headless2,
     incognito,
     guest_mode,
+    dark_mode,
     devtools,
     remote_debug,
     enable_3d_apis,
@@ -2329,6 +2340,8 @@ def get_local_driver(
             and not recorder_ext and not disable_csp and not proxy_auth
         ):
             edge_options.add_argument("--guest")
+        if dark_mode:
+            edge_options.add_argument("--enable-features=WebContentsForceDark")
         if headless2:
             try:
                 if use_version == "latest" or int(use_version) >= 109:
@@ -2728,6 +2741,7 @@ def get_local_driver(
                 headless2,
                 incognito,
                 guest_mode,
+                dark_mode,
                 devtools,
                 remote_debug,
                 enable_3d_apis,
@@ -2783,6 +2797,7 @@ def get_local_driver(
                 headless2,
                 incognito,
                 guest_mode,
+                dark_mode,
                 devtools,
                 remote_debug,
                 enable_3d_apis,
@@ -3259,6 +3274,7 @@ def get_local_driver(
                         headless2,
                         incognito,
                         guest_mode,
+                        dark_mode,
                         devtools,
                         remote_debug,
                         enable_3d_apis,

seleniumbase/fixtures/base_case.py

@@ -3601,6 +3601,7 @@ def get_new_driver(
         headless2=None,
         incognito=None,
         guest_mode=None,
+        dark_mode=None,
         devtools=None,
         remote_debug=None,
         enable_3d_apis=None,
@@ -3654,7 +3655,8 @@ def get_new_driver(
         disable_gpu - the option to enable Chrome's "Disable GPU" feature
         headless2 - the option to use the newer headless mode (Chromium)
         incognito - the option to enable Chrome's Incognito mode (Chrome)
-        guest - the option to enable Chrome's Guest mode (Chrome)
+        guest_mode - the option to enable Chrome's Guest mode (Chrome)
+        dark_mode - the option to enable Chrome's Dark mode (Chrome)
         devtools - the option to open Chrome's DevTools on start (Chrome)
         remote_debug - the option to enable Chrome's Remote Debugger
         enable_3d_apis - the option to enable WebGL and 3D APIs (Chrome)
@@ -3763,6 +3765,8 @@ def get_new_driver(
             incognito = self.incognito
         if guest_mode is None:
             guest_mode = self.guest_mode
+        if dark_mode is None:
+            dark_mode = self.dark_mode
         if devtools is None:
             devtools = self.devtools
         if remote_debug is None:
@@ -3855,6 +3859,7 @@ def get_new_driver(
             headless2=headless2,
             incognito=incognito,
             guest_mode=guest_mode,
+            dark_mode=dark_mode,
             devtools=devtools,
             remote_debug=remote_debug,
             enable_3d_apis=enable_3d_apis,
@@ -13846,6 +13851,7 @@ def setUp(self, masterqa_mode=False):
             self.headless2 = sb_config.headless2
             self.incognito = sb_config.incognito
             self.guest_mode = sb_config.guest_mode
+            self.dark_mode = sb_config.dark_mode
             self.devtools = sb_config.devtools
             self.remote_debug = sb_config.remote_debug
             self._multithreaded = sb_config._multithreaded
@@ -14169,6 +14175,7 @@ def setUp(self, masterqa_mode=False):
                 headless2=self.headless2,
                 incognito=self.incognito,
                 guest_mode=self.guest_mode,
+                dark_mode=self.dark_mode,
                 devtools=self.devtools,
                 remote_debug=self.remote_debug,
                 enable_3d_apis=self.enable_3d_apis,

seleniumbase/plugins/driver_manager.py

@@ -81,6 +81,7 @@ def Driver(
     disable_gpu=None,  # (DEPRECATED) - GPU is disabled if no "swiftshader".
     incognito=None,  # Enable Chromium's Incognito mode.
     guest_mode=None,  # Enable Chromium's Guest mode.
+    dark_mode=None,  # Enable Chromium's Dark mode.
     devtools=None,  # Open Chromium's DevTools when the browser opens.
     remote_debug=None,  # Enable Chrome's Debugger on "http://localhost:9222".
     enable_3d_apis=None,  # Enable WebGL and 3D APIs.
@@ -226,6 +227,11 @@ def Driver(
             guest_mode = True
         else:
             guest_mode = False
+    if dark_mode is None:
+        if "--dark" in sys_argv:
+            dark_mode = True
+        else:
+            dark_mode = False
     if devtools is None:
         if "--devtools" in sys_argv:
             devtools = True
@@ -423,6 +429,7 @@ def Driver(
         headless2=headless2,
         incognito=incognito,
         guest_mode=guest_mode,
+        dark_mode=dark_mode,
         devtools=devtools,
         remote_debug=remote_debug,
         enable_3d_apis=enable_3d_apis,

seleniumbase/plugins/pytest_plugin.py

@@ -96,6 +96,7 @@ def pytest_addoption(parser):
     --swiftshader  (Use Chrome's "--use-gl=swiftshader" feature.)
     --incognito  (Enable Chrome's Incognito mode.)
     --guest  (Enable Chrome's Guest mode.)
+    --dark  (Enable Chrome's Dark mode.)
     --devtools  (Open Chrome's DevTools when the browser opens.)
     --rs | --reuse-session  (Reuse browser session for all tests.)
     --rcs | --reuse-class-session  (Reuse session for tests in class.)
@@ -1082,6 +1083,15 @@ def pytest_addoption(parser):
         default=False,
         help="""Using this enables Chrome's Guest mode.""",
     )
+    parser.addoption(
+        "--dark",
+        "--dark_mode",
+        "--dark-mode",
+        action="store_true",
+        dest="dark_mode",
+        default=False,
+        help="""Using this enables Chrome's Dark mode.""",
+    )
     parser.addoption(
         "--devtools",
         "--open_devtools",
@@ -1523,6 +1533,7 @@ def pytest_configure(config):
     sb_config.swiftshader = config.getoption("swiftshader")
     sb_config.incognito = config.getoption("incognito")
     sb_config.guest_mode = config.getoption("guest_mode")
+    sb_config.dark_mode = config.getoption("dark_mode")
     sb_config.devtools = config.getoption("devtools")
     sb_config.reuse_session = config.getoption("reuse_session")
     sb_config.reuse_class_session = config.getoption("reuse_class_session")

seleniumbase/plugins/sb_manager.py

@@ -50,6 +50,7 @@ def SB(
     uc_subprocess=None,  # Use undetected-chromedriver as a subprocess.
     incognito=None,  # Enable Chromium's Incognito mode.
     guest_mode=None,  # Enable Chromium's Guest mode.
+    dark_mode=None,  # Enable Chromium's Dark mode.
     devtools=None,  # Open Chromium's DevTools when the browser opens.
     remote_debug=None,  # Enable Chrome's Debugger on "http://localhost:9222".
     enable_3d_apis=None,  # Enable WebGL and 3D APIs.
@@ -290,6 +291,11 @@ def SB(
             guest_mode = True
         else:
             guest_mode = False
+    if dark_mode is None:
+        if "--dark" in sys_argv:
+            dark_mode = True
+        else:
+            dark_mode = False
     if devtools is None:
         if "--devtools" in sys_argv:
             devtools = True
@@ -605,6 +611,7 @@ def SB(
     sb_config.user_agent = user_agent
     sb_config.incognito = incognito
     sb_config.guest_mode = guest_mode
+    sb_config.dark_mode = dark_mode
     sb_config.devtools = devtools
     sb_config.mobile_emulator = is_mobile
     sb_config.device_metrics = device_metrics
@@ -703,6 +710,7 @@ def SB(
     sb.user_agent = sb_config.user_agent
     sb.incognito = sb_config.incognito
     sb.guest_mode = sb_config.guest_mode
+    sb.dark_mode = sb_config.dark_mode
     sb.devtools = sb_config.devtools
     sb.binary_location = sb_config.binary_location
     sb.mobile_emulator = sb_config.mobile_emulator

seleniumbase/plugins/selenium_plugin.py

@@ -74,6 +74,7 @@ class SeleniumBrowser(Plugin):
     --swiftshader  (Use Chrome's "--use-gl=swiftshader" feature.)
     --incognito  (Enable Chrome's Incognito mode.)
     --guest  (Enable Chrome's Guest mode.)
+    --dark  (Enable Chrome's Dark mode.)
     --devtools  (Open Chrome's DevTools when the browser opens.)
     --disable-beforeunload  (Disable the "beforeunload" event on Chrome.)
     --window-size=WIDTH,HEIGHT  (Set the browser's starting window size.)
@@ -800,6 +801,15 @@ def options(self, parser, env):
             default=False,
             help="""Using this enables Chrome's Guest mode.""",
         )
+        parser.addoption(
+            "--dark",
+            "--dark_mode",
+            "--dark-mode",
+            action="store_true",
+            dest="dark_mode",
+            default=False,
+            help="""Using this enables Chrome's Dark mode.""",
+        )
         parser.addoption(
             "--devtools",
             "--open_devtools",
@@ -1125,6 +1135,7 @@ def beforeTest(self, test):
         test.test.swiftshader = self.options.swiftshader
         test.test.incognito = self.options.incognito
         test.test.guest_mode = self.options.guest_mode
+        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_size = self.options.window_size