全部产品
云市场

rpa3.chrome

更新时间:2020-03-03 15:25:08

目录

chrome

chrome模块是用来向用户提供一系列操作chrome浏览器的SDK,让用户通过简单的参数和方法调用来实现一些复杂的操作。
使用方法:
要使用chrome模块,需要rpa3.chrome或者

  1. improt rpa3 as rpa
  2. rpa.chrome

注:以下所有示例的SDK代码均使用rpa.chrome来进行示范

create

方法名
create(url, *, wait=True, timeout=100)

方法描述
该方法会创建一个Browser对象,并在浏览器打开对应的页面。

版本信息
该方法适用于从3.4.2及以上版本。

参数说明

  • url : 要打开的url
  • wait : 是否等待加载完成
  • timeout : 等待超时时间

返回值说明
返回一个Browser类型的对象
示例

  1. page = rpa.chrome.create('www.baidu.com')

catch

方法名
catch(name, *, mode=’title’, pattern=’contain’)

方法描述
根据url或者标题按照相应的浏览器捕获一个已经打开的页面。

版本信息
该方法适用于从3.4.2及以上版本。

参数说明

  • name : 标题或者url
  • mode : ‘title’|’url’
  • pattern:’equal’|’contain’|’regular’
    • equal:相等
    • contain:包含
    • regular:正则

返回值说明
返回一个Browser类型的对象
示例

  1. page = rpa.chrome.catch('www.baidu.com', mode="url")

catch_specified_pages

方法名
catch_specified_pages(name, *, mode=’title’, pattern=’contain’)

方法描述
捕获满足条件的所有页面。

版本信息
该方法适用于从3.4.5及以上版本。

参数说明

  • name : 标题或者url
  • mode : ‘title’|’url’
  • pattern:’equal’|’contain’|’regular’
    • equal:相等
    • contain:包含
    • regular:正则

返回值说明
返回一个Browser类型的对象列表
示例

  1. page_list = rpa.chrome.catch_specified_pages("百度一下,你就知道", mode="title",pattern="equal")
  2. page_list = rpa.chrome.catch_specified_pages("百度一下", mode="title",pattern="contain")
  3. page_list = rpa.chrome.catch_specified_pages("百度一下", mode="title",pattern="regular")
  4. page_list = rpa.chrome.catch_specified_pages("www.baidu.com", mode="url",pattern="equal")
  5. page_list = rpa.chrome.catch_specified_pages("baidu", mode="url",pattern="contain")
  6. page_list = rpa.chrome.catch_specified_pages(".*m/$", mode="url",pattern="regular")

catch_all_pages

方法名
catch_all_pages()

方法描述
捕获所有的页面对象。

版本信息
该方法适用于从3.4.5及以上版本。

参数说明

返回值说明
返回所有的页面对象列表
示例

  1. page_list = rpa.chrome.catch_all_pages()

catch_activated_pages

方法名
catch_activated_pages()

方法描述
捕获所有激活的页面对象。

版本信息
该方法适用于从3.4.5及以上版本。

参数说明

返回值说明
返回所有激活的页面对象列表
示例

  1. page_list = rpa.chrome.catch_activated_pages()

closeall

方法名
closeall()

方法描述
关闭所有的页面对象。

版本信息
该方法适用于从3.4.2及以上版本。

参数说明

返回值说明

示例

  1. rpa.chrome.closeall()

方法名
clean_cookie()

方法描述
该方法会清除所有页面cookie。

版本信息
该方法适用于从3.3.1至3.4.0版本。

参数说明

返回值说明

示例

  1. rpa.chrome.clean_cookie()

max_window

方法名
max_window()

方法描述
该方法会将浏览器最大化。

版本信息
该方法适用于从3.4.2及以上版本。

参数说明

返回值说明

示例

  1. rpa.chrome.max_window()

get_cookies

方法名
get_cookies(url=None, domain=None, name=None)

方法描述
该方法会获取一组cookie。

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • url : 获取限定给出url的cookie
  • domain : 将检索到的cookie限制为其域匹配或是此域的子域的cookie
  • name:按名称筛选cookies

