软件测试开发实战|记录写装饰器时踩的几个坑

本文转载自霍格沃兹测试学院优秀学员indeyo 小玲儿的学习笔记，原文连接：
http://qrcode.testing-studio.com/f?from=51cto&url=https://ceshiren.com/tag/%E7%B2%BE%E5%8D%8E%E5%B8%96 转载请注明出处
python

背景

装饰器是python里面一个颇有用的语法糖（ Syntactic Sugar），能够减小大量重复代码的编写。
恰好最近学习了app自动化框架的异常处理，存在必定重复代码，准备看成题材，拿来练习一下装饰器。
下面记录一下装饰器的踩坑之路。

app

坑 1：Hint: make sure your test modules/packages have valid Python names.

报错信息

test_market.py:None (test_market.py)
ImportError while importing test module 'D:\project\Hogwarts_11\test_appium\testcase\test_market.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
test_market.py:9: in <module>
    from test_appium.page.app import App
..\page\app.py:12: in <module>
    from test_appium.page.base_page import BasePage
..\page\base_page.py:16: in <module>
    from test_appium.utils.exception import exception_handle
..\utils\exception.py:11: in <module>
    from test_appium.page.base_page import BasePage
E   ImportError: cannot import name 'BasePage' from 'test_appium.page.base_page' (D:\project\Hogwarts_11\test_appium\page\base_page.py)

缘由

exception.py 文件和 base_page.py 文件之间存在相互调用关系。框架

解决方案

把循环调用的包引入信息放在函数内。只要一方的引用信息放在函数里便可，没必要两边都放。
我只在 exception.py 文件里改了，base_page.py 保持不变。
ide

exception.py

def exception_handle(func):
    def magic(*args, **kwargs):
        # 防止循环调用报错
        from test_appium.page.base_page import BasePage
        # 获取BasePage实例对象的参数self，这样能够复用driver
        _self: BasePage = args[0]
...

坑 2：IndexError: tuple index out of range

报错信息

test_search.py:None (test_search.py)
test_search.py:11: in <module>
    from test_appium.page.app import App
..\page\app.py:12: in <module>
    from test_appium.page.base_page import BasePage
..\page\base_page.py:52: in <module>
    class BasePage:
..\page\base_page.py:74: in BasePage
    def find(self, locator, key=None):
..\page\base_page.py:50: in exception_handle
    return magic()
..\page\base_page.py:24: in magic
    _self: BasePage = args[0]
E   IndexError: tuple index out of range

缘由

第一次写装饰器真的很容易犯这个错，来看下哪里写错了函数

def decorator(func):
    def magic(*args, **kwargs):
        _self: BasePage = args[0]
        ...
        return magic(*args, **kwargs)
    # 这里的问题！！！不该该返回函数调用，要返回函数名称！！！
    return magic()

为何返回函数调用会报这个错呢？
由于调用magic()函数的时候，没有传参进去，可是magic()里面引用了入参，这时args没有值，天然就取不到args[0]了。
学习

解决方案

去掉括弧就行了测试

def decorator(func):
    def magic(*args, **kwargs):
        _self: BasePage = args[0]
        ...
        return magic(*args, **kwargs)
    # 返回函数名，即函数自己
    return magic

坑 3：异常处理只执行了1次，自动化没法继续

报错信息

主要是定位元素过程当中出现的各类异常，NoSuchElementException、TimeoutException等常见问题。url

缘由

异常处理后，递归逻辑写得不对。return func()执行了func()，跳出了异常处理逻辑，因此异常处理只执行一次。
正确的写法是 return magic()。
感受又是装饰器小白容易犯的错误…emmm…

spa

解决方案

为了直观，已过滤不重要代码，异常处理逻辑代码会在文末放出。code

def exception_handle(func):
    def magic(*args, **kwargs):
        _self: BasePage = args[0]
        try:
            return func(*args, **kwargs)
        # 弹窗等异常处理逻辑
        except Exception as e:
            for element in _self._black_list:
                elements = _self._driver.find_elements(*element)
                if len(elements) > 0:
                    elements[0].click()
                    # 异常处理结束，递归继续查找元素 
                    # 这里以前写成了return func(*args, **kwargs)，因此异常只执行一次！！！！！
                    return magic(*args, **kwargs)
            raise e
    return magic

坑 4：如何复用driver？

问题

本身刚开始尝试写装饰器的时候，发现一个问题。
装饰器内须要用到 find_elements，这时候 driver 哪里来？还有 BasePage 的私有变量 error_max 和 error_count 怎么获取到呢？建立一个 BasePage 对象？而后经过 func 函数来传递 driver ？
func的driver是私有的，不能外部调用（事实证实能够emmm…）。
我尝试把异常相关的变量作成公共的，没用，仍是没法解决find_elements的调用问题。

解决方案

