web自动化等待机制详解

 一、sleep

sleep(timeout) 是设定一个固定的等待时长，代码运行到此处，会强行进行等待指定的时间，使用方便的同时，效率最低，不建议使 用。

缺点：不能准确把握需要等待的时间（有时操作还未完成，等待就结束了，导致报错；有时操作已经完成了，但等待时间还没有到， 浪费时间），如果在用例中大量使用，会浪费不必要的等待时间，影响测试用例的执行效率。

优点：使用简单，可以在调试时使用。

# 强行等待 10s 
time.sleep(10) 

二、隐式等待

隐式等待也是设定一个固定的等待时间，对整个生命周期的元素都起作用，每一个元素都会等待加载完全，直到超过设定的等待时 间。

其设置了一个最长等待时间，如果在规定时间内网页加载完成，则执行下一步，否则一直等到时间结束，然后执行下一步操作。

缺点：使用隐式等待，程序会一直等待整个页面加载完成，才会执行下一步操作； 但有时候页面想要的元素早已经加载完成了，但是因为网页上个别元素还没有加载完成，仍要等到页面全部完成才能执行下一步，使 用也不是很灵活。

优点：隐性等待对整个driver的周期都起作用，所以只要设置一次即可。

警告：不要混合使用隐式和显式等待。这样做会导致不可预测的等待时间。例如，将隐式等待设置为10秒，将显式等待设置为15秒， 可能会导致在20秒后发生超时。

----来自Selenium官方文档的警告： https://www.selenium.dev/zh-cn/documentation/webdriver/waits/

# 隐式等待设定时长为5s 
 driver.implicitly_wait(5) 

 driver.get('http://www.google.com') 

 # 隐式等待所有元素加载完成,直到超过设定的最长时间 

 driver.find_element_by_id("element_id").click()

三、显式等待

显式等待 相比隐式等待更灵活，是先设定一个条件函数和一个最长等待时长，轮询判断条件函数的返回值，如果返回 True，则开始执 行后面的操作，否则会一直等待，直到超时报元素未找到异常。

 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 
 driver = webdriver.Chrome() 
 driver.get("http://XX.com") 
 element =WebDriverWait(driver,10).until(EC.presence_of_element_located((By.ID, 
 "Element")))

显示等待需要用到两个类：WebDriverWait和expected_conditions两个类， WebDriverWait指定轮询间隔、超时时间等， expected_conditions 指定了很多条件函数（也可以自定义条件函数），具体可以参考官网： https://www.selenium.dev/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.expected_conditions.html? highlight=expected

1、WebDriverWait 

WebDriverWait(driver,timeout,poll_frequency=0.5,ignored_exceptions=None)

driver：浏览器驱动

timeout：最长超时时间，默认以秒为单位

poll_frequency：轮询的间隔步长，默认为0.5s

ignored_exceptions：忽略等待时出现的特定类型的异常，默认忽略NoSuchElementExeception异常 WebDriverWait（）类中有until()和until_not()方法：

2、until()和until_not()

WebDriverWait(self.driver, timeout, frequency).until(EC.visibility_of_element_located(loc))

until()、until_not()

WebDriverWait 一般是配合until() 或 until_not()方法，就能够根据判断条件而灵活地等待了。主要的意思就是：程序每隔xx秒看一 眼，如果条件成立了，则执行下一步；否则继续等待，直到超过设置的最长时间，然后抛出TimeoutException异常。

格式：

 WebDriverWait(driver, timeout).until(method, message=’’) 
 WebDriverWait(driver, timeout).until_not(method, message=’’)

这里需要特别注意的是until或until_not中的可执行方法method参数，很多人传入了WebElement对象，如下：

 WebDriverWait(driver, 10).until(driver.find_element_by_id('kw')) # 错误

这是错误的用法，这里的参数一定要是可以调用的，即这个对象一定有 call() 方法，否则会抛出异常：TypeError: 'xxx' object is not callable

