improved base_page.py

Author: dmy.berezovskyi

.ruff.toml

@@ -1,5 +1,5 @@
 # Ruff Configuration
-line-length = 88
+line-length = 85
 indent-width = 4
 output-format = "grouped"
 respect-gitignore = true

pyproject.toml

@@ -13,7 +13,7 @@ packages = [
 python = "^3.12"
 pytest = "8.3.2"
 PyYAML = "^6.0.1"
-selenium = "4.24.0"
+selenium = "~4.24.0"
 webdriver-manager = "4.0.2"
 python-dotenv = "1.0.1"
 asyncio = "3.4.3"

src/pageobjects/base_page.py

@@ -1,12 +1,14 @@
 from enum import Enum
-from typing import Tuple
-
-from appium.webdriver import WebElement
-from selenium.common import ElementNotVisibleException, TimeoutException
+from typing import Tuple, Optional, Literal
 from selenium.webdriver.common.by import By
-from selenium.webdriver.support import expected_conditions as ec
+from selenium.webdriver.remote.webelement import WebElement
+from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.wait import WebDriverWait
+from selenium.common.exceptions import (
+    TimeoutException, ElementNotVisibleException
+)
 
+# Type alias for locators
 Locator = Tuple[By, str]
 
 
@@ -30,33 +32,77 @@ def __init__(self, driver):
             ignored_exceptions=[ElementNotVisibleException],
         )
 
-    def wait(
-        self, locator: Locator, waiter: WebDriverWait = None
+    def _get_waiter(self, wait_type: Optional[WaitType] = None) -> WebDriverWait:
+        """
+        Returns the appropriate WebDriverWait object based on the wait_type.
+        Defaults to the default wait if no wait_type is provided.
+        """
+        return {
+            WaitType.SHORT: self._short_wait,
+            WaitType.LONG: self._long_wait,
+            WaitType.FLUENT: self._fluent_wait,
+        }.get(wait_type, self._wait)
+
+    def wait_for(
+        self,
+        locator: Locator,
+        condition: Literal["clickable", "visible", "present"],
+        waiter: Optional[WebDriverWait] = None,
     ) -> WebElement:
-        if waiter is None:
-            waiter = self._wait
+        waiter = waiter or self._wait
+
+        conditions = {
+            "clickable": EC.element_to_be_clickable(*locator),
+            "visible": EC.visibility_of_element_located(*locator),
+            "present": EC.presence_of_element_located(*locator),
+        }
+
+        if condition not in conditions:
+            raise ValueError(f"Unknown condition: {condition}")
+
         try:
-            return waiter.until(ec.presence_of_element_located(locator))
-        except TimeoutException:
+            return waiter.until(conditions[condition])
+        except TimeoutException as e:
             raise TimeoutException(
-                f"Element {locator} not found after {waiter._timeout} seconds"
-            )
-
-    def find(self, locator: Locator):
-        self.driver.find_element(*locator)
+                f"Condition '{condition}' failed for element {locator} "
+                f"after {waiter._timeout} seconds"
+            ) from e
 
-    def click(self, locator: Locator):
-        element = self.wait(locator)
+    def click(
+        self,
+        locator: Locator,
+        condition: Literal["clickable", "visible", "present"] = "clickable",
+        wait_type: Optional[WaitType] = None,
+    ):
+        """
+        Click on an element.
+        """
+        waiter = self._get_waiter(wait_type)
+        element = self.wait_for(locator, condition=condition, waiter=waiter)
         element.click()
 
-    def set(self, locator: Locator, text: str):
-        element = self.wait(locator)
+    def set(
+        self, locator: Locator, text: str, wait_type: Optional[WaitType] = None
+    ):
+        """
+        Set text in an input field.
+        """
+        waiter = self._get_waiter(wait_type)
+        element = self.wait_for(locator, condition="visible", waiter=waiter)
         element.clear()
         element.send_keys(text)
 
-    def get_text(self, locator: Locator):
-        element = self.wait(locator)
-        return element.text
+    def get_text(
+        self, locator: Locator, wait_type: Optional[WaitType] = None
+    ) -> str:
+        """
+        Get the text of an element.
+        """
+        waiter = self._get_waiter(wait_type)
+        return self.wait_for(locator, condition="present", waiter=waiter).text
 
-    def get_title(self):
+    def get_title(self) -> str:
+        """
+        Get the page title.
+        """
         return self.driver.title