StaleElementReferenceException handling in Selenium Python - Build an Automation Script

Handle StaleElementReferenceException when clicking a dynamic button

Preconditions (2)

Step 1: Locate the button with id 'refresh-btn'

Step 2: Click the button

Step 3: Immediately try to click the same button again

Step 4: If a StaleElementReferenceException occurs, re-locate the button and click it again

✅ Expected Result: The button is clicked twice successfully without the test failing due to StaleElementReferenceException

Automation Requirements - Selenium with Python

Assertions Needed:

Verify no StaleElementReferenceException is unhandled during the test

Verify the button click triggers expected page behavior (e.g., a message with id 'status-msg' updates)

Best Practices:

Use explicit waits to wait for elements to be clickable

Use try-except block to catch StaleElementReferenceException and retry element lookup

Avoid hardcoded sleeps

Use By.ID locator for the button

Automated Solution

Selenium Python

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


def test_handle_stale_element():
    driver = webdriver.Chrome()
    wait = WebDriverWait(driver, 10)
    try:
        driver.get('http://example.com/dynamic')

        # Locate the button
        button = wait.until(EC.element_to_be_clickable((By.ID, 'refresh-btn')))

        # Click the button first time
        button.click()

        # Try clicking the button again, handle StaleElementReferenceException
        try:
            button.click()
        except StaleElementReferenceException:
            # Re-locate the button and click again
            button = wait.until(EC.element_to_be_clickable((By.ID, 'refresh-btn')))
            button.click()

        # Verify the status message updated after clicks
        status_msg = wait.until(EC.visibility_of_element_located((By.ID, 'status-msg')))
        assert 'updated' in status_msg.text.lower(), f"Expected 'updated' in status message but got '{status_msg.text}'"

    finally:
        driver.quit()

This test opens the dynamic page and waits for the button with id 'refresh-btn' to be clickable. It clicks the button once. Then it tries to click the same button again. Because the page content may reload, the button reference can become stale, causing a StaleElementReferenceException. We catch this exception, re-find the button using an explicit wait, and click it again.

Finally, the test waits for a status message element to appear and checks that its text contains the word 'updated', confirming the clicks triggered the expected page behavior.

Using explicit waits ensures the element is ready before interacting. The try-except block handles the stale element gracefully without failing the test.

Common Mistakes - 3 Pitfalls

Not catching StaleElementReferenceException and letting the test fail

Using time.sleep instead of explicit waits

Locating the element only once before all interactions

Bonus Challenge

Now add data-driven testing to click the button multiple times with different expected status messages

Show Hint

Practice

1.

What does StaleElementReferenceException mean in Selenium testing?

easy

A. The browser failed to open the webpage.

B. The element locator syntax is incorrect.

C. The element you found is no longer attached to the page DOM.

D. The test script has a syntax error.

Solution

1. Step 1: Understand what stale means in Selenium context

   Stale means the element reference is outdated because the page changed after finding it.

2. Step 2: Match the meaning to the options

   The element you found is no longer attached to the page DOM. correctly describes the element no longer attached to the DOM, which causes the exception.

3. Final Answer:

   The element you found is no longer attached to the page DOM. -> Option C

4. Quick Check:

   StaleElementReferenceException = element detached [OK]

Hint: Stale means element changed or removed from page [OK]

Common Mistakes:

• Confusing stale with locator errors
• Thinking it's a browser or syntax error
• Assuming stale means element not found

2.

Which of the following is the correct way to catch StaleElementReferenceException in Python Selenium?

try:
    element = driver.find_element(By.ID, 'submit')
    element.click()
except _____:
    element = driver.find_element(By.ID, 'submit')
    element.click()

easy

A. StaleElementReferenceException

B. NoSuchElementException

C. TimeoutException

D. ElementNotInteractableException

Solution

1. Step 1: Identify the exception to catch for stale elements

   The exception raised when an element is no longer attached is StaleElementReferenceException.

2. Step 2: Match the exception name in the except block

   Only StaleElementReferenceException matches the exact exception to handle stale element references.

3. Final Answer:

   StaleElementReferenceException -> Option A

4. Quick Check:

   Catch stale element with StaleElementReferenceException [OK]

Hint: Catch exactly StaleElementReferenceException to retry [OK]

Common Mistakes:

• Using wrong exception names
• Catching unrelated exceptions
• Not retrying after catching

3.

What will happen when this code runs if the element becomes stale after the first find?

from selenium.common.exceptions import StaleElementReferenceException

try:
    button = driver.find_element(By.ID, 'btn')
    button.click()
except StaleElementReferenceException:
    button = driver.find_element(By.ID, 'btn')
    button.click()
print('Clicked successfully')

medium

A. The except block is skipped and nothing happens.

B. The button is clicked twice, then 'Clicked successfully' prints.

C. The code throws an error and stops before printing.

D. The button is clicked once, then 'Clicked successfully' prints.

Solution

1. Step 1: Understand the try-except flow with stale element

   If the element is stale on first click, exception triggers except block to find and click again.

2. Step 2: Confirm the final print statement executes

   After successful click in except, the print statement runs, confirming success.

3. Final Answer:

   The button is clicked twice, then 'Clicked successfully' prints. -> Option B

4. Quick Check:

   Retry click on stale element then print success [OK]

Hint: Retry click after stale exception to succeed [OK]

Common Mistakes:

• Assuming code stops on exception
• Thinking except block clicks twice
• Ignoring the print statement

4.

Identify the error in this code snippet that tries to handle StaleElementReferenceException:

element = driver.find_element(By.ID, 'link')
try:
    element.click()
except StaleElementReferenceException:
    element.click()

medium

A. The except block retries click without finding the element again.

B. The try block should be inside the except block.

C. The exception name is misspelled.

D. The element locator is incorrect.

Solution

1. Step 1: Check how stale element is handled in except block

   The except block retries click on the same old element without refinding it.

2. Step 2: Explain why this causes error

   Since the element is stale, retrying click without finding again will raise the exception again.

3. Final Answer:

   The except block retries click without finding the element again. -> Option A

4. Quick Check:

   Must refind element before retrying click [OK]

Hint: Always find element again after stale exception [OK]

Common Mistakes:

• Retrying action on stale element without refinding
• Misplacing try-except blocks
• Misspelling exception names

5.

You want to click a button that may reload the page, causing StaleElementReferenceException. Which approach best handles this?

def click_button():
    for _ in range(3):
        try:
            btn = driver.find_element(By.ID, 'reload-btn')
            btn.click()
            break
        except StaleElementReferenceException:
            # What should go here?
            pass

hard

A. Use a different locator that never becomes stale.

B. Raise the exception immediately to fail fast.

C. Ignore the exception and continue without clicking.

D. Add a short wait (e.g., time.sleep) before retrying to let page reload.

Solution

1. Step 1: Understand retry loop for stale element

   The loop retries finding and clicking the button up to 3 times if stale exception occurs.

2. Step 2: Explain why adding a short wait helps

   Waiting briefly allows the page to reload and stabilize, so the element can be found fresh on retry.

3. Final Answer:

   Add a short wait (e.g., time.sleep) before retrying to let page reload. -> Option D

4. Quick Check:

   Wait before retrying stale element to succeed [OK]

Hint: Wait briefly before retrying stale element actions [OK]

Common Mistakes:

• Failing immediately without retry
• Ignoring stale exception silently
• Assuming locator never becomes stale