Add type hints to SL keywords

Author: aaltat

atest/acceptance/keywords/counting_elements.robot

@@ -5,24 +5,6 @@ Resource          ../resource.robot
 Library           String
 
 *** Test Cases ***
-Locator Should Match X Times
-    [Documentation]    Deprecated
-    [Setup]    Go To Page "links.html"
-    Locator Should Match X Times    link=Link    2
-    Locator Should Match X Times    link=Missing Link    0
-    Locator Should Match X Times    name:div_name    2
-    Locator Should Match X Times    xpath://*[@name="div_name"]    2
-
-Locator Should Match X Times Error
-    [Documentation]    Deprecated
-    [Setup]    Go To Page "links.html"
-    Run Keyword And Expect Error
-    ...    Locator 'name: div_name' should have matched 3 times but matched 2 times.
-    ...    Locator Should Match X Times    name: div_name    3
-    Run Keyword And Expect Error
-    ...    Custom error ÄÄÄ
-    ...    Locator Should Match X Times    name:div_name    3    Custom error ÄÄÄ
-
 Get Element Count With Xpath Locator
     [Setup]    Go To Page "links.html"
     ${count} =     Get Element Count    xpath://*[@name="div_name"]
@@ -75,7 +57,7 @@ Page Should Contain Element When Limit Is Number And Error
 Page Should Contain Element When Limit Is Not Number
     [Setup]    Go To Page "links.html"
     Run Keyword And Expect Error
-    ...    ValueError: invalid literal for int() with base 10: 'AA'
+    ...    ValueError: *Argument 'limit' got value 'AA'*
     ...    Page Should Contain Element    name: div_name    limit=AA
 
 Page Should Contain Element When Error With Limit And Different Loglevels

src/SeleniumLibrary/keywords/alert.py

@@ -13,6 +13,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from typing import Optional, Union
 
 from selenium.common.exceptions import TimeoutException, WebDriverException
 from selenium.webdriver.support import expected_conditions as EC
@@ -29,7 +30,7 @@ class AlertKeywords(LibraryComponent):
     _next_alert_action = ACCEPT
 
     @keyword
-    def input_text_into_alert(self, text, action=ACCEPT, timeout=None):
+    def input_text_into_alert(self, text: str, action: str = ACCEPT, timeout: Union[float, str, None] = None):
         """Types the given ``text`` into an input field in an alert.
 
         The alert is accepted by default, but that behavior can be controlled
@@ -45,7 +46,7 @@ def input_text_into_alert(self, text, action=ACCEPT, timeout=None):
         self._handle_alert(alert, action)
 
     @keyword
-    def alert_should_be_present(self, text="", action=ACCEPT, timeout=None):
+    def alert_should_be_present(self, text: str = "", action: str = ACCEPT, timeout: Union[float, str, None] = None):
         """Verifies that an alert is present and by default, accepts it.
 
         Fails if no alert is present. If ``text`` is a non-empty string,
@@ -67,7 +68,7 @@ def alert_should_be_present(self, text="", action=ACCEPT, timeout=None):
             )
 
     @keyword
-    def alert_should_not_be_present(self, action=ACCEPT, timeout=0):
+    def alert_should_not_be_present(self, action: str = ACCEPT, timeout:  Union[float, str, None] = 0):
         """Verifies that no alert is present.
 
         If the alert actually exists, the ``action`` argument determines
@@ -90,7 +91,7 @@ def alert_should_not_be_present(self, action=ACCEPT, timeout=0):
         raise AssertionError(f"Alert with message '{text}' present.")
 
     @keyword
-    def handle_alert(self, action=ACCEPT, timeout=None):
+    def handle_alert(self, action: str = ACCEPT, timeout:  Union[float, str, None] = None):
         """Handles the current alert and returns its message.
 
         By default, the alert is accepted, but this can be controlled

src/SeleniumLibrary/keywords/browsermanagement.py

@@ -16,6 +16,7 @@
 
 import time
 import types
+from typing import Optional, Union, Any, List
 
 from selenium import webdriver
 from selenium.webdriver.support.event_firing_webdriver import EventFiringWebDriver
@@ -56,16 +57,16 @@ def close_browser(self):
     @keyword
     def open_browser(
         self,
-        url=None,
-        browser="firefox",
-        alias=None,
-        remote_url=False,
-        desired_capabilities=None,
-        ff_profile_dir=None,
-        options=None,
-        service_log_path=None,
-        executable_path=None,
-    ):
+        url: Optional[str] = None,
+        browser: str = "firefox",
+        alias: Optional[str] = None,
+        remote_url: Optional[str] = False,
+        desired_capabilities: Union[str, dict, None] = None,
+        ff_profile_dir: Optional[str] = None,
+        options: Any = None,
+        service_log_path: Optional[str] = None,
+        executable_path: Optional[str] = None,
+    ) -> str:
         """Opens a new browser instance to the optional ``url``.
 
         The ``browser`` argument specifies which browser to use. The
@@ -341,7 +342,7 @@ def _make_new_browser(
         return index
 
     @keyword
-    def create_webdriver(self, driver_name, alias=None, kwargs={}, **init_kwargs):
+    def create_webdriver(self, driver_name: str, alias: Optional[str] = None, kwargs={}, **init_kwargs) -> str:
         """Creates an instance of Selenium WebDriver.
 
         Like `Open Browser`, but allows passing arguments to the created
