[py] Add python type hinting

Author: AutomatedTester

py/selenium/webdriver/chrome/options.py

@@ -22,5 +22,5 @@
 class Options(ChromiumOptions):
 
     @property
-    def default_capabilities(self):
+    def default_capabilities(self) -> dict:
         return DesiredCapabilities.CHROME.copy()

py/selenium/webdriver/chrome/service.py

@@ -15,6 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from typing import List
 from selenium.webdriver.chromium import service
 
 
@@ -23,8 +24,8 @@ class Service(service.ChromiumService):
     Object that manages the starting and stopping of the ChromeDriver
     """
 
-    def __init__(self, executable_path, port=0, service_args=None,
-                 log_path=None, env=None):
+    def __init__(self, executable_path: str, port: int = 0, service_args: List[str] = None,
+                 log_path: str = None, env: str = None):
         """
         Creates a new instance of the Service
 

py/selenium/webdriver/chrome/webdriver.py

@@ -33,9 +33,9 @@ class WebDriver(ChromiumDriver):
     """
 
     def __init__(self, executable_path="chromedriver", port=DEFAULT_PORT,
-                 options=None, service_args=None,
+                 options: Options = None, service_args=None,
                  desired_capabilities=None, service_log_path=DEFAULT_SERVICE_LOG_PATH,
-                 chrome_options=None, service=None, keep_alive=True):
+                 chrome_options=None, service: Service = None, keep_alive=True):
         """
         Creates a new instance of the chrome driver.
         Starts the service and then creates new instance of chrome driver.
@@ -66,5 +66,5 @@ def __init__(self, executable_path="chromedriver", port=DEFAULT_PORT,
                                         service_args, desired_capabilities,
                                         service_log_path, service, keep_alive)
 
-    def create_options(self):
+    def create_options(self) -> Options:
         return Options()

py/selenium/webdriver/chromium/options.py

@@ -17,6 +17,7 @@
 
 import base64
 import os
+from typing import List, NoReturn, Union
 
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.common.options import ArgOptions
@@ -34,14 +35,14 @@ def __init__(self):
         self._debugger_address = None
 
     @property
-    def binary_location(self):
+    def binary_location(self) -> str:
         """
         :Returns: The location of the binary, otherwise an empty string
         """
         return self._binary_location
 
     @binary_location.setter
-    def binary_location(self, value):
+    def binary_location(self, value: str):
         """
         Allows you to set where the chromium binary lives
         :Args:
@@ -50,14 +51,14 @@ def binary_location(self, value):
         self._binary_location = value
 
     @property
-    def debugger_address(self):
+    def debugger_address(self: str):
         """
         :Returns: The address of the remote devtools instance
         """
         return self._debugger_address
 
     @debugger_address.setter
-    def debugger_address(self, value):
+    def debugger_address(self, value: str):
         """
         Allows you to set the address of the remote devtools instance
         that the ChromeDriver instance will try to connect to during an
@@ -68,7 +69,7 @@ def debugger_address(self, value):
         self._debugger_address = value
 
     @property
-    def extensions(self):
+    def extensions(self) -> List[str]:
         """
         :Returns: A list of encoded extensions that will be loaded
         """
@@ -83,7 +84,7 @@ def extensions(self):
             file_.close()
         return encoded_extensions + self._extensions
 
-    def add_extension(self, extension):
+    def add_extension(self, extension: str) -> NoReturn:
         """
         Adds the path to the extension to a list that will be used to extract it
         to the ChromeDriver
@@ -100,7 +101,7 @@ def add_extension(self, extension):
         else:
             raise ValueError("argument can not be null")
 
-    def add_encoded_extension(self, extension):
+    def add_encoded_extension(self, extension: str) -> NoReturn:
         """
         Adds Base64 encoded string with extension data to a list that will be used to extract it
         to the ChromeDriver
@@ -114,13 +115,13 @@ def add_encoded_extension(self, extension):
             raise ValueError("argument can not be null")
 
     @property
-    def experimental_options(self):
+    def experimental_options(self) -> dict:
         """
         :Returns: A dictionary of experimental options for chromium
         """
         return self._experimental_options
 
