Python Playwright 基本使用（步骤详细）

Posted 2023-03-29 卡尔特斯

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Python Playwright 基本使用（步骤详细）相关的知识，希望对你有一定的参考价值。

一、简介

Playwright 官方安装文档、Python 编程技术-安装文档。
Playwright 是由 微软公司 2020年初 发布的新一代自动化测试工具，相较于目前最常用的 Selenium，它仅用一个 API 即可自动执行 Chromium、Firefox、WebKit 等主流浏览器自动化操作。作为针对 Python 语言纯自动化的工具，在回归测试中可更快的实现自动化。
Playwright 需要 Python >=3.7 版本。推荐：Python 使用 pyenv 多版本管理。
Playwright 最详细使用教程，这篇文章使用细节介绍的非常好。
不同系统解释器安装 playwright。

二、为什么选择 `Playwright`？

Playwright 的优势

1、Selenium 需要通过 WebDriver 操作浏览器；Playwright 通过开发者工具与浏览器交互，安装简洁，不需要安装各种 Driver。

2、Playwright 几乎支持所有语言，且不依赖于各种 Driver，通过调用内置浏览器所以启动速度更快。

3、Selenium 基于 HTTP 协议（单向通讯），Playwright 基于 Websocket（双向通讯）可自动获取浏览器实际情况。

4、Playwright 为自动等待，而在 Selenium 中经常需要写 sleep 去作为一个等待，保证程序正常运行。
- 等待元素出现（定位元素时，自动等待30s，等待时间可以自定义，单位毫秒）
- 等待事件发生
已知局限性

1、Playwright 不支持旧版 Microsoft Edge 或 IE11。支持新的 Microsoft Edge（在 Chromium 上），所以对浏览器版本有硬性要求的项目不适用。

2、需要 SSL 证书进行访问的网站可能无法录制，该过程需要单独定位编写。

三、安装

1）安装（Playwright 支持 Async\\Await 语法，故需要 Python3.7+）
```
$ pip install playwright
```

2）安装 Chromium、Firefox、WebKit等浏览器的驱动文件（内置浏览器）和 ffmpeg 用于视频录制

注意，下面这种安装方式安装，会安装所有驱动文件，如果需要打包成 exe/app 文件还会报错 Please run the following command to download new browsers，所以可以按需安装就行。

# 全装
$ python -m playwright install

# 按需安装，重新安装一下（chromium 是其中一个浏览器插件，看自己用什么就装什么） # Expecting one of: chromium, chrome, chrome-beta, msedge, msedge-beta, msedge-dev, firefox, webkit 
# PLAYWRIGHT_BROWSERS_PATH=0 是为了支持 pyinstaller 打包报错 Please run the following command to download new browsers 问题
$ PLAYWRIGHT_BROWSERS_PATH=0 playwright install chromium

四、案例

案例一（同步案例）

# 导入
from playwright.sync_api import Playwright, sync_playwright
# 导入 定时器
# from time import sleep

# 创建浏览器
def run (playwright: Playwright) -> None:

  # 创建浏览器
  browser = playwright.chromium.launch(headless=False)

  # 使用 selenium 如果要打开多个网页，需要创建多个浏览器，但是 playwright 中只需要创建多个上下文即可
  # 例如：content1 = browser.new_context()、content2 = browser.new_context() 分别去访问网页做处理
  content = browser.new_context()

  # 每个 content 就是一个会话窗口，可以创建自己的页面，也就是浏览器上的 tab 栏，在每个会话窗口中，可以创建多个页面，也就是多个 tab 栏
  # 例如：page1 = content.new_page()、page2 = content.new_page() 封面去访问页面
  page = content.new_page()

  # 页面打开指定网址
  page.goto('https://www.baidu.com')

  # 找到百度输入框（ locator 会自动识别传入的选择器是 css xpath .... 不需要像 selenium 指定 By.XPATH/ID 这样的 ）
  # page.locator('//input[@id="kw"]').fill('周杰伦') # 也可以写成下面这样：
  page.fill('//input[@id="kw"]', '周杰伦')

  # 点击百度一下进行搜索
  # page.locator('//input[@id="su"]').click() # 也可以写成下面这样：
  page.click('//input[@id="su"]')

  # 延迟关闭（为啥需要延迟一下，这里是用于测试，因为代码执行完马上就回关闭，运行太快了，还以为崩溃了
  # 暂时没找到配置不需要进行自动关闭，但是肯定跟 selenium 一样有这个配置）
  # sleep(10) # 之前使用使用 sleep 的方式进行等待，传入的是单位是秒
  # 但是在 playwright 中有自带的延迟等待，单位是毫秒
  page.wait_for_timeout(10000)

  # 使用完成关闭上下文（也就是会话窗口）
  content.close()

  # 关闭浏览器
  browser.close()

