selenium.webdriver.support.ui

class selenium.webdriver.support.ui.Select(webelement: WebElement)

Constructor. A check is made that the given element is, indeed, a SELECT tag. If it is not, then an UnexpectedTagNameException is thrown.

Args:

• webelement - SELECT element to wrap

Example:

from selenium.webdriver.support.ui import Select

Select(driver.find_element(By.TAG_NAME, “select”)).select_by_index(2)

property options: List[WebElement]

Returns a list of all options belonging to this select tag.

property all_selected_options: List[WebElement]

Returns a list of all selected options belonging to this select tag.

property first_selected_option: WebElement

The first selected option in this select tag (or the currently selected option in a normal select)

select_by_value(value: str) → None

Select all options that have a value matching the argument. That is, when given “foo” this would select an option like:

<option value=”foo”>Bar</option>

Args:

• value - The value to match against

throws NoSuchElementException If there is no option with specified value in SELECT

select_by_index(index: int) → None

Select the option at the given index. This is done by examining the “index” attribute of an element, and not merely by counting.

Args:

• index - The option at this index will be selected

throws NoSuchElementException If there is no option with specified index in SELECT

select_by_visible_text(text: str) → None

Select all options that display text matching the argument. That is, when given “Bar” this would select an option like:

<option value=”foo”>Bar</option>

Args:

• text - The visible text to match against

throws NoSuchElementException If there is no option with specified text in SELECT

deselect_all() → None

Clear all selected entries.

This is only valid when the SELECT supports multiple selections. throws NotImplementedError If the SELECT does not support multiple selections

deselect_by_value(value: str) → None

Deselect all options that have a value matching the argument. That is, when given “foo” this would deselect an option like:

<option value=”foo”>Bar</option>

Args:

• value - The value to match against

throws NoSuchElementException If there is no option with specified value in SELECT

deselect_by_index(index: int) → None

Deselect the option at the given index. This is done by examining the “index” attribute of an element, and not merely by counting.

Args:

• index - The option at this index will be deselected

throws NoSuchElementException If there is no option with specified index in SELECT

deselect_by_visible_text(text: str) → None

Deselect all options that display text matching the argument. That is, when given “Bar” this would deselect an option like:

<option value=”foo”>Bar</option>

Args:

• text - The visible text to match against

class selenium.webdriver.support.ui.WebDriverWait(driver: D, timeout: float, poll_frequency: float = 0.5, ignored_exceptions: Iterable[Type[Exception]] | None = None)

Constructor, takes a WebDriver instance and timeout in seconds.

Attributes:

driver

• Instance of WebDriver (Ie, Firefox, Chrome or Remote) or

a WebElement

timeout

• Number of seconds before timing out

poll_frequency

• Sleep interval between calls

• By default, it is 0.5 second.

ignored_exceptions

• Iterable structure of exception classes ignored during calls.

• By default, it contains NoSuchElementException only.

Example:

>>> from selenium.webdriver.common.by import By
>>> from selenium.webdriver.support.wait import WebDriverWait
>>> from selenium.common.exceptions import ElementNotVisibleException
>>>
>>> # Wait until the element is no longer visible
>>> is_disappeared = WebDriverWait(driver, 30, 1, (ElementNotVisibleException))
...     .until_not(lambda x: x.find_element(By.ID, "someId").is_displayed())

until(method: Callable[[D], Literal[False] | T], message: str = '') → T

Wait until the method returns a value that is not False.

Calls the method provided with the driver as an argument until the return value does not evaluate to False.

Parameters:

method: callable(WebDriver)

• A callable object that takes a WebDriver instance as an argument.

message: str

• Optional message for TimeoutException

Return:

object: T

• The result of the last call to method

Raises:

TimeoutException

• If ‘method’ does not return a truthy value within the WebDriverWait

object’s timeout

Example:

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

# Wait until an element is visible on the page >>> wait = WebDriverWait(driver, 10) >>> element = wait.until(EC.visibility_of_element_located((By.ID, “exampleId”))) >>> print(element.text)

until_not(method: Callable[[D], T], message: str = '') → T | Literal[True]

Wait until the method returns a value that is not False.

Calls the method provided with the driver as an argument until the return value does not evaluate to False.

Parameters:

method: callable(WebDriver)

• A callable object that takes a WebDriver instance as an argument.

message: str

• Optional message for TimeoutException

Return:

object: T

• The result of the last call to method

Raises:

TimeoutException

• If ‘method’ does not return False within the WebDriverWait

object’s timeout

Example:

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

# Wait until an element is visible on the page >>> wait = WebDriverWait(driver, 10) >>> is_disappeared = wait.until_not(EC.visibility_of_element_located( … (By.ID, “exampleId”)))