[py] added type hinting support to common/actions libraries. (#12325)

sandeepsuryaprasad · web-flow · commit 592d8e8c604e · 2023-07-24T11:51:14.000+01:00
[py] added additional typehints to actions
diff --git a/py/selenium/webdriver/common/actions/action_builder.py b/py/selenium/webdriver/common/actions/action_builder.py
@@ -16,6 +16,7 @@
 # under the License.
 
 from typing import List
+from typing import Optional
 from typing import Union
 
 from selenium.webdriver.remote.command import Command
@@ -30,7 +31,14 @@
 
 
 class ActionBuilder:
-    def __init__(self, driver, mouse=None, wheel=None, keyboard=None, duration=250) -> None:
+    def __init__(
+        self,
+        driver,
+        mouse: Optional[PointerInput] = None,
+        wheel: Optional[WheelInput] = None,
+        keyboard: Optional[KeyInput] = None,
+        duration: int = 250,
+    ) -> None:
         if not mouse:
             mouse = PointerInput(interaction.POINTER_MOUSE, "mouse")
         if not keyboard:
@@ -43,7 +51,7 @@ def __init__(self, driver, mouse=None, wheel=None, keyboard=None, duration=250)
         self._wheel_action = WheelActions(wheel)
         self.driver = driver
 
-    def get_device_with(self, name) -> Union["WheelInput", "PointerInput", "KeyInput"]:
+    def get_device_with(self, name: str) -> Union["WheelInput", "PointerInput", "KeyInput"]:
         return next(filter(lambda x: x == name, self.devices), None)
 
     @property
@@ -66,17 +74,17 @@ def pointer_action(self) -> PointerActions:
     def wheel_action(self) -> WheelActions:
         return self._wheel_action
 
-    def add_key_input(self, name) -> KeyInput:
+    def add_key_input(self, name: str) -> KeyInput:
         new_input = KeyInput(name)
         self._add_input(new_input)
         return new_input
 
-    def add_pointer_input(self, kind, name) -> PointerInput:
+    def add_pointer_input(self, kind: str, name: str) -> PointerInput:
         new_input = PointerInput(kind, name)
         self._add_input(new_input)
         return new_input
 
-    def add_wheel_input(self, name) -> WheelInput:
+    def add_wheel_input(self, name: str) -> WheelInput:
         new_input = WheelInput(name)
         self._add_input(new_input)
         return new_input
@@ -94,5 +102,5 @@ def clear_actions(self) -> None:
         """Clears actions that are already stored on the remote end."""
         self.driver.execute(Command.W3C_CLEAR_ACTIONS)
 
-    def _add_input(self, new_input) -> None:
+    def _add_input(self, new_input: Union[KeyInput, PointerInput, WheelInput]) -> None:
         self.devices.append(new_input)
diff --git a/py/selenium/webdriver/common/actions/input_device.py b/py/selenium/webdriver/common/actions/input_device.py
@@ -16,12 +16,13 @@
 # under the License.
 
 import uuid
+from typing import Optional
 
 
 class InputDevice:
     """Describes the input device being used for the action."""
 
-    def __init__(self, name=None):
+    def __init__(self, name: Optional[str] = None):
         self.name = name or uuid.uuid4()
         self.actions = []
 
@@ -32,5 +33,5 @@ def add_action(self, action):
     def clear_actions(self):
         self.actions = []
 
-    def create_pause(self, duration=0):
+    def create_pause(self, duration: int = 0):
         pass
diff --git a/py/selenium/webdriver/common/actions/interaction.py b/py/selenium/webdriver/common/actions/interaction.py
@@ -14,7 +14,8 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-import typing
+from typing import Dict
+from typing import Union
 
 KEY = "key"
 POINTER = "pointer"
@@ -32,7 +33,7 @@
 class Interaction:
     PAUSE = "pause"
 
-    def __init__(self, source) -> None:
+    def __init__(self, source: str) -> None:
         self.source = source
 
 
@@ -41,5 +42,5 @@ def __init__(self, source, duration: float = 0) -> None:
         super().__init__(source)
         self.duration = duration
 
-    def encode(self) -> typing.Dict[str, typing.Union[str, int]]:
+    def encode(self) -> Dict[str, Union[str, int]]:
         return {"type": self.PAUSE, "duration": int(self.duration * 1000)}
diff --git a/py/selenium/webdriver/common/actions/key_actions.py b/py/selenium/webdriver/common/actions/key_actions.py
@@ -16,37 +16,42 @@
 # under the License.
 from __future__ import annotations
 
+from typing import Optional
+from typing import Union
+
 from ..utils import keys_to_typing
 from .interaction import KEY
 from .interaction import Interaction
 from .key_input import KeyInput
+from .pointer_input import PointerInput
+from .wheel_input import WheelInput
 
 
 class KeyActions(Interaction):
-    def __init__(self, source=None):
+    def __init__(self, source: Optional[KeyInput, PointerInput, WheelInput] = None) -> None:
         if not source:
             source = KeyInput(KEY)
         self.source = source
         super().__init__(source)
 
-    def key_down(self, letter):
+    def key_down(self, letter: str) -> KeyActions:
         return self._key_action("create_key_down", letter)
 
-    def key_up(self, letter):
+    def key_up(self, letter: str) -> KeyActions:
         return self._key_action("create_key_up", letter)
 
-    def pause(self, duration=0):
+    def pause(self, duration: int = 0) -> KeyActions:
         return self._key_action("create_pause", duration)
 
-    def send_keys(self, text):
+    def send_keys(self, text: Union[str, list]) -> KeyActions:
         if not isinstance(text, list):
             text = keys_to_typing(text)
         for letter in text:
             self.key_down(letter)
             self.key_up(letter)
         return self
 
-    def _key_action(self, action, letter) -> KeyActions:
+    def _key_action(self, action: str, letter) -> KeyActions:
         meth = getattr(self.source, action)
         meth(letter)
         return self
diff --git a/py/selenium/webdriver/common/actions/key_input.py b/py/selenium/webdriver/common/actions/key_input.py
@@ -21,7 +21,7 @@
 
 
 class KeyInput(InputDevice):
-    def __init__(self, name) -> None:
+    def __init__(self, name: str) -> None:
         super().__init__()
         self.name = name
         self.type = interaction.KEY
diff --git a/py/selenium/webdriver/common/actions/pointer_actions.py b/py/selenium/webdriver/common/actions/pointer_actions.py
@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+from typing import Optional
 
 from selenium.webdriver.remote.webelement import WebElement
 
@@ -24,7 +25,7 @@
 
 
 class PointerActions(Interaction):
-    def __init__(self, source=None, duration=250):
+    def __init__(self, source: Optional[PointerInput] = None, duration: int = 250):
         """
         Args:
         - source: PointerInput instance
@@ -165,17 +166,17 @@ def move_to_location(
         )
         return self
 
-    def click(self, element=None, button=MouseButton.LEFT):
+    def click(self, element: Optional[WebElement] = None, button=MouseButton.LEFT):
         if element:
             self.move_to(element)
         self.pointer_down(button)
         self.pointer_up(button)
         return self
 
-    def context_click(self, element=None):
+    def context_click(self, element: Optional[WebElement] = None):
         return self.click(element=element, button=MouseButton.RIGHT)
 
-    def click_and_hold(self, element=None, button=MouseButton.LEFT):
+    def click_and_hold(self, element: Optional[WebElement] = None, button=MouseButton.LEFT):
         if element:
             self.move_to(element)
         self.pointer_down(button=button)
@@ -185,7 +186,7 @@ def release(self, button=MouseButton.LEFT):
         self.pointer_up(button=button)
         return self
 
-    def double_click(self, element=None):
+    def double_click(self, element: Optional[WebElement] = None):
         if element:
             self.move_to(element)
         self.pointer_down(MouseButton.LEFT)