@@ -397,7 +398,7 @@ def _wrap_event_firing_webdriver(self, driver):
         return EventFiringWebDriver(driver, self.ctx.event_firing_webdriver())
 
     @keyword
-    def switch_browser(self, index_or_alias):
+    def switch_browser(self, index_or_alias: str):
         """Switches between active browsers using ``index_or_alias``.
 
         Indices are returned by the `Open Browser` keyword and aliases can
@@ -434,7 +435,7 @@ def switch_browser(self, index_or_alias):
         )
 
     @keyword
-    def get_browser_ids(self):
+    def get_browser_ids(self) -> List[str]:
         """Returns index of all active browser as list.
 
         Example:
@@ -451,7 +452,7 @@ def get_browser_ids(self):
         return self.drivers.active_driver_ids
 
     @keyword
-    def get_browser_aliases(self):
+    def get_browser_aliases(self) -> List[str]:
         """Returns aliases of all active browser that has an alias as NormalizedDict.
         The dictionary contains the aliases as keys and the index as value.
         This can be accessed as dictionary ``${aliases.key}`` or as list ``@{aliases}[0]``.
@@ -472,30 +473,30 @@ def get_browser_aliases(self):
         return self.drivers.active_aliases
 
     @keyword
-    def get_session_id(self):
+    def get_session_id(self) -> str:
         """Returns the currently active browser session id.
 
         New in SeleniumLibrary 3.2
         """
         return self.driver.session_id
 
     @keyword
-    def get_source(self):
+    def get_source(self) -> str:
         """Returns the entire HTML source of the current page or frame."""
         return self.driver.page_source
 
     @keyword
-    def get_title(self):
+    def get_title(self) -> str:
         """Returns the title of the current page."""
         return self.driver.title
 
     @keyword
-    def get_location(self):
+    def get_location(self) -> str:
         """Returns the current browser window URL."""
         return self.driver.current_url
 
     @keyword
-    def location_should_be(self, url, message=None):
+    def location_should_be(self, url: str, message: Optional[str] = None):
         """Verifies that the current URL is exactly ``url``.
 
         The ``url`` argument contains the exact url that should exist in browser.
@@ -513,7 +514,7 @@ def location_should_be(self, url, message=None):
         self.info(f"Current location is '{url}'.")
 
     @keyword
-    def location_should_contain(self, expected, message=None):
+    def location_should_contain(self, expected: str, message: Optional[str] = None):
         """Verifies that the current URL contains ``expected``.
 
         The ``expected`` argument contains the expected value in url.
@@ -534,14 +535,14 @@ def location_should_contain(self, expected, message=None):
         self.info(f"Current location contains '{expected}'.")
 
     @keyword
-    def log_location(self):
+    def log_location(self) -> str:
         """Logs and returns the current browser window URL."""
         url = self.get_location()
         self.info(url)
         return url
 
     @keyword
-    def log_source(self, loglevel="INFO"):
+    def log_source(self, loglevel: str = "INFO") -> str:
         """Logs and returns the HTML source of the current page or frame.
 
         The ``loglevel`` argument defines the used log level. Valid log
@@ -553,14 +554,14 @@ def log_source(self, loglevel="INFO"):
         return source
 
     @keyword
-    def log_title(self):
+    def log_title(self) -> str:
         """Logs and returns the title of the current page."""
         title = self.get_title()
         self.info(title)
         return title
 
     @keyword
-    def title_should_be(self, title, message=None):
+    def title_should_be(self, title: str, message: Optional[str] = None):
         """Verifies that the current page title equals ``title``.
 
         The ``message`` argument can be used to override the default error
@@ -592,7 +593,7 @@ def reload_page(self):
         self.driver.refresh()
 
     @keyword
-    def get_selenium_speed(self):
+    def get_selenium_speed(self) -> str:
         """Gets the delay that is waited after each Selenium command.
 
         The value is returned as a human-readable string like ``1 second``.
@@ -602,7 +603,7 @@ def get_selenium_speed(self):
         return secs_to_timestr(self.ctx.speed)
 
     @keyword
-    def get_selenium_timeout(self):
+    def get_selenium_timeout(self) -> str:
         """Gets the timeout that is used by various keywords.
 
         The value is returned as a human-readable string like ``1 second``.
@@ -612,7 +613,7 @@ def get_selenium_timeout(self):
         return secs_to_timestr(self.ctx.timeout)
 
     @keyword
-    def get_selenium_implicit_wait(self):
+    def get_selenium_implicit_wait(self) -> str:
         """Gets the implicit wait value used by Selenium.
 
         The value is returned as a human-readable string like ``1 second``.
