軟件測試開發實戰 | 記錄寫裝飾器時踩的幾個坑

時間 2020-12-09

標籤 python app 框架函數學習測試 url code 對象遞歸欄目 Python 简体版

原文原文鏈接

本文轉載自霍格沃茲測試學院優秀學員indeyo 小玲兒的學習筆記，原文連接：http://qrcode.testing-studio.com/f?from=bokeyuan&url=https://ceshiren.com/tag/精華帖python

背景

裝飾器是python裏面一個頗有用的語法糖（ Syntactic Sugar），能夠減小大量重複代碼的編寫。app

裝飾器學習地址：https://realpython.com/primer-on-python-decorators/ 34框架

恰好最近學習了app自動化框架的異常處理，存在必定重複代碼，準備看成題材，拿來練習一下裝飾器。函數

下面記錄一下裝飾器的踩坑之路。學習

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

報錯信息url

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 文件之間存在相互調用關係。code

解決方案
把循環調用的包引入信息放在函數內。只要一方的引用信息放在函數裏便可，沒必要兩邊都放。對象

我只在 exception.py 文件裏改了，base_page.py 保持不變。遞歸

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等常見問題。

緣由
異常處理後，遞歸邏輯寫得不對。return func()執行了func()，跳出了異常處理邏輯，因此異常處理只執行一次。

正確的寫法是 return magic()。

感受又是裝飾器小白容易犯的錯誤…emmm…

解決方案
爲了直觀，已過濾不重要代碼，異常處理邏輯代碼會在文末放出。

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

學習心得

最好先不看思寒的講解，根據本身的理解寫一遍裝飾器，這樣學習效果最好。

遇到問題嘗試解決，踩過的坑印象深入。

實在沒有頭緒再參考思寒的解法，那時會有一種豁然開朗的感受。

目前就踩到這些坑，若有遺漏，歡迎補充~