[py] deprecate headless property for Chromium and Firefox Options

titusfortner · titusfortner · commit f56bc12a3f52 · 2023-01-14T17:38:28.000-06:00
diff --git a/py/conftest.py b/py/conftest.py
@@ -165,7 +165,10 @@ def get_options(driver_class, config):
         if not options:
             options = getattr(webdriver, f"{driver_class}Options")()
 
-        options.headless = headless
+        if driver_class == "Chrome" or driver_class == "Edge":
+            options.add_argument("--headless=new")
+        if driver_class == "Firefox":
+            options.add_argument("-headless")
     return options
 
 
diff --git a/py/selenium/webdriver/chromium/options.py b/py/selenium/webdriver/chromium/options.py
@@ -141,15 +141,26 @@ def headless(self) -> bool:
         """
         :Returns: True if the headless argument is set, else False
         """
+        warnings.warn(
+            "headless property is deprecated, instead check for '--headless' in arguments",
+            DeprecationWarning, stacklevel=2
+        )
         return "--headless" in self._arguments
 
     @headless.setter
     def headless(self, value: bool) -> None:
         """
         Sets the headless argument
+        Old headless uses a non-production browser and is set with `--headless`
+        Native headless from v86 - v108 is set with `--headless=chrome`
+        Native headless from v109+ is set with `--headless=new`
         :Args:
           value: boolean value indicating to set the headless option
         """
+        warnings.warn(
+            "headless property is deprecated, instead use add_argument('--headless') or add_argument('--headless=new')",
+            DeprecationWarning, stacklevel=2
+        )
         args = {"--headless"}
         if value is True:
             self._arguments.extend(args)
diff --git a/py/selenium/webdriver/firefox/options.py b/py/selenium/webdriver/firefox/options.py
@@ -106,6 +106,10 @@ def headless(self) -> bool:
         """
         :Returns: True if the headless argument is set, else False
         """
+        warnings.warn(
+            "headless property is deprecated, instead check for '-headless' in arguments",
+            DeprecationWarning, stacklevel=2
+        )
         return "-headless" in self._arguments
 
     @headless.setter
@@ -115,6 +119,10 @@ def headless(self, value: bool) -> None:
         Args:
           value: boolean value indicating to set the headless option
         """
+        warnings.warn(
+            "headless property is deprecated, instead use add_argument('-headless')",
+            DeprecationWarning, stacklevel=2
+        )
         if value:
             self._arguments.append("-headless")
         elif "-headless" in self._arguments:
diff --git a/py/test/unit/selenium/webdriver/chrome/chrome_options_tests.py b/py/test/unit/selenium/webdriver/chrome/chrome_options_tests.py
@@ -112,22 +112,6 @@ def test_get_experimental_options(options):
     assert options.experimental_options["foo"] == "bar"
 
 
-def test_set_headless(options):
-    options.headless = True
-    assert "--headless" in options._arguments
-
-
-def test_unset_headless(options):
-    options._arguments = ["--headless"]
-    options.headless = False
-    assert "--headless" not in options._arguments
-
-
-def test_get_headless(options):
-    options._arguments = ["--headless"]
-    assert options.headless is True
-
-
 def test_creates_capabilities(options):
     options._arguments = ["foo"]
     options._binary_location = "/bar"
diff --git a/py/test/unit/selenium/webdriver/firefox/firefox_options_tests.py b/py/test/unit/selenium/webdriver/firefox/firefox_options_tests.py
@@ -127,22 +127,6 @@ def test_set_log_level(options):
     assert options.log.level == "debug"
 
 
-def test_set_headless(options):
-    options.headless = True
-    assert "-headless" in options._arguments
-
-
-def test_unset_headless(options):
-    options._arguments = ["-headless"]
-    options.headless = False
-    assert "-headless" not in options._arguments
-
-
-def test_get_headless(options):
-    options._arguments = ["-headless"]
-    assert options.headless
-
-
 def test_creates_capabilities(options):
     profile = FirefoxProfile()
     options._arguments = ["foo"]
