How to Handle Stale Element Exception in Selenium: Fix & Prevention

A StaleElementReferenceException happens when the web element you want to interact with is no longer attached to the page DOM. To handle it, you should re-locate the element before interacting again, often by using explicit waits or retrying the find operation.

Why This Happens

This exception occurs because the web page has changed after you found the element, so the reference to that element is no longer valid. For example, the page refreshed, or the element was removed and re-added. Selenium still holds the old reference, causing the error.

python

from selenium import webdriver
from selenium.common.exceptions import StaleElementReferenceException

browser = webdriver.Chrome()
browser.get('https://example.com')

# Find the element
button = browser.find_element('id', 'submit')

# Page changes here (e.g., reload or DOM update)

# Try to click the old element reference
button.click()  # This may raise StaleElementReferenceException

Output

selenium.common.exceptions.StaleElementReferenceException: Message: stale element reference: element is not attached to the page document

The Fix

To fix this, you should locate the element again after the page changes. Using a try-except block to catch the exception and retry finding the element is a common approach. Using explicit waits helps ensure the element is ready before interacting.

python

from selenium import webdriver
from selenium.common.exceptions import StaleElementReferenceException
from selenium.webdriver.common.by import By
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC

browser = webdriver.Chrome()
browser.get('https://example.com')

wait = WebDriverWait(browser, 10)

# Function to safely click element handling stale exception
def safe_click(locator):
    for _ in range(3):  # retry up to 3 times
        try:
            element = wait.until(EC.element_to_be_clickable(locator))
            element.click()
            return
        except StaleElementReferenceException:
            pass  # retry
    raise Exception('Element not clickable after retries')

safe_click((By.ID, 'submit'))

Output

Element clicked successfully without exception

Prevention

To avoid stale element exceptions, always locate elements as close as possible to the action you want to perform. Avoid storing element references for long periods. Use explicit waits to wait for elements to be ready. Also, avoid page reloads or DOM changes between locating and interacting with elements.

• Use WebDriverWait with expected conditions.
• Locate elements inside the action method, not globally.
• Handle exceptions with retries if needed.

Related Errors

Other common Selenium errors related to element interaction include:

• NoSuchElementException: Element not found on the page.
• ElementNotInteractableException: Element is present but cannot be interacted with (e.g., hidden).
• TimeoutException: Waiting for an element timed out.

Handling these often involves similar strategies: waiting properly and locating elements at the right time.

Key Takeaways

Always re-locate elements after page changes to avoid stale references.

Use explicit waits to ensure elements are ready before interacting.

Avoid storing element references for long periods in your test code.

Implement retry logic to handle transient stale element exceptions.

Understand related exceptions to improve test stability.