-    def add_experimental_option(self, name, value):
+    def add_experimental_option(self, name: str, value: Union[str, int]):
         """
         Adds an experimental option which is passed to chromium.
 
@@ -131,14 +132,14 @@ def add_experimental_option(self, name, value):
         self._experimental_options[name] = value
 
     @property
-    def headless(self):
+    def headless(self) -> bool:
         """
         :Returns: True if the headless argument is set, else False
         """
         return '--headless' in self._arguments
 
     @headless.setter
-    def headless(self, value):
+    def headless(self, value: bool):
         """
         Sets the headless argument
         :Args:
@@ -151,17 +152,17 @@ def headless(self, value):
             self._arguments = list(set(self._arguments) - args)
 
     @property
-    def page_load_strategy(self):
+    def page_load_strategy(self) -> str:
         return self._caps["pageLoadStrategy"]
 
     @page_load_strategy.setter
-    def page_load_strategy(self, strategy):
+    def page_load_strategy(self, strategy: str):
         if strategy in ["normal", "eager", "none"]:
             self.set_capability("pageLoadStrategy", strategy)
         else:
             raise ValueError("Strategy can only be one of the following: normal, eager, none")
 
-    def to_capabilities(self):
+    def to_capabilities(self) -> dict:
         """
         Creates a capabilities with all the options that have been set
         :Returns: A dictionary with everything
@@ -180,5 +181,5 @@ def to_capabilities(self):
         return caps
 
     @property
-    def default_capabilities(self):
+    def default_capabilities(self) -> dict:
         return DesiredCapabilities.CHROME.copy()

py/selenium/webdriver/chromium/service.py

@@ -15,6 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from typing import List
 from selenium.webdriver.common import service
 
 
@@ -23,8 +24,8 @@ class ChromiumService(service.Service):
     Object that manages the starting and stopping the WebDriver instance of the ChromiumDriver
     """
 
-    def __init__(self, executable_path, port=0, service_args=None,
-                 log_path=None, env=None, start_error_message=None):
+    def __init__(self, executable_path: str, port: int = 0, service_args: List[str] = None,
+                 log_path: str = None, env: str = None, start_error_message: str = None):
         """
         Creates a new instance of the Service
 
@@ -43,5 +44,5 @@ def __init__(self, executable_path, port=0, service_args=None,
 
         service.Service.__init__(self, executable_path, port=port, env=env, start_error_message=start_error_message)
 
-    def command_line_args(self):
+    def command_line_args(self) -> List[str]:
         return ["--port=%d" % self.port] + self.service_args

py/selenium/webdriver/chromium/webdriver.py

@@ -15,6 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from typing import NoReturn
+from selenium.webdriver.edge.options import Options
+from selenium.webdriver.edge.service import Service
 import warnings
 
 from selenium.webdriver.chromium.remote_connection import ChromiumRemoteConnection
@@ -30,9 +33,9 @@ class ChromiumDriver(RemoteWebDriver):
     """
 
     def __init__(self, browser_name, vendor_prefix,
-                 port=DEFAULT_PORT, options=None, service_args=None,
+                 port=DEFAULT_PORT, options: Options = None, service_args=None,
                  desired_capabilities=None, service_log_path=DEFAULT_SERVICE_LOG_PATH,
-                 service=None, keep_alive=True):
+                 service: Service = None, keep_alive=True):
         """
         Creates a new WebDriver instance of the ChromiumDriver.
         Starts the service and then creates new WebDriver instance of ChromiumDriver.
@@ -108,7 +111,7 @@ def get_network_conditions(self):
         """
         return self.execute("getNetworkConditions")['value']
 
-    def set_network_conditions(self, **network_conditions):
+    def set_network_conditions(self, **network_conditions) -> NoReturn:
         """
         Sets Chromium network emulation settings.
 
@@ -130,7 +133,7 @@ def set_network_conditions(self, **network_conditions):
             'network_conditions': network_conditions
         })
 
-    def execute_cdp_cmd(self, cmd, cmd_args):
+    def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
         """
         Execute Chrome Devtools Protocol command and get returned result
         The command and command args should follow chrome devtools protocol domains/commands, refer to link
