Typing to base objects

Author: aaltat

src/SeleniumLibrary/base/context.py

@@ -13,6 +13,9 @@
 # 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 Any, Optional, List
+
+from selenium.webdriver.remote.webelement import WebElement
 
 from SeleniumLibrary.utils import escape_xpath_value
 
@@ -39,18 +42,24 @@ def element_finder(self):
         return self.ctx._element_finder
 
     @element_finder.setter
-    def element_finder(self, value):
+    def element_finder(self, value: Any):
         self.ctx._element_finder = value
 
     @property
     def event_firing_webdriver(self):
         return self.ctx.event_firing_webdriver
 
     @event_firing_webdriver.setter
-    def event_firing_webdriver(self, event_firing_webdriver):
+    def event_firing_webdriver(self, event_firing_webdriver: Any):
         self.ctx.event_firing_webdriver = event_firing_webdriver
 
-    def find_element(self, locator, tag=None, required=True, parent=None):
+    def find_element(
+        self,
+        locator: str,
+        tag: Optional[str] = None,
+        required: bool = True,
+        parent: WebElement = None,
+    ) -> WebElement:
         """Find element matching `locator`.
 
         :param locator: Locator to use when searching the element.
@@ -72,7 +81,9 @@ def find_element(self, locator, tag=None, required=True, parent=None):
         """
         return self.element_finder.find(locator, tag, True, required, parent)
 
-    def find_elements(self, locator, tag=None, parent=None):
+    def find_elements(
+        self, locator: str, tag: Optional[str] = None, parent: WebElement = None
+    ) -> List[WebElement]:
         """Find all elements matching `locator`.
 
         :param locator: Locator to use when searching the element.
@@ -88,14 +99,14 @@ def find_elements(self, locator, tag=None, parent=None):
         """
         return self.element_finder.find(locator, tag, False, False, parent)
 
-    def is_text_present(self, text):
+    def is_text_present(self, text: str):
         locator = f"xpath://*[contains(., {escape_xpath_value(text)})]"
         return self.find_element(locator, required=False) is not None
 
-    def is_element_enabled(self, locator, tag=None):
+    def is_element_enabled(self, locator: str, tag: Optional[str] = None) -> bool:
         element = self.find_element(locator, tag)
         return element.is_enabled() and element.get_attribute("readonly") is None
 
-    def is_visible(self, locator):
+    def is_visible(self, locator: str) -> bool:
         element = self.find_element(locator, required=False)
         return element.is_displayed() if element else None

src/SeleniumLibrary/base/librarycomponent.py

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 import os
+from typing import Optional
 
 from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
@@ -25,23 +26,29 @@
 
 
 class LibraryComponent(ContextAware):
-    def info(self, msg, html=False):
+    def info(self, msg: str, html: bool = False):
         logger.info(msg, html)
 
     def debug(self, msg, html=False):
         logger.debug(msg, html)
 
-    def log(self, msg, level="INFO", html=False):
+    def log(self, msg: str, level: str = "INFO", html: bool = False):
         if not is_noney(level):
             logger.write(msg, level.upper(), html)
 
-    def warn(self, msg, html=False):
+    def warn(self, msg: str, html: bool = False):
         logger.warn(msg, html)
 
-    def log_source(self, loglevel="INFO"):
+    def log_source(self, loglevel: str = "INFO"):
         self.ctx.log_source(loglevel)
 
-    def assert_page_contains(self, locator, tag=None, message=None, loglevel="TRACE"):
+    def assert_page_contains(
+        self,
+        locator: str,
+        tag: Optional[str] = None,
+        message: Optional[str] = None,
+        loglevel: str = "TRACE",
+    ):
         tag_message = tag or "element"
         if not self.find_element(locator, tag, required=False):
             self.log_source(loglevel)
@@ -53,7 +60,11 @@ def assert_page_contains(self, locator, tag=None, message=None, loglevel="TRACE"
         logger.info(f"Current page contains {tag_message} '{locator}'.")
 
     def assert_page_not_contains(
-        self, locator, tag=None, message=None, loglevel="TRACE"
+        self,
+        locator: str,
+        tag: Optional[str] = None,
+        message: Optional[str] = None,
+        loglevel: str = "TRACE",
     ):
         tag_message = tag or "element"
         if self.find_element(locator, tag, required=False):
@@ -63,7 +74,7 @@ def assert_page_not_contains(
             raise AssertionError(message)
         logger.info(f"Current page does not contain {tag_message} '{locator}'.")
 
-    def get_timeout(self, timeout=None):
+    def get_timeout(self, timeout: Optional[str] = None) -> float:
         if is_noney(timeout):
             return self.ctx.timeout
         return timestr_to_secs(timeout)