返回值说明
返回获取一组cookie
示例

  1. rpa.chrome.get_cookies(url='www.baidu.com')

方法名
remove_cookie(url, name)

方法描述
删除cookie。

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • url : The URL associated with the cookie.
  • name:The name of the cookie to remove.

返回值说明

示例

  1. rpa.chrome.remove_cookie('www.baidu.com','百度一下')

方法名
set_cookie(url, name, *, domain=None, value=None, path=None,secure=False, httpOnly=False, expirationDate=None)

方法描述
设置cookie。

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • url : The request-URI to associate with the setting of the cookie.
  • name:The name of the cookie
  • domain : The domain of the cookie. If omitted, the cookie becomes a host-only cookie.
  • value : The value of the cookie. Empty by default if omitted.
  • path : The path of the cookie. Defaults to the path portion of the url parameter.
  • secure : Whether the cookie should be marked as Secure. Defaults to false.
  • httpOnly : Whether the cookie should be marked as HttpOnly. Defaults to false.
  • expirationDate : The expiration date of the cookie. (eg.’2019-07-18 12:32:43’) If omitted, the cookie becomes a session cookie.

返回值说明

示例

  1. rpa.chrome.set_cookie('www.baidu.com','百度一下')

ChromeTab

Browser : 负责为用户提供Browser相关的一些操作。

close

方法名
close(self)

方法描述
浏览器对象。

版本信息
该方法适用于从3.4.2及以上版本。

参数说明

返回值说明

示例

  1. page.close()

navigate

方法名
navigate(self, url, *, wait=True, timeout=100)

方法描述
从当前浏览器对象的链接跳转到另指定的链接。

版本信息
该方法适用于从3.4.2及以上版本。

参数说明

  • url : 要打开的url
  • wait : 是否等待加载完成
  • timeout : 等待超时时间

返回值说明

示例

  1. page.navigate('www.taobao.com')

back

方法名
back(self, wait=True, timeout=100)

方法描述
浏览器后退

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • url : 要打开的url
  • wait : 是否等待加载完成
  • timeout : 等待超时时间

返回值说明

示例

  1. page.back()

activate

方法名
activate(self)

方法描述
浏览器切换

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明

示例

  1. page.activate()

url

方法名
url(self)

方法描述
获取url

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回url
示例

  1. url = page.url()

title

方法名
title(self)

方法描述
获取标题

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回标题
示例

  1. title = page.title()

reload

方法名
reload(self, bypass_cache=False, wait=True, timeout=100)

方法描述
刷新页面

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • bypass_cache : 是否忽略缓存
  • wait : 是否等待加载完成
  • timeout : 等待超时时间

返回值说明

示例

  1. page.reload()

方法名
get_cookie(self)

方法描述
获取当前网站下的所有Cookie

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回当前网站下的所有Cookie
示例

  1. page.get_cookie()

wait_load_completed

方法名
wait_load_completed(self, timeout=100)

方法描述
等待页面加载完成

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • timeout : 等待超时时间

返回值说明

示例

  1. page.wait_load_completed()

copy

方法名
copy(self)

方法描述
在当前页面上执行拷贝操作

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回copy操作是否成功
示例

  1. page.copy()

paste

方法名
paste(self)

方法描述
粘贴到浏览器
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回paste操作是否成功
示例

  1. page.paste()

cut

方法名
paste(self)

方法描述
在当前页面上执行剪切操作
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回cut操作是否成功
示例

  1. page.cut()

executejs

方法名
executejs(self, code, *, element=None, index=1, timeout=10)

方法描述
在当前页面上执执行js代码
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • code : js代码
  • element : 控件, 在此控件所在域内执行JS(用于跨域)
  • index : 如果有多个,给出控件下标
  • timeout : 等待超时时间

返回值说明
返回cut操作是否成功
示例

  1. page.executejs("alert('aaa')")

table

方法名
table(self, value, type=’index’, rtrtype=’text’, parent_element=None)