思寒的作法是，在装饰器里面建立一个self变量，取args[0]，即函数func的第一个入参self。
_self: BasePage = args[0]这一简单的语句成功解答了我全部的疑问。
类函数定义里面 self 表明类自身，所以能够获取 ._driver 属性，从而调用 find_elements。

坑 5：AttributeError

找到元素后，准备点击的时候报错

报错信息

EINFO:root:('id', 'tv_search')
INFO:root:None
INFO:root:('id', 'image_cancel')
INFO:root:('id', 'tv_agree')
INFO:root:('id', 'tv_search')
INFO:root:None

test setup failed
self = <test_appium.testcase.test_search.TestSearch object at 0x0000018946B70940>

    def setup(self):
>       self.page = App().start().main().goto_search()

test_search.py:16: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <test_appium.page.main.MainPage object at 0x0000018946B70780>

    def goto_search(self):
>       self.find(self._search_locator).click()
E       AttributeError: 'NoneType' object has no attribute 'click'

..\page\main.py:20: AttributeError

缘由

看了下 find 函数，找到元素后，有返回元素自己

@exception_handle
    def find(self, locator, key=None):
        logging.info(locator)
        logging.info(key)
        # 定位符支持元组格式和两个参数格式
        locator = locator if isinstance(locator, tuple) else (locator, key)
        WebDriverWait(self._driver, 10).until(expected_conditions.visibility_of_element_located(locator))
        element = self._driver.find_element(*locator)
        return element

那就是装饰器写得不对了

def exception_handle(func):
    def magic(*args, **kwargs):
        _self: BasePage = args[0]
        try:
            # 这里只是执行了函数，可是没有return
            func(*args, **kwargs)
        # 弹窗等异常处理逻辑
        except Exception as e:
            raise e
    return magic

解决方案

要在装饰器里面返回函数调用，要否则函数自己的返回会被装饰器吃掉。

def exception_handle(func):
    def magic(*args, **kwargs):
        _self: BasePage = args[0]
        try:
            # return函数执行结果
            return func(*args, **kwargs)
        # 弹窗等异常处理逻辑
        except Exception as e:
            raise e
    return magic

思考：写装饰器的时候，各类return看着有点头晕。每一个函数里面均可以return，分别表明什么含义呢？？？

def exception_handle(func):
    def magic(*args, **kwargs):
        _self: BasePage = args[0]
        try:
            # 第1处 return：传递func()函数的返回值。若是不写，原有return则失效
            return func(*args, **kwargs)
        # 弹窗等异常处理逻辑
        except Exception as e:
            for element in _self._black_list:
                elements = _self._driver.find_elements(*element)
                if len(elements) > 0:
                    elements[0].click()
                    # 异常处理结束，递归继续查找元素 
                    # 第2处 return：递归调用装饰后的函数。magic()表示新函数，func()表示原函数，不可混淆
                    return magic(*args, **kwargs)
            raise e
    # 第3处 return：返回装饰后的函数，装饰器语法。不能返回函数调用magic()
    return magic

装饰器完整实现

exception.py

import logging

logging.basicConfig(level=logging.INFO)

def exception_handle(func):
    def magic(*args, **kwargs):
        # 防止循环调用报错
        from test_appium.page.base_page import BasePage
        # 获取BasePage实例对象的参数self，这样能够复用driver
        _self: BasePage = args[0]
        try:
            # logging.info('error count is %s' % _self._error_count)
            result = func(*args, **kwargs)
            _self._error_count = 0
            # 返回调用函数的执行结果，要否则返回值会被装饰器吃掉
            return result
        # 弹窗等异常处理逻辑
        except Exception as e:
            # 若是超过最大异常处理次数，则抛出异常
            if _self._error_count > _self._error_max:
                raise e
            _self._error_count += 1
            for element in _self._black_list:
                # 用find_elements，就算找不到元素也不会报错
                elements = _self._driver.find_elements(*element)
                logging.info(element)
                # 是否找到弹窗
                if len(elements) > 0:
                    # 出现弹窗，点击掉
                    elements[0].click()
                    # 弹窗点掉后，从新查找目标元素
                    return magic(*args, **kwargs)
            # 弹窗也没有出现，则抛出异常
            logging.warning("no error is found")
            raise e
    return magic

学习心得

最好先不看思寒的讲解，根据本身的理解写一遍装饰器，这样学习效果最好。
遇到问题尝试解决，踩过的坑印象深入。
实在没有头绪再参考思寒的解法，那时会有一种豁然开朗的感受。
目前就踩到这些坑，若有遗漏，欢迎补充~

本文转载自霍格沃兹测试学院优秀学员indeyo 小玲儿的学习笔记，原文连接：
http://qrcode.testing-studio.com/f?from=51cto&url=https://ceshiren.com/tag/%E7%B2%BE%E5%8D%8E%E5%B8%96 转载请注明出处