Python 装饰器简介
装饰器（Decorator）是 Python 非常实用的一个语法糖功能。装饰器本质是一种返回值也是函数的函数，可以称之为“函数的函数”。其目的是在不对现有函数进行修改的情况下，实现额外的功能。
在 Python 中，装饰器属于纯粹的“语法糖”，不使用也没关系，但是使用的话能够大大简化代码，使代码更加简洁易读。
最近在霍格沃兹测试学院的《Python 测试开发实战进阶》课程中学习了 App 自动化测试框架的异常处理，存在一定重复代码，正好可以当作题材，拿来练习一下装饰器。
装饰器学习资料，推荐参考 RealPython
https://realpython.com/primer-on-python-decorators/
本文主要汇总记录 Python 装饰器的常见踩坑经验，列举报错信息、原因和解决方案，供大家参考。
装饰器避坑指南
坑 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 BasePageE 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 保持不变。
exception.pydef 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 等常见问题。
原因
异常处理后，递归逻辑写得不对。return func() 执行了 func()，跳出了异常处理逻辑，所以异常处理只执行一次。
正确的写法是 return magic()。
感觉又是装饰器小白容易犯的错误 …emmm…. :no_mouth:
解决方案
为了直观，已过滤不重要代码，异常处理逻辑代码会在文末放出。
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:NoneINFO:root:('id', 'image_cancel')INFO:root:('id', 'tv_agree')INFO:root:('id', 'tv_search')INFO:root:None
test setup failedself = <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.pyimport 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
复制代码
一点学习心得
“纸上得来终觉浅，绝知此事要躬行”。遇到问题后尝试自主解决，这样踩过的坑才印象深刻。
所以，建议大家最好先根据自己的理解写一遍装饰器，遇到问题实在没有头绪了，再参考思寒老师的解法，那时会有一种豁然开朗的感觉，这样学习的效果最好。
以上，Python 装饰器踩到的这些坑，如有遗漏，欢迎补充~
评论