方法描述
获取表格
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • value : 类型为index时是下标,否则为正则表达式
  • type : ‘index’|’text’|’html’
  • rtrtype : ‘text’|’html’返回类型文本或者html
  • parent_elemet : 父控件对象

返回值说明
返回二维数组或html
示例

  1. result = page.table(1,'index','html')
  2. result = page.table(1,'index','text')
  3. result = page.table('Month','text','html')
  4. result = page.table('Month','text','text')
  5. result = page.table('<table border="1">','html','html')
  6. result = page.table('<table border="1">','html','text')

scroll

方法名
scroll(self, height=0)

方法描述
滚动页面
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • height : 设置则滚动指定高度,否则滚动到页面最底部

返回值说明

示例

  1. page.scroll()
  2. page.scroll(height=100)

download_url

方法名
download_url(self, url, filename, *, complete_timeout=120)

方法描述
下载指定资源,并等待下载结束(前提设置,进入chrome://settings/, 取消“下载前询问每个文件的保存位置”)
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • url : 要下载的资源路径
  • filename : 下载结果存放的完整文件路径
  • complete_timeout : 等待下载完成的超时时间

返回值说明
下载成功返回True,否则返回False
示例

  1. page.download_url("http://www.cninfo.com.cn/new/disclosure/detail?plate=sse&stockCode=603187&announcementId=1206017235&announcementTime=2019-04-15", "C:\Users\huo\Downloads\1.pdg")

get_element

方法名
download_url(self, url, filename, *, complete_timeout=120)

方法描述
获取控件对象
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回控件对象
示例

  1. element = page.get_element('控件名称')

css

方法名
css(self, css_selector, *, index=1, parent_element=None, timeout=10)

方法描述
根据CSS表达式获取控件
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • css_selector : CSS选择器
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回控件对象
示例

  1. page.css('css选择器名称')

element_count

方法名
css(self, css_selector, *, index=1, parent_element=None, timeout=10)

方法描述
获取控件个数

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • parent_elemet : 父控件对象

返回值说明
返回控件个数
示例

  1. result = page.element_count('控件名称')

wait

方法名
wait(self, element, *, index=1, parent_element=None, timeout=10, ignore_error=False)

方法描述
等待控件加载
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间
  • ignore_error : 忽略错误

返回值说明

返回值 : 无 (默认情况 : 未等待到控件到超时时间并抛出异常,否则结束等待并继续执行)
返回值 : (igonre_error=True : 未等待到控件到超时时间并返回False,否则返回True并结束等待)
示例

  1. page.wait('控件名称')

wait_disappear

方法名
wait_disappear(self, element, *, index=1, parent_element=None,timeout=10)

方法描述
等待控件消失
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. page.wait_disappear('控件名称')

handle_javascript_dialog

方法名
handle_javascript_dialog(self, value=’ok’, text=None)

方法描述
处理JavaScript弹出框
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • value : ‘ok’|’cancel’ 点确定或取消
  • text : 向弹框中输入的文本

返回值说明

示例

  1. page.handle_javascript_dialog(value='ok')
  2. page.handle_javascript_dialog(value='concel')
  3. page.handle_javascript_dialog(text='文本内容')

click

方法名
click(self, element, *, index=1, parent_element=None, simulate=True, button=’left’, timeout=10)

方法描述
点击
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • simulate : 是否模拟点击
  • button : ‘left’|’right’ 左键或右键
  • timeout : 等待超时时间

返回值说明

示例

  1. page.click('控件名称')
  2. page.click('控件名称', button='right')

input

方法名
input(self, element, value, *, index=1, parent_element=None,simulate=True, replace=True, timeout=10)

方法描述
输入
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(输入控件)
  • value : 输入的内容
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • simulate : 是否模拟输入
  • replace : 是否清空之前的内容
  • timeout : 等待超时时间

返回值说明

示例

  1. result = page.input('控件名称','aaa')

input_text

方法名
input_text(self, element, value, *, index=1, parent_element=None, replace=True, timeout=10)

方法描述
输入文本
版本信息
该方法适用于从3.4.7及以上版本。

参数说明

  • element : 控件名称
  • value : 输入的内容
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • replace : 是否清空之前的内容
  • timeout : 等待超时时间

返回值说明

示例

  1. page = rpa.chrome.create('www.baidu.com')
  2. #在输入框输入内容(下方输入框为录制的百度页面的输入框)
  3. page.input_text('输入框','阿里云RPA')

input_hotkeys

方法名
input_hotkeys(element, value, *, index=1, parent_element=None, timeout=10)

方法描述
输入快捷键
版本信息
该方法适用于从3.4.7及以上版本。

参数说明

  • element : 控件名称
  • value : 输入的内容,内容为虚拟键码,详细的虚拟键码请查看虚拟键码表
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. page = rpa.chrome.create('www.baidu.com')
  2. #在输入框输入内容(下方输入框为录制的百度页面的输入框)
  3. page.input_text('输入框','阿里云RPA')
  4. sleep(1)
  5. #按回车键
  6. page.input_hotkeys('输入框','VK_RETURN')
  7. sleep(2)
  8. #输入大写的A
  9. page.input_hotkeys('输入框','VK_SHIFTPRESS')
  10. page.input_hotkeys('输入框','A')
  11. page.input_hotkeys("输入框", "VK_SHIFTRELEASE")
  12. # 按一下左边的"WIN"键,按下并弹起
  13. page.input_hotkeys("输入框", "VK_LWIN")

注:使用input_hotkeys时是模拟键盘输入,输入的内容为字母时输入法需要处于英文键盘模式下

download

方法名
download(self, *, path=None, element=None, url=None, name=None, index=1, parent_element=None, timeout=10)

方法描述
下载
调用浏览器下载方法,需要使用path,url,name(可空)
调用控件下载,需要用element,name,index(可空),parent_element(可空)
注:点按钮下载写的是name,用url下载写的是path
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • path : 保存的文件路径
  • url : 下载路径
  • name : 保存的文件名称(调用控件下载的时候可以是路径加名称
  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. page.download(path=r'D:/',url=r'http://pcr1.pc6.com/rm/bdbizhi.zip')
  2. page.download(element ='控件名称',name =r'aaa.zip')
  3. #遇到未产生空白页的异步下载需要判断下载完成
  4. page.download(name=r"C:\test\temp.exe", element="链接_16547")#写一个临时文件名
  5. while True:
  6. if os.path.exists(r"C:\test\temp.exe"): #等待文件创建
  7. try:
  8. os.rename(r"C:\test\temp.exe",r"C:\test\target.exe") #下载完成后能完成重命名操作
  9. break
  10. except Exception as e: #由于正在下载所以被占用
  11. # print(e)
  12. sleep(1)
  13. else:
  14. sleep(1)

upload

方法名
upload(self, element, file, *, index=1, parent_element=None, timeout=10)

方法描述
上传文件
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • file : 上传的文件路径
  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. page.upload('控件名称',r'D:/baidu.jpg')

text

方法名
text(self, element=None, *, index=1, parent_element=None, timeout=10)

方法描述
获取文本,不传返回浏览器上所有的文本
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回文本,不传返回浏览器上所有的文本
示例

  1. result = page.text(element='控件名称')
  2. result = page.text()

html

方法名
html(self, element=None, *, index=1, parent_element=None, timeout=10)

方法描述
获取html,不传返回浏览器上所有的html
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回html,不传返回浏览器上所有的html
示例

  1. result = page.html(element='控件名称')
  2. result = page.html()

value

方法名
value(self, element, *, index=1, parent_element=None, timeout=10)

方法描述
获取value属性的值
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回value属性的值
示例

  1. result = page.value('控件名称')

option

方法名
option(self, element, value, *, index=1, parent_element=None, type=’match’, timeout=10)

方法描述
下拉框选择
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(下拉列表控件)
  • value : 选择内容
  • index : 如果有多个,给出控件下标
  • type : ‘match’|’full’|’regex’ 分表标识
    • match : 模糊匹配
    • full : 完全匹配
    • regex : 正则匹配
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
下拉框选择
示例

  1. page.option('控件名称','Sa')
  2. page.option('控件名称','Sa',type='match')
  3. page.option('控件名称','Saab',type='full')
  4. page.option('控件名称','.*',type='regx')

check

方法名
check(self, element, *, value=None, index=1, parent_element=None,timeout=10)

方法描述
勾选框操作
获取勾选状态时有返回值

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(下拉列表控件)
  • value : 不给获取勾选状态,传入True则勾选,传入False取消勾选
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回勾选状态
示例

  1. result = page.check('控件名称')
  2. page.check('控件名称',value=True)
  3. page.check('控件名称',value=False)

attr

方法名
attr(self, element, attrname, *, index=1, parent_element=None,timeout=10)

方法描述
获取属性
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(复选框控件)
  • attrname : ‘value’|’name’|’href’ 值|名称|链接
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回属性
示例

  1. result = page.attr('控件名称',attrname='value')
  2. result = page.attr('控件名称',attrname='name')
  3. result = page.attr('控件名称',attrname='href')

alert

方法名
alert(self, element, *, value=’ok’, text=None, index=1,parent_element=None, timeout=10)

方法描述
弹出框点击
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(弹出窗按钮)
  • index : 如果有多个,给出控件下标
  • value : ‘yes’|’no’ 点确定或取消
  • text : 向弹框中输入的文本
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
弹出框点击
示例

  1. result = page.alert('按钮名称',value='no')

pos

方法名
pos(self, element, *, index=1, parent_element=None, timeout=10)

方法描述
获取控件坐标
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(下拉列表控件)
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回坐标 json格式{‘x1’: 0, ‘y1’: 0, ‘x2’: 0, ‘y2’: 0}
示例

  1. result = json.loads(page.pos('百度一下'))
  2. x1 = int(float(result["x1"]))
  3. x2 = int(float(result["x2"]))
  4. y1 = int(float(result["y1"]))
  5. y2 = int(float(result["y2"]))

screenshot

方法名
screenshot(self, element, file, *, index=1, parent_element=None,timeout=10)

方法描述
截图
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • file : 保存的截图路径
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. result = page.screenshot('控件名称',r'D:\aaa.jpg')

mouse_move

方法名
mouse_move(self, element, *, index=1, parent_element=None, timeout=10)

方法描述
鼠标移入
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. result = page.mouse_move('控件名称')

isvisible

方法名
isvisible(self, element, *, index=1, parent_element=None, timeout=10)

方法描述
获取控件是否可见
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(下拉列表控件)
  • value : 选择内容
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明
返回控件是否可见
示例

  1. result = page.isvisible('控件名称')

drag

方法名
drag(self, element, *, x=None, y=None, index=1, parent_element=None,timeout=10)

方法描述
将元素拖拽到指定的位置
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称(下拉列表控件)
  • x : x轴偏移量 /
  • y : y轴偏移量/
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. result = page.drag('控件名称')

clear_input

方法名
clear_input(self, element, *, index=1, parent_element=None, timeout=10)

方法描述
清空输入框
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • element : 控件名称)
  • index : 如果有多个,给出控件下标
  • parent_elemet : 父控件对象
  • timeout : 等待超时时间

返回值说明

示例

  1. result = page.clear_input('控件名称')

ChromeElement

版本信息
该方法适用于从3.4.0及以上版本。
element : 负责为用户提供控件相关的一些操作。以下所有功能皆使用此控件变量名。

  1. ele = page.get_element("控件名称”)

scrollIntoView

方法名
scrollIntoView(self)

方法描述
将元素调整到可视区域
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明

示例

  1. ele.scrollIntoView()

click

方法名
click(self, *, simulate=True, button=’left’)

方法描述
点击
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • simulate : 是否模拟点击
  • button : ‘left’|’right’ 左键或右键

返回值说明

示例

  1. ele.click()
  2. ele.click(button='right')

double_click

方法名
double_click(self, *, simulate=True)

方法描述
双击
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • simulate : 是否模拟点击

返回值说明

示例

  1. ele.double_click()

input

方法名
input(self, value, *, simulate=True, replace=True)

方法描述
输入
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • value : 输入的内容
  • simulate : 是否模拟输入
  • replace : 是否清空之前的内容

返回值说明

示例

  1. ele.input("文本信息")

download

方法名
download(self, *, path=None, element=None, url=None, name=None, index=1, parent_element=None, timeout=10)

方法描述
下载
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • filename : 下载结果存放的完整文件路径
  • prepare_timeout : 等待进入下载的超时时间
  • complete_timeout : 等待下载完成的超时时间

返回值说明
下载成功返回True,否则返回False
示例

  1. ele.download("C:\Users\huo\Downloads\1.xls")

upload

方法名
upload(self, filename)

方法描述
上传
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • filename : 上传文件完整路径

返回值说明
下载成功返回True,否则返回False
示例

  1. ele.upload("C:\Users\huo\Downloads\1.xls")

executejs

方法名
executejs(self, code)

方法描述
执行js代码
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • code : js代码

返回值说明
执行结果(JSON字符串形式
示例

  1. ele.executejs("alert('aaa')")

text

方法名
text(self)

方法描述
获取元素内容文本
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回元素内容文本
示例

  1. ele.text()

html

方法名
html(self)

方法描述
获取元素HTML源代码
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回元素HTML源代码
示例

  1. ele.html()

value

方法名
value(self)

方法描述
获取元素值
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回元素值
示例

  1. ele.value()

option

方法名
option(self, text, *, type=’match’)

方法描述
下拉框选择
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • text : 选择内容
  • type : ‘match’|’full’|’regex’ 分表标识
    • match : 模糊匹配
    • full : 完全匹配
    • regex : 正则匹配

返回值说明
下拉框选择
示例

  1. ele.option("sa")
  2. ele.option("sa", type="match")
  3. ele.option("sad", type="full")
  4. ele.option(".*", type="regex")

option_by_index

方法名
option_by_index(self, index)

方法描述
通过索引设置下拉框选项
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • index : 选项索引

返回值说明
下拉框选择
示例

  1. ele.option_by_index(2)

get_options

方法名
get_options(self, *, mode=’selected’)

方法描述
获取一个集合
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • mode : selected|al

返回值说明
返回下拉框选中的值/所有的选项
示例

  1. ele.get_options(mode="all")
  2. ele.get_options(mode="selected")

check

check(self, *, value=None)

  • value : 不给获取勾选状态,传入True则勾选,传入False取消勾选 获取勾选状态时有返回值

勾选框操作
方法名
check(self, *, value=None)

方法描述
勾选框操

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • value : 不给获取勾选状态,传入True则勾选,传入False取消勾选 获取勾选状态时有返回值

返回值说明
返回勾选状态
示例

  1. ele.check()
  2. ele.check(value=True)
  3. ele.check(value=False)

attr

方法名
upload(self, filename)

方法描述
获取属性

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • name : 属性名

返回值说明
返回属性的值
示例

  1. ele.attr("href")

pos

方法名
pos(self)

方法描述
获取控件坐标
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回坐标 json格式{‘x1’: 0, ‘y1’: 0, ‘x2’: 0, ‘y2’: 0}
示例

  1. ele.pos()

screenshot

方法名
screenshot(self, filename)

方法描述
截图
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • filename : 保存的截图路径

返回值说明

示例

  1. ele.screenshot(r"C:\Users\huo\Downloads\1.xls")

mouse_move

方法名
mouse_move(self)

方法描述
鼠标移入
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明

示例

  1. page.mouse_move()

isvisible

方法名
isvisible(self)

方法描述
获取控件是否可见
版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明
返回控件是否可见
示例

  1. ele.isvisible()

drag

方法名
drag(self, x=None, y=None)

方法描述
将元素拖拽到指定的位置

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

  • x : x轴偏移量 /
  • y : y轴偏移量 /

返回值说明

示例

  1. ele.drag(x=10, y=20)
  2. ele.drag(x=10.0, y=20.0)

clear

方法名
clear(self)

方法描述
清空输入框

版本信息
该方法适用于从3.4.0及以上版本。

参数说明

返回值说明

示例

  1. ele.clear()