4、expected_conditions

expected_conditions是selenium的一个模块，其中包含一系列可用于判断的条件： 官方文档链接： https://www.selenium.dev/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.expected_conditions.html? highlight=expected

下面是常用的17种条件的说明：

注意：参数：locator （定位器）和 element（元素）的用法

locator：

ECS.presence_of_element_located((By.ID,'kw'))

element：

ECS.visibility_of(driver.find_element(By.ID,'su'))

4.1 通过页面标题来判断

1.title_is(title)

判断当前页面的title是否完全等于（==）预期字符串，返回布尔值

2.title_contains(title)

判断当前页面的title是否包含预期字符串，返回布尔值

# 元素等待直到标题出现 `百度一下，你就知道` 
WebDriverWait(driver,3).until(ECS.title_is('百度一下，你就知道')) 
# 元素等待直到标题出现包含 `百度` 即可 
WebDriverWait(driver,3).until(ECS.title_contains('百度'))

4.2 通过元素是否可见来判断

通常在网页中并不是所有元素都是可见的，也有的是初始化时不可见，加载完成时则状态又变为可见，所以在元素等 待中以下这些方式是经常被用到的。

3.presence_of_element_located(locator)

判断某个元素是否被加到了dom树里，并不代表该元素一定可见

# 元素等待直到能定位到元素，这里是定位到搜索输入框 
# 这里定位时不关心元素是否可见，只要是加载到DOM中能定位到即可 
WebDriverWait(driver,3).until(ECS.presence_of_element_located((By.ID,'kw')))

4.visibility_of_element_located(locator)

判断某个元素是否可见. 可见代表元素非隐藏，并且元素的宽和高都不等于0

# 元素等待直到能定位到可见的元素，比如这里定位到搜索按钮 
# 和上面不同，这里等待的元素除加载DOM中，也必须可见 
WebDriverWait(driver,3).until(ECS.visibility_of_element_located((By.ID,'su')))

PS：presence_of_element_located和visibility_of_element_located，是显示等待中最常用的判断条件，2者之间的区别就是元素是 否可见，然后元素都必须加载到dom里。

简单点的处理方式是：1种不行，用另一种试试

5.visibility_of(element)

基本和上面方法效果一致，官方原文是：An expectation for checking that an element, known to be present on the DOM of a page, is visible，翻译：判断元素将会加载到页面DOM中，并可见

# 元素等待直到能定位到可见的元素，比如这里定位到搜索框 
# 这个方法和上面 `visibility_of_element_located` 使用类似 
WebDriverWait(driver,3).until(ECS.visibility_of(driver.find_element(By.ID,'su')))

6.presence_of_all_elements_located(locator)

判断是否至少有1个元素存在于dom树中。举个例子，如果页面上有n个元素的class都是'column-md-3'，那么只要有1个元素存 在，这个方法就返回True

7.visibility_of_any_elements_located(locator)

判断是否至少有1个元素存在于dom树中，并且可见。

# 元素等待直到通过 `CSS` 定位到至少有一个元素存在，则结束等待 
 WebDriverWait(driver,3).until(ECS.presence_of_all_elements_located((By.CSS_SELECTOR,'.s_ipt'))) 
# 这和上一个等待方法类似，主要就是需要元素可见才会结束等待 
 WebDriverWait(driver,3).until(ECS.visibility_of_any_elements_located((By.CSS_SELECTOR,'.s_ipt')))

8.invisibility_of_element_located(locator)

判断某个元素中是否不存在于dom树或不可见

# 元素等待直到元素被加载，可以定位到并且元素必须为不可见状态，才会结束等待 
 WebDriverWait(driver,3).until(ECS.invisibility_of_element_located((By.CSS_SELECTOR,'#nwWrap')))

4.3 通过等待的元素包含的内容来判断

9.text_to_be_present_in_element(locator, text_)

判断某个元素中的text是否 包含 了预期的字符串

