Python + selenium二次封装API

墨蓝 2023-06-10 05:29 11阅读 0赞

PO 模式解决的是元素定位与操作的分离；  
selenium API 二次开发解决的API易用性。

## 对selenium常用方法进行二次封装 ##

`module.py`

# coding=utf-8
    """ 此文件为selenium常用方法二次封装文件 """
    from selenium import webdriver
    from selenium.webdriver.common.action_chains import ActionChains
    from selenium.webdriver.support import expected_conditions as EC
    from selenium.webdriver.support.ui import WebDriverWait
    from selenium.webdriver.common.by import By
    from selenium.webdriver.chrome.options import Options
    from selenium.common.exceptions import NoSuchElementException,TimeoutException
    from selenium.webdriver.support.select import Select
    
    
    class browser(object):
        """ selenium框架的主要类 """
        original_window = None
    
        def __init__(self, browser='chrome'):
            """ 运行初始化方法默认chrome，当然，你也可以传入一个其他浏览器名称， """
            if browser == "firefox" or browser == "ff":
                self.driver = webdriver.Firefox()
            elif browser == "chrome":
                self.driver = webdriver.Chrome()
            elif browser == "internet explorer" or browser == "ie":
                self.driver = webdriver.Ie()
            elif browser == "opera":
                self.driver = webdriver.Opera()
            elif browser == "chrome_headless":
                chrome_options = Options()
                chrome_options.add_argument('--headless')
                self.driver = webdriver.Chrome(chrome_options=chrome_options)
            elif browser == 'edge':
                self.driver = webdriver.Edge()
            else:
                raise NameError(
                    "找不到 %s 浏览器,你应该从这里面选取一个 'ie', 'ff', 'opera', 'edge', 'chrome' or 'chrome_headless'." % browser)
    
        def element_wait(self, by, value, secs=5):
            """ 等待元素显示 """
            try:
                if by == "id":
                    WebDriverWait(self.driver, secs, 1).until(EC.presence_of_element_located((By.ID, value)))
                elif by == "name":
                    WebDriverWait(self.driver, secs, 1).until(EC.presence_of_element_located((By.NAME, value)))
                elif by == "class":
                    WebDriverWait(self.driver, secs, 1).until(EC.presence_of_element_located((By.CLASS_NAME, value)))
                elif by == "link_text":
                    WebDriverWait(self.driver, secs, 1).until(EC.presence_of_element_located((By.LINK_TEXT, value)))
                elif by == "xpath":
                    WebDriverWait(self.driver, secs, 1).until(EC.presence_of_element_located((By.XPATH, value)))
                elif by == "css":
                    WebDriverWait(self.driver, secs, 1).until(EC.presence_of_element_located((By.CSS_SELECTOR, value)))
                else:
                    raise NoSuchElementException(
                        "找不到元素，请检查语法或元素")
            except TimeoutException:
                print("查找元素超时请检查元素")
    
        def get_element(self, css):
            """ 判断元素定位方式，并返回元素 """
            if "=>" not in css:
                by = "css"  # 如果是css的格式是#aaa,所以在此加入判断如果不包含=>就默认是css传给上面的element_wait判断元素是否存在
                value = css
                # wait element.
                self.element_wait(by, css)
            else:
                by = css.split("=>")[0]
                value = css.split("=>")[1]
                if by == "" or value == "":
                    raise NameError(
                        "语法错误，参考: 'id=>kw 或 xpath=>//*[@id='kw'].")
                self.element_wait(by, value)
    
            if by == "id":
                element = self.driver.find_element_by_id(value)
            elif by == "name":
                element = self.driver.find_element_by_name(value)
            elif by == "class":
                element = self.driver.find_element_by_class_name(value)
            elif by == "link_text":
                element = self.driver.find_element_by_link_text(value)
            elif by == "xpath":
                element = self.driver.find_element_by_xpath(value)  # 如果是xpath要以此格式传入xpath=>//*[@id='su']
            elif by == "css":
                element = self.driver.find_element_by_css_selector(value)
            else:
                raise NameError(
                    "Please enter the correct targeting elements,'id','name','class','link_text','xpath','css'.")
            return element
    
        def open(self, url):
            """ 打开url. 用法: driver.open("https://www.baidu.com") """
            self.driver.get(url)
    
        def max_window(self):
            """ 设置浏览器最大化. 用法: driver.max_window() """
            self.driver.maximize_window()
    
        def set_window(self, wide, high):
            """ 设置浏览器窗口宽和高. 用法: driver.set_window(wide,high) """
            self.driver.set_window_size(wide, high)
    
        def send_value(self, css, text):
            """ 操作输入框. 用法: driver.type("css=>#el","selenium") """
            el = self.get_element(css)
            el.send_keys(text)
    
        def clear(self, css):
            """ 清除输入框的内容. 用法: driver.clear("css=>#el") """
            el = self.get_element(css)
            el.clear()
    
        def click(self, css):
            """ 它可以点击任何文本/图像 连接，复选框，单选按钮，甚至下拉框等等.. 用法: driver.click("css=>#el") """
            el = self.get_element(css)
            el.click()
    
        def right_click(self, css):
            """ 右键单击元素. 用法: driver.right_click("css=>#el") """
            el = self.get_element(css)
            ActionChains(self.driver).context_click(el).perform()
    
        def move_to_element(self, css):
            """ 鼠标移到元素（悬停）. 用法: driver.move_to_element("css=>#el") """
            el = self.get_element(css)
            ActionChains(self.driver).move_to_element(el).perform()
    
        def double_click(self, css):
            """ 双击元素. 用法: driver.double_click("css=>#el") """
            el = self.get_element(css)
            ActionChains(self.driver).double_click(el).perform()
    
        def drag_and_drop(self, el_css, ta_css):
            """ 把一个元素拖到一定的距离，然后把它放下. 用法: driver.drag_and_drop("css=>#el","css=>#ta") """
            element = self.get_element(el_css)
            target = self.get_element(ta_css)
            ActionChains(self.driver).drag_and_drop(element, target).perform()
    
        def click_text(self, text):
            """ 单击链接文本中的元素 用法: driver.click_text("新闻") """
            self.driver.find_element_by_partial_link_text(text).click()
    
        def close(self):
            """ 模拟用户在弹出框的标题栏中点击“关闭”按钮窗口或选项卡. Usage: driver.close() """
            self.driver.close()
    
        def quit(self):
            """ 关闭使用的所有窗口. 用法: driver.quit() """
            self.driver.quit()
    
        def submit(self, css):
            """ 提交指定的表单 用法: driver.submit("css=>#el") """
            el = self.get_element(css)
            el.submit()
    
        def F5(self):
            """ 刷新当前页面. 用法: driver.F5() """
            self.driver.refresh()
    
        def js(self, script):
            """ 执行JavaScript脚本. 用法: driver.js("window.scrollTo(200,1000);") """
            self.driver.execute_script(script)
    
        def get_attribute(self, css, attribute):
            """ 获取元素属性的值. 用法: driver.get_attribute("css=>#el","type") """
            el = self.get_element(css)
            return el.get_attribute(attribute)
    
        def get_text(self, css):
            """ 获得元素文本信息 用法: driver.get_text("css=>#el") """
            el = self.get_element(css)
            return el.text
    
        def get_display(self, css):
            """ 获取元素来显示，返回结果为真或假. 用法: driver.get_display("css=>#el") """
            el = self.get_element(css)
            return el.is_displayed()
    
        def get_title(self):
            """ 得到窗口标题. 用法: driver.get_title() """
            return self.driver.title
    
        def get_url(self):
            """ 获取当前页面的URL地址. 用法: driver.get_url() """
            return self.driver.current_url
    
        def get_alert_text(self):
            """ 得到警报的文本. 用法: driver.get_alert_text() """
            return self.driver.switch_to.alert.text
    
        def wait(self, secs):
            """ 隐式等，页面上的所有元素. 用法: driver.wait(10) """
            self.driver.implicitly_wait(secs)
    
        def accept_alert(self):
            """ 接受警告框. 用法: driver.accept_alert() """
            self.driver.switch_to.alert.accept()
    
        def dismiss_alert(self):
            """ Dismisses the alert available. 用法: driver.dismiss_alert() """
            self.driver.switch_to.alert.dismiss()
    
        def switch_to_frame(self, css):
            """ 切换到指定的frame. 用法: driver.switch_to_frame("css=>#el") """
            iframe_el = self.get_element(css)
            self.driver.switch_to.frame(iframe_el)
    
        def switch_to_frame_out(self):
            """ Returns the current form machine form at the next higher level. Corresponding relationship with switch_to_frame () method. Usage: driver.switch_to_frame_out() """
            self.driver.switch_to.default_content()
    
        def open_new_window(self, css):
            """ 打开新窗口并切换到新打开的窗口. 用法: 传入一个点击后会跳转的元素 driver.open_new_window("link_text=>注册") """
            original_window = self.driver.current_window_handle
            el = self.get_element(css)
            el.click()
            all_handles = self.driver.window_handles
            for handle in all_handles:
                if handle != original_window:
                    self.driver.switch_to.window(handle)
    
        def get_screen_shot(self, file_path):
            """将当前窗口的屏幕截图保存到PNG图像文件中. 用法: driver.get_screen_shot('/Screenshots/foo.png') """
            self.driver.get_screenshot_as_file(file_path)
    
        def select(self, css, value):
            """ 构造函数。对给定的元素进行了检查，确实是一个SELECT标记。如果不是, 然后抛出一个意料之外的tag name exception. :Args: - css - element SELECT element to wrap - value - The value to match against Usage: <select name="NR" id="nr"> <option value="10" selected="">每页显示10条</option> <option value="20">每页显示20条</option> <option value="50">每页显示50条</option> </select> driver.select("#nr", '20') driver.select("xpath=>//[@name='NR']", '20') """
            el = self.get_element(css)
            Select(el).select_by_value(value)
    
    
    if __name__ == '__main__':
        driver = browser("chrome")

