Switched locator type over to TypeAlias

Author: emanlove

src/SeleniumLibrary/keywords/element.py

@@ -41,7 +41,7 @@ def submit_form(self, locator: Union[WebElement, None, str, List[Union[WebElemen
         element.submit()
 
     @keyword
-    def checkbox_should_be_selected(self, locator: Union[WebElement, str, List[Union[WebElement,str]]]):
+    def checkbox_should_be_selected(self, locator: Locator):
         """Verifies checkbox ``locator`` is selected/checked.
 
         See the `Locating elements` section for details about the locator
@@ -55,7 +55,7 @@ def checkbox_should_be_selected(self, locator: Union[WebElement, str, List[Union
             )
 
     @keyword
-    def checkbox_should_not_be_selected(self, locator: Union[WebElement, str, List[Union[WebElement,str]]]):
+    def checkbox_should_not_be_selected(self, locator: Locator):
         """Verifies checkbox ``locator`` is not selected/checked.
 
         See the `Locating elements` section for details about the locator
@@ -69,7 +69,7 @@ def checkbox_should_not_be_selected(self, locator: Union[WebElement, str, List[U
     @keyword
     def page_should_contain_checkbox(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -86,7 +86,7 @@ def page_should_contain_checkbox(
     @keyword
     def page_should_not_contain_checkbox(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -101,7 +101,7 @@ def page_should_not_contain_checkbox(
         self.assert_page_not_contains(locator, "checkbox", message, loglevel)
 
     @keyword
-    def select_checkbox(self, locator: Union[WebElement, str, List[Union[WebElement,str]]]):
+    def select_checkbox(self, locator: Locator):
         """Selects the checkbox identified by ``locator``.
 
         Does nothing if checkbox is already selected.
@@ -115,7 +115,7 @@ def select_checkbox(self, locator: Union[WebElement, str, List[Union[WebElement,
             element.click()
 
     @keyword
-    def unselect_checkbox(self, locator: Union[WebElement, str, List[Union[WebElement,str]]]):
+    def unselect_checkbox(self, locator: Locator):
         """Removes the selection of checkbox identified by ``locator``.
 
         Does nothing if the checkbox is not selected.
@@ -131,7 +131,7 @@ def unselect_checkbox(self, locator: Union[WebElement, str, List[Union[WebElemen
     @keyword
     def page_should_contain_radio_button(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -149,7 +149,7 @@ def page_should_contain_radio_button(
     @keyword
     def page_should_not_contain_radio_button(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -213,7 +213,7 @@ def select_radio_button(self, group_name: str, value: str):
             element.click()
 
     @keyword
-    def choose_file(self, locator: Union[WebElement, str, List[Union[WebElement,str]]], file_path: str):
+    def choose_file(self, locator: Locator, file_path: str):
         """Inputs the ``file_path`` into the file input field ``locator``.
 
         This keyword is most often used to input files into upload forms.
@@ -240,7 +240,7 @@ def choose_file(self, locator: Union[WebElement, str, List[Union[WebElement,str]
 
     @keyword
     def input_password(
-        self, locator: Union[WebElement, str, List[Union[WebElement,str]]], password: str, clear: bool = True
+        self, locator: Locator, password: str, clear: bool = True
     ):
         """Types the given password into the text field identified by ``locator``.
 
@@ -270,7 +270,7 @@ def input_password(
 
     @keyword
     def input_text(
-        self, locator: Union[WebElement, str, List[Union[WebElement,str]]], text: str, clear: bool = True
+        self, locator: Locator, text: str, clear: bool = True
     ):
         """Types the given ``text`` into the text field identified by ``locator``.
 
@@ -299,7 +299,7 @@ def input_text(
     @keyword
     def page_should_contain_textfield(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -316,7 +316,7 @@ def page_should_contain_textfield(
     @keyword
     def page_should_not_contain_textfield(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -333,7 +333,7 @@ def page_should_not_contain_textfield(
     @keyword
     def textfield_should_contain(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         expected: str,
         message: Optional[str] = None,
     ):
@@ -357,7 +357,7 @@ def textfield_should_contain(
     @keyword
     def textfield_value_should_be(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         expected: str,
         message: Optional[str] = None,
     ):
@@ -381,7 +381,7 @@ def textfield_value_should_be(
     @keyword
     def textarea_should_contain(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         expected: str,
         message: Optional[str] = None,
     ):
@@ -405,7 +405,7 @@ def textarea_should_contain(
     @keyword
     def textarea_value_should_be(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         expected: str,
         message: Optional[str] = None,
     ):
@@ -429,7 +429,7 @@ def textarea_value_should_be(
     @keyword
     def page_should_contain_button(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -450,7 +450,7 @@ def page_should_contain_button(
     @keyword
     def page_should_not_contain_button(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         message: Optional[str] = None,
         loglevel: str = "TRACE",
     ):
@@ -469,7 +469,7 @@ def page_should_not_contain_button(
     def _get_value(self, locator, tag):
         return self.find_element(locator, tag).get_attribute("value")
 
-    def _get_checkbox(self, locator: Union[WebElement, str, List[Union[WebElement,str]]]):
+    def _get_checkbox(self, locator: Locator):
         return self.find_element(locator, tag="checkbox")
 
     def _get_radio_buttons(self, group_name):

src/SeleniumLibrary/keywords/formelement.py

@@ -18,11 +18,12 @@
 from selenium.webdriver.remote.webelement import WebElement
 
 from SeleniumLibrary.base import LibraryComponent, keyword
+from SeleniumLibrary.utils.types import Locator
 
 
 class FrameKeywords(LibraryComponent):
     @keyword
-    def select_frame(self, locator: Union[WebElement, str, List[Union[WebElement,str]]]):
+    def select_frame(self, locator: Locator):
         """Sets frame identified by ``locator`` as the current frame.
 
         See the `Locating elements` section for details about the locator
@@ -82,7 +83,7 @@ def current_frame_should_not_contain(self, text: str, loglevel: str = "TRACE"):
 
     @keyword
     def frame_should_contain(
-        self, locator: Union[WebElement, str, List[Union[WebElement,str]]], text: str, loglevel: str = "TRACE"
+        self, locator: Locator, text: str, loglevel: str = "TRACE"
     ):
         """Verifies that frame identified by ``locator`` contains ``text``.
 
@@ -99,7 +100,7 @@ def frame_should_contain(
             )
         self.info(f"Frame '{locator}' contains text '{text}'.")
 
-    def _frame_contains(self, locator: Union[WebElement, str, List[Union[WebElement,str]]], text: str):
+    def _frame_contains(self, locator: Locator, text: str):
         element = self.find_element(locator)
         self.driver.switch_to.frame(element)
         self.info(f"Searching for text from frame '{locator}'.")

src/SeleniumLibrary/keywords/frames.py

@@ -23,6 +23,7 @@
 
 from SeleniumLibrary.base import LibraryComponent, keyword
 from SeleniumLibrary.utils.path_formatter import _format_path
+from SeleniumLibrary.utils.types import Locator
 
 DEFAULT_FILENAME_PAGE = "selenium-screenshot-{index}.png"
 DEFAULT_FILENAME_ELEMENT = "selenium-element-screenshot-{index}.png"
@@ -146,7 +147,7 @@ def _capture_page_screen_to_log(self, return_val):
     @keyword
     def capture_element_screenshot(
         self,
-        locator: Union[WebElement, str, List[Union[WebElement,str]]],
+        locator: Locator,
         filename: str = DEFAULT_FILENAME_ELEMENT,
     ) -> str:
         """Captures a screenshot from the element identified by ``locator`` and embeds it into log file.