[py] added decorator for handling deprecations.

py/selenium/deprecated.py

@@ -0,0 +1,31 @@
+from warnings import warn
+
+removed_from_version = "4.12"
+
+
+def deprecated_function(message):
+    """decorator to log deprecation warning messgaes for deprecated methods."""
+
+    def _deprecated_function(func):
+        def wrapper(*args, **kwargs):
+            warn(f"{message}: will be removed from {removed_from_version}", DeprecationWarning, stacklevel=2)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return _deprecated_function
+
+
+def deprecated_attributes(*attrs, message):
+    def _deprecated_attributes(func):
+        def wrapper(*args, **kwargs):
+            result = func(*args, **kwargs)
+            for attr in attrs:
+                _attr = getattr(args[0], attr, None)
+                if _attr:
+                    warn(f"'{message}': will be removed from {removed_from_version}", DeprecationWarning, stacklevel=2)
+            return result
+
+        return wrapper
+
+    return _deprecated_attributes

py/selenium/webdriver/chromium/options.py

@@ -17,11 +17,11 @@
 
 import base64
 import os
-import warnings
 from typing import BinaryIO
 from typing import List
 from typing import Union
 
+from selenium.deprecated import deprecated_function
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.common.options import ArgOptions
 
@@ -139,18 +139,17 @@ def add_experimental_option(self, name: str, value: Union[str, int, dict, List[s
         self._experimental_options[name] = value
 
     @property
+    @deprecated_function("headless property is deprecated, instead check for '--headless' in arguments")
     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
+    @deprecated_function(
+        "headless property is deprecated, instead use add_argument('--headless') or add_argument('--headless=new')"
+    )
     def headless(self, value: bool) -> None:
         """Sets the headless argument Old headless uses a non-production
         browser and is set with `--headless`
@@ -160,11 +159,6 @@ 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') or add_argument('--headless=new')",
-            DeprecationWarning,
-            stacklevel=2,
-        )
         args = {"--headless"}
 
         if not isinstance(value, bool):

py/selenium/webdriver/chromium/service.py

@@ -15,9 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 import typing
-import warnings
 
 from selenium.common import InvalidArgumentException
+from selenium.deprecated import deprecated_attributes
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.common import service
 
@@ -33,6 +33,7 @@ class ChromiumService(service.Service):
     :param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
     """
 
+    @deprecated_attributes("log_path", message="log_path has been deprecated, please use log_output")
     def __init__(
         self,
         executable_path: str = None,
@@ -45,9 +46,7 @@ def __init__(
     ) -> None:
         self.service_args = service_args or []
         self.log_output = log_output
-        if log_path is not None:
-            warnings.warn("log_path has been deprecated, please use log_output", DeprecationWarning, stacklevel=2)
-            self.log_output = log_path
+        self.log_output = log_path
 
         if "--append-log" in self.service_args or "--readable-timestamp" in self.service_args:
             if isinstance(self.log_output, str):

py/selenium/webdriver/edge/service.py

@@ -15,8 +15,8 @@
 # specific language governing permissions and limitations
 # under the License.
 import typing
-import warnings
 
+from selenium.deprecated import deprecated_attributes
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.chromium import service
 
@@ -34,6 +34,9 @@ class Service(service.ChromiumService):
     :param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
     """
 
+    @deprecated_attributes(
+        "verbose", message="verbose=True is deprecated. Use `service_args=['--verbose', ...]` instead."
+    )
     def __init__(
         self,
         executable_path: str = None,
@@ -46,13 +49,7 @@ def __init__(
         **kwargs,
     ) -> None:
         self.service_args = service_args or []
-
         if verbose:
-            warnings.warn(
-                "verbose=True is deprecated. Use `service_args=['--verbose', ...]` instead.",
-                DeprecationWarning,
-                stacklevel=2,
-            )
             self.service_args.append("--verbose")
 
         super().__init__(

py/selenium/webdriver/firefox/firefox_profile.py

@@ -29,6 +29,7 @@
 from xml.dom import minidom
 
 from selenium.common.exceptions import WebDriverException
+from selenium.deprecated import deprecated_function
 
 WEBDRIVER_EXT = "webdriver.xpi"
 WEBDRIVER_PREFERENCES = "webdriver_prefs.json"
@@ -43,6 +44,7 @@ class FirefoxProfile:
     ANONYMOUS_PROFILE_NAME = "WEBDRIVER_ANONYMOUS_PROFILE"
     DEFAULT_PREFERENCES = None
 
+    @deprecated_function("firefox_profile has been deprecated, please use an Options object")
     def __init__(self, profile_directory=None):
         """Initialises a new instance of a Firefox Profile.
 
@@ -53,9 +55,6 @@ def __init__(self, profile_directory=None):
            This defaults to None and will create a new
            directory when object is created.
         """
-        warnings.warn(
-            "firefox_profile has been deprecated, please use an Options object", DeprecationWarning, stacklevel=2
-        )
         if not FirefoxProfile.DEFAULT_PREFERENCES:
             with open(
                 os.path.join(os.path.dirname(__file__), WEBDRIVER_PREFERENCES), encoding="utf-8"

py/selenium/webdriver/firefox/options.py

@@ -15,9 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 import typing
-import warnings
 from typing import Union
 
+from selenium.deprecated import deprecated_function
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.common.options import ArgOptions
 from selenium.webdriver.firefox.firefox_binary import FirefoxBinary
@@ -81,49 +81,40 @@ def set_preference(self, name: str, value: Union[str, int, bool]):
         self._preferences[name] = value
 
     @property
+    @deprecated_function("Getting a profile has been deprecated.")
     def profile(self) -> FirefoxProfile:
         """
         :Returns: The Firefox profile to use.
         """
-        if self._profile:
-            warnings.warn("Getting a profile has been deprecated.", DeprecationWarning, stacklevel=2)
         return self._profile
 
     @profile.setter
+    @deprecated_function(
+        "Setting a profile has been deprecated. Please use the set_preference and install_addons methods"
+    )
     def profile(self, new_profile: Union[str, FirefoxProfile]) -> None:
         """Sets location of the browser profile to use, either by string or
         ``FirefoxProfile``."""
-        warnings.warn(
-            "Setting a profile has been deprecated. Please use the set_preference and install_addons methods",
-            DeprecationWarning,
-            stacklevel=2,
-        )
         if not isinstance(new_profile, FirefoxProfile):
             new_profile = FirefoxProfile(new_profile)
         self._profile = new_profile
 
     @property
+    @deprecated_function("headless property is deprecated, instead check for '-headless' in arguments")
     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
+    @deprecated_function("headless property is deprecated, instead use add_argument('-headless')")
     def headless(self, value: bool) -> None:
         """Sets the headless argument.
 
         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 not isinstance(value, bool):
             raise TypeError("value must be a boolean")
         if value:

py/selenium/webdriver/firefox/service.py

@@ -18,6 +18,7 @@
 import warnings
 from typing import List
 
+from selenium.deprecated import deprecated_attributes
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.common import service
 from selenium.webdriver.common import utils
@@ -35,6 +36,7 @@ class Service(service.Service):
     :param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
     """
 
+    @deprecated_attributes("log_path", message="log_path has been deprecated, please use log_output")
     def __init__(
         self,
         executable_path: str = None,
@@ -46,8 +48,7 @@ def __init__(
         **kwargs,
     ) -> None:
         self.service_args = service_args or []
-        if log_path is not None:
-            warnings.warn("log_path has been deprecated, please use log_output", DeprecationWarning, stacklevel=2)
+        if log_path:
             log_output = open(log_path, "a+", encoding="utf-8")
 
         if log_path is None and log_output is None:

py/selenium/webdriver/ie/service.py

@@ -15,16 +15,17 @@
 # specific language governing permissions and limitations
 # under the License.
 import typing
-import warnings
 from typing import List
 
+from selenium.deprecated import deprecated_attributes
 from selenium.types import SubprocessStdAlias
 from selenium.webdriver.common import service
 
 
 class Service(service.Service):
     """Object that manages the starting and stopping of the IEDriver."""
 
+    @deprecated_attributes("log_path", message="log_file has been deprecated, please use log_output")
     def __init__(
         self,
         executable_path: str = None,
@@ -53,7 +54,6 @@ def __init__(
         if log_level:
             self.service_args.append(f"--log-level={log_level}")
         if log_file:
-            warnings.warn("log_file has been deprecated, please use log_output", DeprecationWarning, stacklevel=2)
             self.service_args.append(f"--log-file={log_file}")
 
         super().__init__(

py/selenium/webdriver/remote/webdriver.py

@@ -38,6 +38,7 @@
 from selenium.common.exceptions import NoSuchCookieException
 from selenium.common.exceptions import NoSuchElementException
 from selenium.common.exceptions import WebDriverException
+from selenium.deprecated import deprecated_function
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.html5.application_cache import ApplicationCache
 from selenium.webdriver.common.options import BaseOptions
@@ -769,9 +770,9 @@ def find_elements(self, by=By.ID, value: Optional[str] = None) -> List[WebElemen
         return self.execute(Command.FIND_ELEMENTS, {"using": by, "value": value})["value"] or []
 
     @property
+    @deprecated_function("desired_capabilities is deprecated. Please call capabilities.")
     def desired_capabilities(self) -> dict:
         """returns the drivers current desired capabilities being used."""
-        warnings.warn("desired_capabilities is deprecated. Please call capabilities.", DeprecationWarning, stacklevel=2)
         return self.caps
 
     @property

py/selenium/webdriver/safari/service.py

@@ -16,8 +16,8 @@
 # under the License.
 
 import typing
-import warnings
 
+from selenium.deprecated import deprecated_attributes
 from selenium.webdriver.common import service
 
 
@@ -32,6 +32,7 @@ class Service(service.Service):
     :param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
     """
 
+    @deprecated_attributes("quiet", message="quiet is no longer needed to supress output")
     def __init__(
         self,
         executable_path: str = None,
@@ -43,9 +44,6 @@ def __init__(
         **kwargs,
     ) -> None:
         self.service_args = service_args or []
-        if quiet is not None:
-            warnings.warn("quiet is no longer needed to supress output", DeprecationWarning, stacklevel=2)
-
         self._reuse_service = reuse_service
         super().__init__(
             executable=executable_path,

py/selenium/webdriver/safari/webdriver.py

@@ -16,9 +16,9 @@
 # under the License.
 
 import http.client as http_client
-import warnings
 
 from selenium.common.exceptions import WebDriverException
+from selenium.deprecated import deprecated_attributes
 from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
 
 from ..common.driver_finder import DriverFinder
@@ -30,6 +30,9 @@
 class WebDriver(RemoteWebDriver):
     """Controls the SafariDriver and allows you to drive the browser."""
 
+    @deprecated_attributes(
+        "reuse_service", message="reuse_service has been deprecated, please use the Service class to set it"
+    )
     def __init__(
         self,
         reuse_service=False,
@@ -47,13 +50,6 @@ def __init__(
          - options - Instance of ``options.Options``.
          - service - Service object for handling the browser driver if you need to pass extra details
         """
-        if reuse_service:
-            warnings.warn(
-                "reuse_service has been deprecated, please use the Service class to set it",
-                DeprecationWarning,
-                stacklevel=2,
-            )
-
         self.service = service if service else Service()
         options = options if options else Options()