## 编写测试脚本 ##

以Page Object 设计模式编写

`paget.py`

# 编写测试元素操作
    class baidu_test:
        def __init__(self,driver,url="https://www.baidu.com/" ):
            self.driver = driver
            self.driver.max_window()
            self.url = url
    
        def search(self,search_keys):
            self.driver.open(self.url)#注意不要把打开网址放置到test之前
            self.driver.send_value('id=>kw',search_keys)
    
        def search_button(self):
            self.driver.click("xpath=>//*[@id='su']")

`baidu_test.py`

from module import browser
    import unittest,time
    from time import sleep
    from parameterized import parameterized
    from HTMLTestRunner import HTMLTestRunner
    from paget import baidu_test
    class test(unittest.TestCase):
        """百度搜索测试"""
        @classmethod
        def setUpClass(cls):
            cls.dr = browser("chrome")#调用二次封装类，传入浏览器或使用默认浏览
            cls.test = baidu_test(cls.dr)
        @classmethod
        def tearDownClass(cls):
            cls.dr.close()
    
        @parameterized.expand([
            ("selenium", "selenium_百度搜索"),  # 此处为file.csv中的数据
            ("selenium2","selenium2_百度搜索"),
            ("selenium31","selenium3_百度搜索"),
            ("webdriver","webdriver_百度搜索"),
        ])
        def test_search(self, search_str, assrt_str):  # 接收上面的两个参数
            '''百度测试用例'''
            self.test.search(search_str)
            self.test.search_button()
            sleep(1)
            self.assertEqual(self.dr.get_title(), assrt_str) #调用二次封装类中的获取title进行断言
            sleep(2)
    
    
    if __name__ == "__main__":
        # unittest.main()
        test_script = "./"  # 需要执行的脚本路径
        test_repot = "D:/"  # 测试报告存放路径
        discover = unittest.defaultTestLoader.discover(test_script, pattern="baidu.py")  # 传入路径及脚本名称
        date = time.strftime("%Y-%m-%d %H-%M-%S")  # 当前时间
        filname = test_repot + date + "result.html"  # 将报告存放路径、当前时间、文件名称拼接
        op = open(filname, "wb")  # 创建并以二进制写入
        runner = HTMLTestRunner(stream=op,  # 测试报告的昵称
                                title="百度测试",  # 标题
                                description="以下为执行结果建议Chrome打开")  # 描述
        runner.run(discover)  # 运行
        op.close()  # 关闭文件