尝试使用Playwright自带的机制解决
以上三个问题都可以使用 page.wait_for_timeout(<timeout>) 加入固定的等待时间进行处理,但是需要在所有上述情景中加入等待,而且由于是固定等待时间,时间的长短也不好控制,过短的话没有效果,过长的话又会导致自动化测试执行时间的延长,而且页面加载时间可能是随机的、依赖环境的,无法准确预知。所以一般来说,不建议使用固定等待时间来处理。
创建浏览器对象时加入 slow_mo 参数,这样会使Playwright的每一步操作前都等待固定的时间,优点是不需要在每一步操作前进行添加,一次配置,全局可用,缺点和上面一样,本质同样是固定等待时间,而且涉及每一步操作,会更加拖慢执行速度
Playwright提供了 page.wait_for_load_state() 方法,支持3种参数 load domcontentloaded 和 networkidle ,可以等待页面加载至预期状态。但是经我测试发现这种方法并不是很好用,可以解决部分问题,但是还是有很大概率等待时间不足(即使我把三种参数都用上了)。
为了更优雅的解决这个问题,我就在Playwright的基础上进行了扩展
扩展Playwright
基本思路
必须抛弃掉固定等待时间的方法,即使用到固定等待时间,也需要在一个循环中判断达到某个条件(如元素出现)就退出循环。注意到Playwright提供了 page.on 注册回调函数的方法,那么就可以在回调函数中记录时间发生的时间,等待至一定时间内没有事件发生即为页面加载完毕(类似于networkidle )。
实现方法
# client.py
import time
from abc import ABC, abstractmethod
from playwright.sync_api import sync_playwright, Frame, Page
class Client(ABC):
playwright = None
browser = None
def __init__(self, url: str):
self.url = url
self.context = None
self.main_page = None
self.last_busy_time = time.time()
@abstractmethod
def register_page(self):
pass
def _update_busy_time(self, event=None) -> None:
if isinstance(event, Page) or isinstance(event, Frame):
self._register_busy_time(event)
self.last_busy_time = time.time()
def _register_busy_time(self, obj) -> None:
obj.on('domcontentloaded', self._update_busy_time)
obj.on('download', self._update_busy_time)
obj.on('filechooser', self._update_busy_time)
obj.on('frameattached', self._update_busy_time)
obj.on('framedetached', self._update_busy_time)
obj.on('framenavigated', self._update_busy_time)
obj.on('load', self._update_busy_time)
obj.on('pageerror', self._update_busy_time)
obj.on('popup', self._update_busy_time)
obj.on('request', self._update_busy_time)
obj.on('requestfailed', self._update_busy_time)
obj.on('requestfinished', self._update_busy_time)
obj.on('response', self._update_busy_time)
def start(self) -> None:
Client.playwright = sync_playwright().start()
Client.browser = Client.playwright.chromium.launch()
self.context = Client.browser.new_context()
self.main_page = self.context.new_page()
self._register_busy_time(self.main_page)
self.main_page.goto(self.url)
self.register_page()
# page.py
import time
class BasePage(object):
def __init__(self, client, page=None):
self.client = client
if not page:
self.page = client.main_page
else:
self.page = page
def wait_until_idle(self, timeout=1) -> None:
while time.time() - self.client.last_busy_time < timeout:
self.page.wait_for_timeout(100)
代码解析
在 Client 类中定义 last_busy_time 属性,用于记录最后一次页面事件发生的时间。
Client 类中的 _update_busy_time 方法,用于在 page.on 中注册回调方法,更新last_busy_time ,并当事件为打开新页面或frame时,在新页面或frame中对事件注册 page.on 回调(这里比较简单,只判断了事件类型,实际应用时可以根据需要定制)。
Client 类中的 _register_busy_time 方法,用于为页面事件注册回调函数(这里只是列举可能用到的事件类型,实际应根据项目特点进行定制)。
在 start 方法中创建第一个页面后,调用_register_busy_time 方法,即可将后续所有打开的页面和frame都对页面事件进行注册,只要发生对应的页面事件就会更新last_busy_time 属性为当前时间。
在 BasePage 类中定义了 wait_until_idle 方法,用于判断当页面空闲时间大于 timeout 时即停止等待,认为当前页面加载完毕,并且并且页面已经空闲的时候会即刻返回,不会增加测试执行时间。
总结
如上代码提供了一个自动等待页面空闲的方法,可以在任意需要等待的地方使用,使用效果优于等待固定时间。如果配合自己封装的 Element ,则可以在每一个操作前面加入此等待,这样就可以摆脱手动添加等待的烦恼;如果再配合重试机制,那么执行测试的稳定性将会更上一层楼。