@@ -622,7 +623,7 @@ def get_selenium_implicit_wait(self):
         return secs_to_timestr(self.ctx.implicit_wait)
 
     @keyword
-    def set_selenium_speed(self, value):
+    def set_selenium_speed(self, value: str) -> str:
         """Sets the delay that is waited after each Selenium command.
 
         The value can be given as a number that is considered to be
@@ -642,7 +643,7 @@ def set_selenium_speed(self, value):
         return old_speed
 
     @keyword
-    def set_selenium_timeout(self, value):
+    def set_selenium_timeout(self, value: str) -> str:
         """Sets the timeout that is used by various keywords.
 
         The value can be given as a number that is considered to be
@@ -664,7 +665,7 @@ def set_selenium_timeout(self, value):
         return old_timeout
 
     @keyword
-    def set_selenium_implicit_wait(self, value):
+    def set_selenium_implicit_wait(self, value: str) -> str:
         """Sets the implicit wait value used by Selenium.
 
         The value can be given as a number that is considered to be
@@ -690,7 +691,7 @@ def set_selenium_implicit_wait(self, value):
         return old_wait
 
     @keyword
-    def set_browser_implicit_wait(self, value):
+    def set_browser_implicit_wait(self, value: str):
         """Sets the implicit wait value used by Selenium.
 
         Same as `Set Selenium Implicit Wait` but only affects the current

src/SeleniumLibrary/keywords/cookie.py

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 from datetime import datetime
+from typing import Union, Optional
 
 from robot.libraries.DateTime import convert_date
 from robot.utils import DotDict
@@ -24,6 +25,35 @@
 from SeleniumLibrary.utils import is_truthy, is_noney, is_falsy
 
 
+class CookieInformation:
+    def __init__(
+        self,
+        name,
+        value,
+        path=None,
+        domain=None,
+        secure=False,
+        httpOnly=False,
+        expiry=None,
+        **extra,
+    ):
+        self.name = name
+        self.value = value
+        self.path = path
+        self.domain = domain
+        self.secure = secure
+        self.httpOnly = httpOnly
+        self.expiry = datetime.fromtimestamp(expiry) if expiry else None
+        self.extra = extra
+
+    def __str__(self):
+        items = "name value path domain secure httpOnly expiry".split()
+        string = "\n".join(f"{item}={getattr(self, item)}" for item in items)
+        if self.extra:
+            string = f"{string}\nextra={self.extra}\n"
+        return string
+
+
 class CookieKeywords(LibraryComponent):
     @keyword
     def delete_all_cookies(self):
@@ -39,7 +69,7 @@ def delete_cookie(self, name):
         self.driver.delete_cookie(name)
 
     @keyword
-    def get_cookies(self, as_dict=False):
+    def get_cookies(self, as_dict: bool = False) -> Union[str, dict]:
         """Returns all cookies of the current page.
 
         If ``as_dict`` argument evaluates as false, see `Boolean arguments`
@@ -66,7 +96,7 @@ def get_cookies(self, as_dict=False):
             return pairs
 
     @keyword
-    def get_cookie(self, name):
+    def get_cookie(self, name: str) -> CookieInformation:
         """Returns information of cookie with ``name`` as an object.
 
         If no cookie is found with ``name``, keyword fails. The cookie object
@@ -112,7 +142,7 @@ def get_cookie(self, name):
         return CookieInformation(**cookie)
 
     @keyword
-    def add_cookie(self, name, value, path=None, domain=None, secure=None, expiry=None):
+    def add_cookie(self, name: str, value: str, path: Optional[str] = None, domain: Optional[str] = None, secure: Optional[str] = None, expiry: Optional[str] = None):
         """Adds a cookie to your current session.
 
         ``name`` and ``value`` are required, ``path``, ``domain``, ``secure``
@@ -145,32 +175,3 @@ def _expiry(self, expiry):
             return int(expiry)
         except ValueError:
             return int(convert_date(expiry, result_format="epoch"))
-
-
-class CookieInformation:
-    def __init__(
-        self,
-        name,
-        value,
-        path=None,
-        domain=None,
-        secure=False,
-        httpOnly=False,
-        expiry=None,
-        **extra,
-    ):
-        self.name = name
-        self.value = value
-        self.path = path
-        self.domain = domain
-        self.secure = secure
-        self.httpOnly = httpOnly
-        self.expiry = datetime.fromtimestamp(expiry) if expiry else None
-        self.extra = extra
-
-    def __str__(self):
-        items = "name value path domain secure httpOnly expiry".split()
-        string = "\n".join(f"{item}={getattr(self, item)}" for item in items)
-        if self.extra:
-            string = f"{string}\nextra={self.extra}\n"
-        return string