# 调用
with sync_playwright() as playwright:
  run(playwright)

案例二 (有 hover)

# 导入
from playwright.sync_api import Playwright, sync_playwright

# 创建浏览器
def run (playwright: Playwright) -> None:

  # 创建浏览器
  browser = playwright.chromium.launch(headless=False)

  # 新建窗口
  content = browser.new_context()

  # 新建页面
  page = content.new_page()

  # 访问首页
  page.goto('https://hepai.video/')

  # 点击登录
  page.click('//a[@href="/login"]')

  # 延迟
  page.wait_for_timeout(1000)

  # 密码登录
  page.click('//a[contains(text(), "密码登录")]')

  # 写入账号
  page.fill('//input[@id="username"]', 'xxxx')

  # 写入密码
  page.fill('//input[@id="password"]', 'dzm123456')

  # 点击登录
  page.click('//button[@type="submit"]')

  # 延迟
  page.wait_for_timeout(1000)

  # hover 出菜单（失败）
  # page.hover('//div[@class="nav-adv nav-adv-home u-info"]/p')
  # page.wait_for_selector('//div[@class="nav-adv nav-adv-home u-info"]/ul', state='visible', timeout=30000)
  # page.locator('//div[@class="nav-adv nav-adv-home u-info"]/ul')
  # 延迟
  # page.wait_for_timeout(1000)
  # 点击财务管理
  # page.click('//a[@href="/pipeline-record"]')

  # 上面 hover 失败，那就直接手动加载网页
  page.goto('https://hepai.video/pipeline-record')

  # 延迟
  page.wait_for_timeout(1000)

  # hover 出菜单
  page.hover('//div[@class="u-info"]/img')

  # 退出登录
  page.click('//a[contains(text(), "退出登录")]')

  # 点击确定按钮
  page.click('//button/span[contains(text(), "确")]/..')

  # 延迟
  page.wait_for_timeout(10000)

  # 关闭上下文
  content.close()

  # 关闭浏览器
  browser.close()

# 调用
with sync_playwright() as playwright:
  run(playwright)

python+playwright 学习-10.pytest-playwright插件编写测试用例

前言

pytest-playwright插件完美的继承了pytest 用例框架和playwright基础使用的封装，基本能满足工作中的常规需求了，不需要我们再做额外的插件开发。

pytest-playwright 环境准备

Playwright 建议使用官方的 pytest-playwright 插件来编写端到端测试。它提供上下文隔离，开箱即用地在多个浏览器配置上运行。或者，您可以使用该库使用您喜欢的测试运行程序手动编写测试基础设施。Pytest 插件使用 Playwright 的同步版本，还有一个可通过库访问的异步版本。

开始安装 Playwright 并运行示例测试以查看它的实际效果。

pip install pytest-playwright

安装所需的浏览器：

playwright install

仅需这一步即可安装所需的浏览器，并且不需要安装驱动包了,解决了selenium启动浏览器，总是要找对应驱动包的痛点。

快速开始

test_my_application.py 使用以下代码在当前工作目录或子目录中创建一个文件：

import re
from playwright.sync_api import Page, expect
# 上海悠悠 wx:283340479  
# blog:https://www.cnblogs.com/yoyoketang/

def test_homepage(page: Page):
    page.goto("https://playwright.dev/")

    # Expect a title "to contain" a substring.
    expect(page).to_have_title(re.compile("Playwright"))

    # create a locator
    get_started = page.get_by_role("link", name="Get started")

    # Expect an attribute "to be strictly equal" to the value.
    expect(get_started).to_have_attribute("href", "/docs/intro")

    # Click the get started link.
    get_started.click()

    # Expects the URL to contain intro.
    expect(page).to_have_url(re.compile(".*intro"))

