[py] Added type hints to all the conditions in expected_conditions.py module. (#12139)

sandeepsuryaprasad · diemol · web-flow · commit 96494b4a68cc · 2023-06-05T21:02:57.000+02:00
* added type hints to all the methods in Select class

* fixed lynting error by moving standard import to the beginning

* fixed import formatting issue in Select class

* optimized _get_longest_token method in Select class

* added driver types to types.py

* added type hints to all conditions in expected_conditions.py

* resolved merge conflict

* moved driver types to select.py

* added driver types to expected_conditions.py

* moved driver types to expected_conditions.py

* removed driver imports to fix circular import

* fixed typo

* resolved

* removed empty line

* fixed typo

* removed duplicate import

* fixed incorrect return types for couple of conditions

* fixed lynting error by breaking different imports from typing module into different lines

* fixed lynting errors

* made formatting changes

* added type hints to all the methods in Select class

* fixed lynting error by moving standard import to the beginning

* fixed all formatting issues

* added newline after standard import in select.py

---------

Co-authored-by: Diego Molina &lt;diemol@users.noreply.github.com&gt;
diff --git a/py/selenium/webdriver/support/expected_conditions.py b/py/selenium/webdriver/support/expected_conditions.py
@@ -16,21 +16,34 @@
 # under the License.
 
 import re
+from typing import Callable
+from typing import List
+from typing import Tuple
+from typing import Union
 
 from selenium.common.exceptions import NoAlertPresentException
 from selenium.common.exceptions import NoSuchElementException
 from selenium.common.exceptions import NoSuchFrameException
 from selenium.common.exceptions import StaleElementReferenceException
 from selenium.common.exceptions import WebDriverException
+from selenium.webdriver import Chrome
+from selenium.webdriver import Edge
+from selenium.webdriver import Firefox
+from selenium.webdriver import Ie
+from selenium.webdriver import Safari
+from selenium.webdriver.common.alert import Alert
 from selenium.webdriver.remote.webdriver import WebElement
 
+# All driver types
+AnyDriver = Union[Chrome, Firefox, Safari, Ie, Edge]
+
 """
  * Canned "Expected Conditions" which are generally useful within webdriver
  * tests.
 """
 
 
-def title_is(title: str):
+def title_is(title: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking the title of a page.
 
     title is the expected title, which must be an exact match returns
@@ -43,7 +56,7 @@ def _predicate(driver):
     return _predicate
 
 
-def title_contains(title: str):
+def title_contains(title: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking that the title contains a case-sensitive
     substring.
 
@@ -57,7 +70,7 @@ def _predicate(driver):
     return _predicate
 
 
-def presence_of_element_located(locator):
+def presence_of_element_located(locator: Tuple[str, str]) -> Callable[[AnyDriver], WebElement]:
     """An expectation for checking that an element is present on the DOM of a
     page. This does not necessarily mean that the element is visible.
 
@@ -71,7 +84,7 @@ def _predicate(driver):
     return _predicate
 
 
-def url_contains(url: str):
+def url_contains(url: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking that the current url contains a case-
     sensitive substring.
 
@@ -85,7 +98,7 @@ def _predicate(driver):
     return _predicate
 
 
-def url_matches(pattern: str):
+def url_matches(pattern: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking the current url.
 
     pattern is the expected pattern.  This finds the first occurrence of
@@ -99,7 +112,7 @@ def _predicate(driver):
     return _predicate
 
 
-def url_to_be(url: str):
+def url_to_be(url: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking the current url.
 
     url is the expected url, which must be an exact match returns True
@@ -112,7 +125,7 @@ def _predicate(driver):
     return _predicate
 
 
-def url_changes(url: str):
+def url_changes(url: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking the current url.
 
     url is the expected url, which must not be an exact match returns
@@ -125,7 +138,7 @@ def _predicate(driver):
     return _predicate
 
 
-def visibility_of_element_located(locator):
+def visibility_of_element_located(locator: Tuple[str, str]) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An expectation for checking that an element is present on the DOM of a
     page and visible. Visibility means that the element is not only displayed
     but also has a height and width that is greater than 0.
@@ -143,7 +156,7 @@ def _predicate(driver):
     return _predicate
 
 
-def visibility_of(element):
+def visibility_of(element: WebElement) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An expectation for checking that an element, known to be present on the
     DOM of a page, is visible.
 
@@ -158,11 +171,11 @@ def _predicate(_):
     return _predicate
 
 
-def _element_if_visible(element, visibility=True):
+def _element_if_visible(element: WebElement, visibility: bool = True) -> Union[WebElement, bool]:
     return element if element.is_displayed() == visibility else False
 
 
-def presence_of_all_elements_located(locator):
+def presence_of_all_elements_located(locator: Tuple[str, str]) -> Callable[[AnyDriver], List[WebElement]]:
     """An expectation for checking that there is at least one element present
     on a web page.
 
@@ -176,7 +189,7 @@ def _predicate(driver):
     return _predicate
 
 
-def visibility_of_any_elements_located(locator):
+def visibility_of_any_elements_located(locator: Tuple[str, str]) -> Callable[[AnyDriver], List[WebElement]]:
     """An expectation for checking that there is at least one element visible
     on a web page.
 
@@ -190,7 +203,9 @@ def _predicate(driver):
     return _predicate
 
 
-def visibility_of_all_elements_located(locator):
+def visibility_of_all_elements_located(
+    locator: Tuple[str, str]
+) -> Callable[[AnyDriver], Union[bool, List[WebElement]]]:
     """An expectation for checking that all elements are present on the DOM of
     a page and visible. Visibility means that the elements are not only
     displayed but also has a height and width that is greater than 0.
@@ -212,7 +227,7 @@ def _predicate(driver):
     return _predicate
 
 
-def text_to_be_present_in_element(locator, text_):
+def text_to_be_present_in_element(locator: Tuple[str, str], text_: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking if the given text is present in the
     specified element.
 
@@ -229,7 +244,7 @@ def _predicate(driver):
     return _predicate
 
 
-def text_to_be_present_in_element_value(locator, text_):
+def text_to_be_present_in_element_value(locator: Tuple[str, str], text_: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking if the given text is present in the
     element's value.
 
@@ -246,7 +261,9 @@ def _predicate(driver):
     return _predicate
 
 
-def text_to_be_present_in_element_attribute(locator, attribute_, text_):
+def text_to_be_present_in_element_attribute(
+    locator: Tuple[str, str], attribute_: str, text_: str
+) -> Callable[[AnyDriver], bool]:
     """An expectation for checking if the given text is present in the
     element's attribute.
 
@@ -265,7 +282,7 @@ def _predicate(driver):
     return _predicate
 
 
-def frame_to_be_available_and_switch_to_it(locator):
+def frame_to_be_available_and_switch_to_it(locator: Union[Tuple[str, str], str]) -> Callable[[AnyDriver], bool]:
     """An expectation for checking whether the given frame is available to
     switch to.
 
@@ -286,7 +303,9 @@ def _predicate(driver):
     return _predicate
 
 
-def invisibility_of_element_located(locator):
+def invisibility_of_element_located(
+    locator: Union[WebElement, Tuple[str, str]]
+) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An Expectation for checking that an element is either invisible or not
     present on the DOM.
 
@@ -298,7 +317,7 @@ def _predicate(driver):
             target = locator
             if not isinstance(target, WebElement):
                 target = driver.find_element(*target)
-            return _element_if_visible(target, False)
+            return _element_if_visible(target, visibility=False)
         except (NoSuchElementException, StaleElementReferenceException):
             # In the case of NoSuchElement, returns true because the element is
             # not present in DOM. The try block checks if the element is present
@@ -310,7 +329,9 @@ def _predicate(driver):
     return _predicate
 
 
-def invisibility_of_element(element):
+def invisibility_of_element(
+    element: Union[WebElement, Tuple[str, str]]
+) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An Expectation for checking that an element is either invisible or not
     present on the DOM.
 
@@ -319,7 +340,7 @@ def invisibility_of_element(element):
     return invisibility_of_element_located(element)
 
 
-def element_to_be_clickable(mark):
+def element_to_be_clickable(mark: Union[WebElement, Tuple[str, str]]) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An Expectation for checking an element is visible and enabled such that
     you can click it.
 
@@ -340,7 +361,7 @@ def _predicate(driver):
     return _predicate
 
 
-def staleness_of(element):
+def staleness_of(element: WebElement) -> Callable[[AnyDriver], bool]:
     """Wait until an element is no longer attached to the DOM.
 
     element is the element to wait for. returns False if the element is
@@ -358,7 +379,7 @@ def _predicate(_):
     return _predicate
 
 
-def element_to_be_selected(element):
+def element_to_be_selected(element: WebElement) -> Callable[[AnyDriver], bool]:
     """An expectation for checking the selection is selected.
 
     element is WebElement object
@@ -370,7 +391,7 @@ def _predicate(_):
     return _predicate
 
 
-def element_located_to_be_selected(locator):
+def element_located_to_be_selected(locator: Tuple[str, str]) -> Callable[[AnyDriver], bool]:
     """An expectation for the element to be located is selected.
 
     locator is a tuple of (by, path)
@@ -382,7 +403,7 @@ def _predicate(driver):
     return _predicate
 
 
-def element_selection_state_to_be(element, is_selected):
+def element_selection_state_to_be(element: WebElement, is_selected: bool) -> Callable[[AnyDriver], bool]:
     """An expectation for checking if the given element is selected.
 
     element is WebElement object is_selected is a Boolean.
@@ -394,7 +415,7 @@ def _predicate(_):
     return _predicate
 
 
-def element_located_selection_state_to_be(locator, is_selected):
+def element_located_selection_state_to_be(locator: Tuple[str, str], is_selected: bool) -> Callable[[AnyDriver], bool]:
     """An expectation to locate an element and check if the selection state
     specified is in that state.
 
@@ -411,7 +432,7 @@ def _predicate(driver):
     return _predicate
 
 
-def number_of_windows_to_be(num_windows):
+def number_of_windows_to_be(num_windows: int) -> Callable[[AnyDriver], bool]:
     """An expectation for the number of windows to be a certain value."""
 
     def _predicate(driver):
@@ -420,7 +441,7 @@ def _predicate(driver):
     return _predicate
 
 
-def new_window_is_opened(current_handles):
+def new_window_is_opened(current_handles: List[str]) -> Callable[[AnyDriver], bool]:
     """An expectation that a new window will be opened and have the number of
     windows handles increase."""
 
@@ -430,7 +451,7 @@ def _predicate(driver):
     return _predicate
 
 
-def alert_is_present():
+def alert_is_present() -> Callable[[AnyDriver], Union[Alert, bool]]:
     """An expectation for checking if an alert is currently present and
     switching to it."""
 
@@ -443,7 +464,7 @@ def _predicate(driver):
     return _predicate
 
 
-def element_attribute_to_include(locator, attribute_):
+def element_attribute_to_include(locator: Tuple[str, str], attribute_: str) -> Callable[[AnyDriver], bool]:
     """An expectation for checking if the given attribute is included in the
     specified element.
 
@@ -460,7 +481,7 @@ def _predicate(driver):
     return _predicate
 
 
-def any_of(*expected_conditions):
+def any_of(*expected_conditions) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An expectation that any of multiple expected conditions is true.
 
     Equivalent to a logical 'OR'. Returns results of the first matching
@@ -480,7 +501,7 @@ def any_of_condition(driver):
     return any_of_condition
 
 
-def all_of(*expected_conditions):
+def all_of(*expected_conditions) -> Callable[[AnyDriver], Union[WebElement, bool]]:
     """An expectation that all of multiple expected conditions is true.
 
     Equivalent to a logical 'AND'.
@@ -503,7 +524,7 @@ def all_of_condition(driver):
     return all_of_condition
 
 
-def none_of(*expected_conditions):
+def none_of(*expected_conditions) -> Callable[[AnyDriver], bool]:
     """An expectation that none of 1 or multiple expected conditions is true.
 
     Equivalent to a logical 'NOT-OR'. Returns a Boolean