@@ -149,7 +152,7 @@ def execute_cdp_cmd(self, cmd, cmd_args):
         """
         return self.execute("executeCdpCommand", {'cmd': cmd, 'params': cmd_args})['value']
 
-    def get_sinks(self):
+    def get_sinks(self) -> list:
         """
         :Returns: A list of sinks avaliable for Cast.
         """
@@ -161,7 +164,7 @@ def get_issue_message(self):
         """
         return self.execute('getIssueMessage')['value']
 
-    def set_sink_to_use(self, sink_name):
+    def set_sink_to_use(self, sink_name: str) -> str:
         """
         Sets a specific sink, using its name, as a Cast session receiver target.
 
@@ -170,7 +173,7 @@ def set_sink_to_use(self, sink_name):
         """
         return self.execute('setSinkToUse', {'sinkName': sink_name})
 
-    def start_tab_mirroring(self, sink_name):
+    def start_tab_mirroring(self, sink_name: str) -> str:
         """
         Starts a tab mirroring session on a specific receiver target.
 
@@ -179,7 +182,7 @@ def start_tab_mirroring(self, sink_name):
         """
         return self.execute('startTabMirroring', {'sinkName': sink_name})
 
-    def stop_casting(self, sink_name):
+    def stop_casting(self, sink_name: str) -> str:
         """
         Stops the existing Cast session on a specific receiver target.
 
@@ -188,7 +191,7 @@ def stop_casting(self, sink_name):
         """
         return self.execute('stopCasting', {'sinkName': sink_name})
 
-    def quit(self):
+    def quit(self) -> NoReturn:
         """
         Closes the browser and shuts down the ChromiumDriver executable
         that is started when starting the ChromiumDriver

py/selenium/webdriver/edge/options.py

@@ -28,22 +28,22 @@ def __init__(self):
         self._use_webview = False
 
     @property
-    def use_chromium(self):
+    def use_chromium(self) -> bool:
         return self._use_chromium
 
     @use_chromium.setter
-    def use_chromium(self, value):
+    def use_chromium(self, value: bool):
         self._use_chromium = bool(value)
 
     @property
-    def use_webview(self):
+    def use_webview(self) -> bool:
         return self._use_webview
 
     @use_webview.setter
-    def use_webview(self, value):
+    def use_webview(self, value: bool):
         self._use_webview = bool(value)
 
-    def to_capabilities(self):
+    def to_capabilities(self) -> dict:
         """
         Creates a capabilities with all the options that have been set and
         :Returns: A dictionary with everything
@@ -61,5 +61,5 @@ def to_capabilities(self):
         return caps
 
     @property
-    def default_capabilities(self):
+    def default_capabilities(self) -> dict:
         return DesiredCapabilities.EDGE.copy()

py/selenium/webdriver/edge/service.py

@@ -15,13 +15,14 @@
 # specific language governing permissions and limitations
 # under the License.
 
+from typing import List
 from selenium.webdriver.chromium import service
 
 
 class Service(service.ChromiumService):
 
-    def __init__(self, executable_path, port=0, verbose=False, log_path=None,
-                 service_args=None, env=None):
+    def __init__(self, executable_path: str, port: int = 0, verbose: bool = False, log_path: str = None,
+                 service_args: List[str] = None, env=None):
         """
         Creates a new instance of the EdgeDriver service.
         EdgeDriver provides an interface for Microsoft WebDriver to use

py/selenium/webdriver/edge/webdriver.py

@@ -34,9 +34,9 @@ class WebDriver(ChromiumDriver):
     """
 
     def __init__(self, executable_path='MicrosoftWebDriver.exe', port=DEFAULT_PORT,
-                 options=None, service_args=None,
+                 options: Options = None, service_args=None,
                  capabilities=None, service_log_path=DEFAULT_SERVICE_LOG_PATH,
-                 service=None, keep_alive=False, verbose=False):
+                 service: Service = None, keep_alive=False, verbose=False):
         """
         Creates a new instance of the edge driver.
         Starts the service and then creates new instance of edge driver.
@@ -67,5 +67,5 @@ def __init__(self, executable_path='MicrosoftWebDriver.exe', port=DEFAULT_PORT,
                                         service_args, capabilities,
                                         service_log_path, service, keep_alive)
 
-    def create_options(self):
+    def create_options(self) -> Options:
         return Options()