默认情况下，测试将在 chromium 上运行。这可以通过 CLI 选项进行配置。
测试以无头模式运行，这意味着在运行测试时不会打开浏览器 UI。测试结果和测试日志将显示在终端中。

>pytest test_my_application.py
=========== test session starts ==============
platform win32 -- Python 3.8.5, pytest-7.2.1, pluggy-1.0.0
rootdir: D:\\demo\\play_web\\cases
plugins: base-url-2.0.0, playwright-0.3.0
collected 1 item                                                                                                         

test_my_application.py .         [100%]

============ 1 passed in 2.40s ===

如果想看到打开的浏览器运行，可以加上--headed 参数

>pytest test_my_application.py --headed

编写用例

Playwright 提供了expect 将等待直到满足预期条件的功能。

import re
from playwright.sync_api import expect

expect(page).to_have_title(re.compile("Playwright"))

定位器是 Playwright 自动等待和重试能力的核心部分。定位器代表了一种随时在页面上查找元素的方法，并用于对诸如.click .filletc之类的元素执行操作。

from playwright.sync_api import expect

get_started = page.get_by_role("link", name="Get started")

expect(get_started).to_have_attribute("href", "/docs/installation")
get_started.click()

Playwright Pytest 插件基于测试装置的概念，例如传递到您的测试中的内置页面装置。
由于浏览器上下文，页面在测试之间被隔离，这相当于一个全新的浏览器配置文件，每个测试都会获得一个全新的环境，即使在单个浏览器中运行多个测试也是如此。

from playwright.sync_api import Page

def test_basic_test(page: Page):
  # ...

您可以使用各种 fixture 在测试之前或之后执行代码，并在它们之间共享对象。
例如，具有自动使用 function 作用域的 fixture 类似于 beforeEach/afterEach。
具有module自动使用功能的作用域fixture的行为类似于 beforeAll/afterAll，它在所有测试之前和之后运行。

import pytest
from playwright.sync_api import Page


@pytest.fixture(scope="function", autouse=True)
def before_each_after_each(page: Page):
    print("beforeEach")
    # Go to the starting url before each test.
    page.goto("https://playwright.dev/")
    yield
    print("afterEach")

def test_main_navigation(page: Page):
    # Assertions use the expect API.
    expect(page).to_have_url("https://playwright.dev/")

运行测试用例

您可以运行单个测试、一组测试或所有测试。测试可以在一个浏览器或多个浏览器上运行。
默认情况下，测试以无头方式运行，这意味着在运行测试时不会打开浏览器窗口，并且会在终端中看到结果。如果您愿意，可以使用–headed标志以引导模式运行测试。

默认在 Chromium 上运行测试

pytest

运行单个测试文件

pytest test_login.py

运行一组测试文件

pytest tests/todo-page/ tests/landing-page/

使用函数名运行测试

pytest -k "test_add_a_todo_item"

在引导模式下运行测试

pytest --headed test_login.py

在特定浏览器上运行测试

pytest test_login.py --browser webkit

在多个浏览器上运行测试

pytest test_login.py --browser webkit --browser firefox

如果您的测试在具有大量 CPU 的机器上运行，您可以通过使用pytest-xdist一次运行多个测试来加快测试套件的整体执行时间：

# install dependency
pip install pytest-xdist
# use the --numprocesses flag
pytest --numprocesses auto

根据测试的硬件和性质，您可以设置numprocesses为从2机器上的 CPU 数量到 CPU 数量之间的任何值。如果设置得太高，您可能会注意到意外行为。

Pytest 插件参考

Playwright 提供了一个Pytest插件来编写端到端测试。要运行测试，请使用Pytest CLI。

pytest --browser webkit --headed

如果你想自动添加 CLI 参数而不指定它们，你可以使用pytest.ini文件：

