提取Playwright录制文件中的元素定位信息

引言

最近组内推行Playwright进行自动化测试，由我封装了一个简单的框架供大家使用。本意是想让大家使用Page Object模式来编写自动化代码的，可是不知道是因为大家嫌麻烦，还是Playwright自带的录制工具太好用，基本上都是先录制，再把录制好的脚本放到框架中执行，结果就是Page Object的优势完全没有享受到，另外我在页面操作中加入了自动等待、重试等优化机制也是，还得在脚本里面一个个处理。由此，我分析大家不愿意用Page Object的一个原因是自己编写元素定位比较麻烦，而录制下来的脚本里面已经包含了定位信息，那么我是不是可以将录制脚本中的定位信息解析出来，在转换成我框架里的页面基类，就可以直接使用了。

方法研究

首先我想到使用读取python文件配合正则表达式的方式进行解析，但是仔细一想，如果一个表达式有多行的话就很难处理了，还需要分析语法进行拼接。后来查询到可以使用python自带的ast库将python文件转化为抽象语法树进行解析，一下子就豁然开朗了。

提取代码

我这里主要用到了ast的 parse walk dump 三个方法， parse 方法将脚本转化为抽象语法树， walk 用来遍历整个抽象语法树（类似xml遍历）， dump 用于调试和将无法解析的内容直接输出，其实这里可以使用 unparse 或通过 lineno col_offset end_lineno end_col_offset 这四个属性定位到源码，但是这些都需要较高的python版本才有，我现在项目中使用的python 3.7版本中还没有这些，只能先用 dump 代替（当然，也是我比较偷懒）。代码如下：

import ast
from inspect import signature

from playwright.sync_api import Page

import_num = 0
dup_num = 0
result = []
with open('<playwright录制脚本>', 'rb') as f:
    root = ast.parse(f.read())
parse_methods = set()
for i in dir(Page):
    if not i.startswith('_'):
        attr = getattr(Page, i)
        if callable(attr):
            sign = signature(attr).parameters
            if 'selector' in sign:
                parse_methods.add(i)
for node in ast.walk(root):
    if isinstance(node, ast.Call):
        if isinstance(node.func, ast.Attribute) and \
                node.func.attr in parse_methods:
            if len(node.args) == 0:
                continue
            selector = node.args[0]
            if isinstance(selector, ast.Str):
                selector = selector.s
            elif isinstance(selector, ast.Name):
                selector = f'变量: {selector.id}'
            else:
                selector = f'无法解析: {ast.dump(selector, False)}'
            frame_locator = None
            if isinstance(node.func.value, ast.Call) and \
                    isinstance(node.func.value.func, ast.Attribute) and \
                    node.func.value.func.attr == 'frame':
                if len(node.func.value.args) > 0:
                    frame_locator = str(node.func.value.args[0])
                else:
                    frame_node = node.func.value.keywords[0].value
                    if isinstance(frame_node, ast.Str):
                        frame_locator = frame_node.s
                    elif isinstance(frame_node, ast.Name):
                        frame_locator = f'变量: {frame_node.id}'
                    else:
                        frame_locator = f'无法解析: {ast.dump(frame_node, False)}'
            for i in result:
                if selector == i[0] and frame_locator == i[1]:
                    dup_num += 1
                    break
            else:
								result.append((selector, frame_locator))
                print(f"{selector}, {frame_locator} {node.func.attr == 'query_selector_all'}")
                import_num += 1
print(f'成功解析{import_num}条定位信息, 跳过{dup_num}条重复信息')

代码解析

代码中很多地方用到了 isinstance 方法来判断节点是什么类型，因为需要解析的内容都是 page.click('...')或 page.frame('...').click('...')形式，所以大多数时候需要提取 Call对象的 func的 attr属性即为所需要的定位信息。另外使用了 inspect 库来提取可能需要解析的方法，如 click fill等，直接从Playwright中提取，就不需要一个一个去找了。再加上一些重复判断，即为上述代码。

希望有了将录制脚本转换Page Object的方法之后，可以将Page Object的模式在组内推广起来吧。