Autowating for WebElement.clear()

obrizan · obrizan · commit 54b47a4dd2d7 · 2025-01-31T18:42:50.000+02:00
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Welcome to the Selenium + Python Template Project! This repository provides a we
 - **Scalability**: Easy to extend for larger projects.
 - **Integration-Ready**: Built-in support for integrating with APIs, CI/CD pipelines, and reporting tools.
 - **Cross-Browser Support**: Pre-configured WebDriver factory for managing multiple browsers.
-- **Auto-waiting**: `WebDriver.click()` waits for an element to be clickable automatically.
+- **Autowaiting**: `WebElement.click()`, `WebElement.send_keys()`, `WebElement.clear()` waits for an element to be enabled/clickable/editable automatically, use `autowait` fixture. Feature inspired by Playwright.
 
 ## 🏗️ Project Structure
 
diff --git a/utils/autowait.html b/utils/autowait.html
@@ -6,19 +6,30 @@
 </head>
 <body>
 
+<h1>Playground to test autowaiting for WebElement</h1>
+<h2>click()</h2>
 <p>
     <button id="first" onclick="first_button_on_click()">Enable button</button>
 </p>
 <p>
     <button id="second" disabled onclick="second_button_on_click()">Second button</button>
 </p>
 <p id="placeholder"></p>
+<h2>send_keys()</h2>
 <p>
     <button id="third" onclick="third_button_on_click()">Enable input</button>
 </p>
 <p>
     <label for="input">Disabled input</label><input id="input" disabled />
 </p>
+<h2>clear()</h2>
+<p>
+    <button id="fourth" onclick="enable('textarea')">Enable textarea</button>
+</p>
+<p>
+    <label for="textarea">Disabled textarea</label><textarea id="textarea" disabled>Some text which must be cleared</textarea>
+</p>
+
 <script>
     function first_button_on_click() {
         setTimeout(() => {
@@ -35,6 +46,12 @@
             document.getElementById("input").disabled = false;
         }, 1500);
     }
+
+    function enable(id) {
+        setTimeout(() => {
+            document.getElementById(id).disabled = false;
+        }, 1500);
+    }
 </script>
 </body>
 </html>
diff --git a/utils/autowait.py b/utils/autowait.py
@@ -1,4 +1,4 @@
-# Monkey-patching WebElement.click to add retry logic for unclickable elements.
+# Monkey-patching WebElement methods to add waiting logic for unclickable elements.
 # This patch is applied globally to all WebElement instances.
 from selenium.webdriver.remote.webelement import WebElement
 from selenium.webdriver.support import expected_conditions as EC
@@ -45,7 +45,27 @@ def patched_send_keys(self, *args, **kwargs):
     return patched_send_keys
 
 
-def enable_autowait(timeout: float=10.0) -> None:
+def patched_clear_factory(timeout: float):
+    """
+    Args:
+        timeout (float): Maximum time to wait for the element to become clickable.
+    """
+
+    def patched_clear(self, *args, **kwargs):
+        """
+        Patches the WebElement's clear method to wait for the element to be clickable.
+        Args:
+            self: WebElement object.
+        """
+        driver = self.parent
+        WebDriverWait(driver, timeout).until(EC.element_to_be_clickable(self))
+
+        self._original_clear(*args, **kwargs)
+
+    return patched_clear
+
+
+def enable_autowait(timeout: float = 10.0) -> None:
     """
     Enables auto-waiting globally for all WebDriver.click() invokcations
     Args:
@@ -54,16 +74,22 @@ def enable_autowait(timeout: float=10.0) -> None:
     """
     assert not hasattr(WebElement, "_original_click"), "Autowait already enabled."
     assert not hasattr(WebElement, "_original_send_keys"), "Autowait already enabled."
+    assert not hasattr(WebElement, "_original_clear"), "Autowait already enabled."
     WebElement._original_click = WebElement.click
     WebElement.click = patched_click_factory(timeout)
     WebElement._original_send_keys = WebElement.send_keys
     WebElement.send_keys = patched_send_keys_factory(timeout)
+    WebElement._original_clear = WebElement.clear
+    WebElement.clear = patched_clear_factory(timeout)
 
 
 def disable_autowait() -> None:
     assert hasattr(WebElement, "_original_click"), "Autowait is not enabled."
     assert hasattr(WebElement, "_original_send_keys"), "Autowait is not enabled."
+    assert hasattr(WebElement, "_original_clear"), "Autowait is not enabled."
     WebElement.click = WebElement._original_click
-    del(WebElement._original_click)
+    del WebElement._original_click
     WebElement.send_keys = WebElement._original_send_keys
-    del(WebElement._original_send_keys)
+    del WebElement._original_send_keys
+    WebElement.clear = WebElement._original_clear
+    del WebElement._original_clear
diff --git a/utils/test_autowait.py b/utils/test_autowait.py
@@ -1,7 +1,10 @@
 import os
 
 import pytest
-from selenium.common import ElementNotInteractableException
+from selenium.common import (
+    ElementNotInteractableException,
+    InvalidElementStateException,
+)
 from selenium.webdriver.common.by import By
 from selenium.webdriver.remote.webdriver import WebDriver
 
@@ -25,6 +28,8 @@ def test_send_keys(driver: WebDriver):
     with pytest.raises(ElementNotInteractableException) as exc:
         input_el.send_keys("hello")
 
+    assert input_el.get_attribute("value") == ""
+
 
 def test_click_auto_wait(driver: WebDriver, autowait):
     driver.get(f"file://{os.path.abspath('utils/autowait.html')}")
@@ -44,3 +49,25 @@ def test_send_keys_auto_wait(driver: WebDriver, autowait):
     input_el.send_keys("hello")
 
     assert input_el.get_attribute("value") == "hello"
+
+
+def test_clear(driver: WebDriver):
+    driver.get(f"file://{os.path.abspath('utils/autowait.html')}")
+
+    fourth_button = driver.find_element(By.ID, "fourth")
+    textarea_el = driver.find_element(By.ID, "textarea")
+    fourth_button.click()
+    with pytest.raises(InvalidElementStateException) as exc:
+        textarea_el.clear()
+    assert textarea_el.get_attribute("value") == "Some text which must be cleared"
+
+
+def test_clear_autowait(driver: WebDriver, autowait):
+    driver.get(f"file://{os.path.abspath('utils/autowait.html')}")
+
+    fourth_button = driver.find_element(By.ID, "fourth")
+    textarea_el = driver.find_element(By.ID, "textarea")
+    fourth_button.click()
+    textarea_el.clear()
+
+    assert textarea_el.get_attribute("value") == ""