CLI 相关参数
--headed：以有头模式运行测试（默认：无头）。
--browserchromium：在不同的浏览器、firefox或中运行测试webkit。它可以指定多次（默认值：）chromium。
--browser-channel 要使用的浏览器通道。
--slowmo使用慢动作运行测试。
--device 要模拟的设备。
--output测试生成的工件目录（默认值：）test-results。
--tracing是否为每个测试记录轨迹。on、off或retain-on-failure（默认值：off）。
--video是否为每次测试录制视频。on、off或retain-on-failure（默认值：off）。
--screenshot是否在每次测试后自动捕获屏幕截图。on、off或only-on-failure（默认值：off）。

内置fixture

Function scope:：
这些固定装置在测试功能中请求时创建，并在测试结束时销毁。

context:用于测试的新浏览器上下文。
page:用于测试的新浏览器页面。

Session scope:
这些固定装置在测试函数中请求时创建，并在所有测试结束时销毁。

playwright:playwright实例。
browser_type:当前浏览器的BrowserType实例。
browser：由 Playwright 启动的浏览器实例。
browser_name: 浏览器名称作为字符串。
browser_channel: 浏览器通道作为字符串。
is_chromium, is_webkit, is_firefox: 相应浏览器类型的布尔值。

自定义fixture选项
对于browser和context ，使用以下fixture来定义自定义启动选项。

browser_type_launch_args：覆盖browser_type.launch()的启动参数。它应该返回一个字典。
browser_context_args：覆盖browser.new_context()的选项。它应该返回一个字典。

编写用例示例

写个简单的用例

# test_my_application.py
from playwright.sync_api import Page

def test_visit_admin_dashboard(page: Page):
    page.goto("/admin")
    # ...

使用带有–slowmo参数的 slow mo 运行测试。

pytest --slowmo 100

skip 某个浏览器

# test_my_application.py
import pytest

@pytest.mark.skip_browser("firefox")
def test_visit_example(page):
    page.goto("https://example.com")
    # ...

在指定浏览器上运行

# conftest.py
import pytest

@pytest.mark.only_browser("chromium")
def test_visit_example(page):
    page.goto("https://example.com")
    # ...

指定浏览器

pytest --browser-channel chrome

# test_my_application.py
def test_example(page):
    page.goto("https://example.com")

配置base-url

使用base-url参数启动 Pytest。该pytest-base-url插件用于允许您从配设置基本 url。

# test_my_application.py
def test_visit_example(page):
    page.goto("/admin")
    # -> Will result in http://localhost:8080/admin

运行

pytest --base-url http://localhost:8080

其它

忽略https 错误

# conftest.py
import pytest

@pytest.fixture(scope="session")
def browser_context_args(browser_context_args):
    return 
        **browser_context_args,
        "ignore_https_errors": True

自定义浏览器窗口大小

# conftest.py
import pytest

@pytest.fixture(scope="session")
def browser_context_args(browser_context_args):
    return 
        **browser_context_args,
        "viewport": 
            "width": 1920,
            "height": 1080,

设置手机设备

# conftest.py
import pytest

@pytest.fixture(scope="session")
def browser_context_args(browser_context_args, playwright):
    iphone_11 = playwright.devices['iPhone 11 Pro']
    return 
        **browser_context_args,
        **iphone_11,

或者通过 CLI指定参数--device="iPhone 11 Pro"

持久的 context

# conftest.py
import pytest
from playwright.sync_api import BrowserType
from typing import Dict

@pytest.fixture(scope="session")
def context(
    browser_type: BrowserType,
    browser_type_launch_args: Dict,
    browser_context_args: Dict
):
    context = browser_type.launch_persistent_context("./foobar", **
        **browser_type_launch_args,
        **browser_context_args,
        "locale": "de-DE",
    )
    yield context
    context.close()

使用它时，测试中的所有页面都是从持久上下文创建的

以上是关于Python Playwright 基本使用（步骤详细）的主要内容，如果未能解决你的问题，请参考以下文章

使用 Playwright for Python，如何从下拉列表中选择一个选项？

微软开源最强Python自动化神器Playwright！不用写一行代码！

Python 自动化爬虫利器 Playwright

Playwright入门

如何使用 playwright-python 处理多个页面？