Python PageFactory-使用配置文件动态生成页面PageObject

需求

在Python Selenium 的 PageObject模式中,一般每个页面需要写一个类, 一种PageObject的写法如下:

class BaiduPageObject(object):
    def __init__(self, driver):   # 一般通过继成BasePage类实现该方法
        self.driver = driver

    # 页面元素 -----
    search_ipt_loc = ('id', 'kw')
    search_btn_loc = ('id', 'su')

    # 页面操作 -----
    def input_search_ipt(self, keyword):
        search_ipt = self.driver.find_element(*search_ipt_loc)
        search_ipt.clear()
        search_ipt.send_keys(keyword):

    def click_search_btn(self):
        self.driver.find_element(*search_btn_loc).click()

    def search(self, keyword):
        self.input_search_ipt(keyword)
        self.click_search_btn()

对于一个成型的UI项目来说, 在编写用例前, 动辄要先编写数十上百个这种PageObject类. 鉴于每个PageObject类的格式相似, 可以采用
Page Factory(页面工厂)+配置文件(yaml) -> PageObject
的方式来动态生成每一个页面对象

PageFactory本是Selenium Java SDK中的一种基于PageObject的设计模式, 使用@FindBy(id = "kw")语法糖来标记页面元素, 并支持使用@CacheLookup来缓存页面元素(这样元素只需要查找一次)
完整介绍: https://github.com/SeleniumHQ/selenium/wiki/PageFactory

鉴于 Python的动态特性, 这里的Page Factory的实现方式与Selenium Java SDK中的完全不同

设计与实现

首先设计及约定页面配置文件的格式如下:

# filename: baidu.yaml
url: https://www.baidu.com  # 可选字段, 用于打开网页
title: 百度一下，你就知道   # 可选字段, 用于判断是否在当前网页
elements:   # 页面元素
  search_ipt: [id, kw]  # 支持id, name, class name, tag name, link text
  search_btn: [id, su]  # partial link text, xpath, css selector

actions:  # 可选字段, 页面操作
  search:
    input: [search_ipt, 默认值]  # input: 固定字段, 第一参数为上面的元素, 第二个为输入的文本 
    click: search_btn  # click: 固定字段, 参数为上面配置的元素

page_factory.py

# page_factory.py
from types import MethodType  # 用于为实例动态绑定方法
from collections import OrderedDict  # 有序字典, 用于按顺序遍历actions中的操作步骤
import yaml
from selenium import webdriver


class Page(object):
    def __init__(self, driver, from_yaml=None, **kwargs):
        self.driver = driver
        self.url = kwargs.get('url', None)
        self.title = kwargs.get('title', None)
        self.elements = kwargs.get('elements', {})
        self.actions = kwargs.get('url', OrderedDict())
        if from_yaml is not None:
            self.init_page(from_yaml)

    def init_page(self, from_yaml):
        with open(from_yaml, encoding='utf-8') as f:
            data = yaml.load(f)
            self.url = data.get('url', None)
            self.title = data.get('title', None)
            self.elements = data.get('elements', {})
            self.actions = OrderedDict(data.get('actions', {}))

    def open(self):  # 打开页面url
        if self.url is not None:
            self.driver.get(self.url)

    def on_page(self):  # 通过title判断是否在当前页面上
        if self.title is not None:
            return self.title in self.driver.title

    def input(self, element, text):  # 输入操作, 指定配置中的元素名及文本
        element = self.__getattr__(element)  #
        element.clear()
        element.send_keys(text)

    def click(self, element):  # 点击操作, 指定元素名
        element = self.__getattr__(element)
        element.click()

    def _handle_element(self, item):  # 处理要查找的页面元素
        element_loc = self.elements.get(item, None)
        if element_loc is not None:
            element = self.driver.find_element(*element_loc)  # todo try
            setattr(Page, item, element)  # 缓存元素作为页面属性
            return element

    def _handle_action(self, item):   # 处理要查找的操作方法
        action = self.actions.get(item, None)
        if action is not None:

            def pack_action(self, text=None):  # 解析约定的action格式, 组装操作方法
                for step, params in action.items():
                    if step == 'input':
                        if text is not None and isinstance(params, list) and len(params)>1:
                            params[1] = text  # 使用调用时的text参数替换input: [search_ipt, $keyword]的第2个参数
                        self.input(*params)
                    elif step == 'click':
                        self.click(params)

            return MethodType(pack_action, self)  # 为实例绑定操作方法并返回

    def __getattr__(self, item):   # 查找页面属性和操作方法
        if not hasattr(Page, item):  # 如无该属性/方法则动态为页面添加元素属性和操作方法
            return self._handle_element(item) or self._handle_action(item)


if __name__ == '__main__':   # 使用方法
    driver = webdriver.Chrome()
    baidu = Page(driver, 'baidu.yaml')  
    baidu.open()
    baidu.search('临渊')

TODO

• 异常捕获
• 单url框架页面的加载, 每个action的返回页面, 页面之间的流转
• 缓存页面对象, 比如不同用例中多次调用baidu = PageFactory(driver, ...), 使用同一个退休
• 增加更多的action支持, 如select, hover, switch等等
• 独立模板解析parser方法, 支持更多的变量, 如$1, $2/$keyword, $func(a)等
• 为Page增加hooks方法让使用更灵活

PS:
使用该Page Factory(页面工厂)方法暂时还没有减轻, 数十上百的页面编写工作, 只是从原来的编写Python类改为编写yaml配置文件, 然而,静态的配置文件相对与Python类来说, 有以下好处:

1. 实现了数据(页面元素定位器)与代码的分离
2. PageFactory支持传入字典格式的配置参数来生成页面, 数据可以来源于yaml文件,也可以来源于页面表单/数据库,甚至爬虫爬取, 便于集成前端web页面, 或爬虫自动生成Pages