詳解Async 與 Await,帶您理解Playwright使用異步方法的正確姿勢!
大家在使用python做playwright自動化測試的過程中,一定會發現下面這種異步用法
async def func():
await api
await api
很多同學可能只是按照這種寫法來編寫項目的自動化測試代碼,對于具體細節可能并不了解,今天我就來講一下playwright異步用法的相關技術細節。建議大家拷貝文檔中的腳本實際運行一下,學習的效果會更好!
同步和異步的概念
同步:發送一個請求,等待返回,然后再發送下一個請求異步:發送一個請求,不等待返回,隨時可以再發送下一個請求
async 與 await
python在3.5以后引入async和await來強化自身的異步編程,提升效率。async 是異步的簡寫,而 await 可以認為是 async wait 的簡寫。async 用于申明一個 function 是異步的,而 await 用于等待一個異步方法執行完成。異步函數的特點是能在函數執行過程中掛起,去執行其他異步函數,等到掛起條件結束后再回來繼續執行。await的作用是掛起函數,等待函數操作完成,這時候回去執行其他的異步函數,而不是傻等,等掛起的執行完成以后將會從其他異步函數處返回,執行掛起結束的函數。await只可以對異步函數使用,普通函數使用會報錯。await的本質是通過yield from 實現的,關于yield生成器相關知識點這里就不詳細介紹了。
例如:兩個異步程序async a、async b:
a中一步有await,當程序碰到關鍵字await后,異步程序a掛起,去執行異步b程序(就相當于從一個函數內部跳出去執行其他函數);當掛起條件結束時候,不管b是否執行完,要馬上從b程序中跳出來,回到原程序a執行原來的操作;如果await后面跟的b函數不是異步函數,那么操作就只能等b執行完再返回,無法在b執行的過程中返回,這樣就相當于直接調用b函數,沒必要使用await關鍵字了。因此,需要await后面跟的是異步函數。
舉個例子
import time
import asyncio
async def wait1():
print('wait1 start')
await asyncio.sleep(1)
print('wait1 end')
async def wait3():
print('wait3 start')
await asyncio.sleep(3)
print('wait3 end')
async def wait5():
print('wait5 start')
await asyncio.sleep(5)
print('wait5 end')
# 2. 將異步函數加入事件隊列
tasks = [
wait1(),
wait3(),
wait5(),
]
if __name__ == '__main__':
# 創建一個事件循環
loop = asyncio.get_event_loop()
startTime = time.time()
# 執行隊列實踐,直到最晚的一個事件被處理完畢后結束
loop.run_until_complete(asyncio.wait(tasks))
# 如果不在使用loop,建議使用關閉,類似操作文件的close()函數
loop.close()
endTime = time.time()
print("sum time: ",endTime-startTime)
運行結果
wait5 start
wait3 start
wait1 start
wait1 end
wait3 end
wait5 end
sum time: 5.000609874725342
上面這段代碼大家可以多執行幾次,我們會發現:不管wait1 wait3,wait5 哪個函數先執行,但是最后end的順序一定是 wait1>wait3>wait5。一共運行的時間 在5s左右,充分地證明了三個函數是并行執行的!
接下來,我們可以對代碼進行如下修改:
async def wait3():
print('wait3 start')
time.sleep(3)
print('wait3 end')
然后再次運行代碼,結果如下:
wait5 start
wait3 start
wait3 end
wait1 start
wait1 end
wait5 end
sum time: 5.002418518066406
大家會發現,只有wait3 end 發生后,才會出現wait1 end 和wait5 end(),很好的證明了上面的話:如果await后面跟的b函數不是異步函數,那么操作就只能等b執行完再返回,無法在b執行的過程中返回,這樣就相當于直接調用b函數,沒必要使用await關鍵字了。我們可以任意調整task的執行順序,例如:
tasks = [
wait1(),
wait5(),
wait3(),
]
執行最慢的情況就是,wait3 第一個start,等待wait3 end后,才能執行wait1 或者wait5
wait3 start
wait3 end
wait5 start
wait1 start
wait1 end
wait5 end
sum time: 8.000799894332886
一個易犯的錯誤
當我們在同步方法中加入await,執行代碼的時候會報錯,也就是說像下面這樣編寫playwright腳步是不對的,因為sync_playwright() 是同步方法!
from playwright.sync_api import sync_playwright
with sync_playwright() as p:
browser = p.chromium.launch(channel="chrome")
page = browser.new_page()
await page.goto("http://www.baidu.com")
print(page.title())
browser.close()
Playwright使用異步方法的正確姿勢
如下代碼會正常運行,通過await可以保證腳本的運行順序
async def playwright_async_demo():
async with async_playwright() as p:
browser = await p.chromium.launch(channel="chrome")
page = await browser.new_page()
await page.goto("http://www.baidu.com")
asyncio.run(playwright_async_demo())
如果我們把上面代碼中 browser = await p.chromium.launch(channel="chrome")的await關鍵字去掉就會報錯
page = await browser.new_page()
AttributeError: 'coroutine' object has no attribute 'new_page'
sys:1: RuntimeWarning: coroutine 'BrowserType.launch' was never awaited
原因就是代碼行 browser = p.chromium.launch(channel="chrome")還沒執行完就執行了下一行 page = await browser.new_page()
最后的總結,如果大家需要并行執行用例,那么需要考慮async (這里建議基于場景設計),如果沒有這個需求,這部分只是點做為了解即可。