10.text_to_be_present_in_element_value(locator, text_)

判断某个元素中的value属性是否 包含 了预期的字符串

# 元素等待直到定位到指定的元素，并且元素中存在某text文本 
 WebDriverWait(driver,3).until(ECS.text_to_be_present_in_element((By.XPATH,"//* [@id='bottom_layer']/div/p[1]/a"),'关于百度')) 
# 元素等待直到定位到指定的元素，并且元素的value属性值中包含指定的字符串  

WebDriverWait(driver,3).until(ECS.text_to_be_present_in_element_value((By.CSS_SELECTOR,'#su'),'百度一下'))

4.4 针对下拉框类型的等待，还有可点击的组件，如超链接

11.element_to_be_clickable(locator)

判断某个元素中是否可见并且是enable的，这样的话才叫clickable

12.element_to_be_selected(element)

判断某个元素是否被选中了,一般用在下拉列表

13.element_selection_state_to_be(element, is_selected)

判断某个元素的选中状态是否符合预期

14.element_located_selection_state_to_be(locator, is_selected)

跟上面的方法作用一样，只是上面的方法传入定位到的element，而这个方法传入locator

# 元素等待直到元素被加载，为可见状态，并且是可点击的状态，才会结束等待 
WebDriverWait(driver,3).until(ECS.element_to_be_clickable((By.LINK_TEXT,"登录"))) 
# 元素等待直到元素被加载，可见状态并且这个元素是被选中的状态 
# 这种方式运用于下拉选择框 
WebDriverWait(driver,3).until(ECS.element_to_be_selected(driver.find_element(By.XPATH,"//*[@id='dropdown']/option [@value='1']"))) 
# 元素等待直到元素被加载后，并且元素选中状态为预期的状态，才会结束等待 
 WebDriverWait(driver,3).until(ECS.element_selection_state_to_be(driver.find_element(By.XPATH,"//*[@id='s1Id']/opt ion[@value='o1']"),True)) 
# 元素等待直到元素被加载后，并且元素选中状态为预期的状态，才会结束等待 

WebDriverWait(driver,3).until(ECS.element_located_selection_state_to_be((By.XPATH,"//*[@id='sel']/option[1]"),Fal se))

4.5 其他特殊判断

15.alert_is_present()

判断页面上是否存在alert

16.staleness_of (element)

等某个元素从dom树中移除，注意，这个方法也是返回True或False

17.frame_to_be_available_and_switch_to_it(locator)

判断该frame是否可以switch进去，如果可以的话，返回True并且switch进去，否则返回False

# 元素等待直到页面加载出现 `alert`，出现自己切换过去并将提示内容返回 
WebDriverWait(driver,3).until(ECS.alert_is_present()) 
# 其他都是等待加载元素并操作，这种是等待元素被从Dom中移除时，才会触发结束等待 
WebDriverWait(driver,3).until(ECS.staleness_of(driver.find_element(By.ID,'su'))) 
# 这种是页面有多个Frame时，等待页面加载直到 `frame1` 可以切换进去，这时就会自动切换到 `frame1` ，然后结束等待 
WebDriverWait(driver,3).until(ECS.frame_to_be_available_and_switch_to_it(frame1)) 

除了上面这些，官方还有很多其他的方式，这里就不再一一列举了，大家有兴趣可以自己去研究一下

四、流畅等待

流畅等待实例定义了等待条件的最大时间量，以及检查条件的频率。用户可以配置等待来忽略等待时出现的特定类型的异常，例如在 页面上搜索元素时出现的NoSuchElementException。

driver = webdriver.Chrome() 
driver.get("http://somedomain/url_that_delays_loading") 
wait = WebDriverWait(driver, timeout=10, poll_frequency=1, ignored_exceptions= 
 [ElementNotVisibleException, Elemen tNotSelectableException]) 
element = wait.until(EC.element_to_be_clickable((By.XPATH, "//div")))