迈容插件版IDE-API描述总览

本文档是对插件版IDE用到的所有API进行文档型描述。本处提到的API是指迈容公司基于python自动化进行的二次封装,目的是方便使用者直接调用函数,函数简单易用。

操作系统支持度

自动化范围 是否支持
window7、8、10
linux

自动化范围

自动化范围 包名称 归属 描述
系统应用 rpa.system 操作系统 打开操作系统的命令等
对话框 rpa.dialog 操作系统 生成对话框界面,用于提示或者用户交互等
鼠标 rpa.mouse 鼠标 控制鼠标进行操作等
键盘 rpa.keyboard 键盘 控制键盘进行输入操作等
剪贴板 rpa.clipboard 操作系统 调用操作系统的剪贴板命令等
浏览器 rpa.webdriver 浏览器 通过webdriver控制浏览器进行自动化操作等
新浏览器 rpa.page 新浏览器 通过playwright控制浏览器进行自动化操作等
识图 rpa.picture 识图 通过识图方式进行自动化操作等
安卓 rpa.android 安卓 控制安卓手机进行自动化操作等
通用文件 rpa.commonfile 通用文件 对文件进行操作等
INI格式 rpa.ini INI格式 对INI格式文件进行操作等
CSV格式 rpa.csvfile CSV格式 对CSV格式文件进行操作等
PDF格式 rpa.pdf PDF格式 对PDF格式文件进行操作等
Word文档 rpa.word Word文档 对Word文档进行操作等
Excel表格 rpa.excel Excel表格 对Excel表格进行操作等
网络设备 rpa.net 网络设备 获取网络设备的信息等
HTTP rpa.httpclient HTTP 进行HTTP请求操作等
SMTP/POP rpa.smtp SMTP/POP 通过SMTP/POP对邮件进行操作等
FTP rpa.ftp FTP 对ftp进行操作等
数据库 rpa.db 数据库 对数据库进行增删改查操作等
json rpa.mrjson json 对json进行数据解析操作等
字符串 rpa.mrstr 字符串 对字符串类型进行数据解析操作等
正则表达式 rpa.reg 正则表达式 使用正则表达式进行操作等
数字 rpa.mrmath 数字 进行数学运算操作等
时间 rpa.mrtime 时间 处理日期和时间操作等
二维码 rpa.mrqrcode 二维码 进行识别二维码和生成二维码操作等
解析html rpa.parseHtml 解析html 解析html并进行处理操作等

 

系统应用(1000)

对话框(2000)

鼠标(3000)

键盘(4000)

剪贴板(5000)

浏览器(6000)

新浏览器(7000)

win32(8000)

识图(9000)

安卓(10000)

通用文件(11000)

INI格式(12000)

CSV格式(13000)

PDF格式(14000)

Word文档(15000)

Excel表格(16000)

网络设备(17000)

HTTP(18000)

SMTP/POP(19000)

FTP(20000)

数据库(21000)

json(22000)

字符串(23000)

正则表达式(24000)

数字(25000)

时间(26000)

二维码(27000)

解析html(28000)

......


API详细介绍


rpa.system.uname

获取操作系统当前用户

rpa.system.cmdExe

打开应用或命令窗口

rpa.system.environ

获取环境变量信息,并返回环境变量值

rpa.system.environGet

读取某环境变量

rpa.system.getcwd

获取当前工作目录并返回值

rpa.system.system

关闭指定的应用程序

rpa.system.voice

播放指定路径下的音频文件

rpa.system.rectCapturePlus

屏幕截图

rpa.system.lockScreen

锁屏

rpa.system.inputMethodJudgment

判断当前输入法

rpa.system.setInputer

切换输入法


rpa.dialog.msgbox

创建一个提示框

rpa.dialog.enterbox

创建一个单行输入框.

rpa.dialog.passwordbox

创建一个单行密码输入框

rpa.dialog.multenterbox

创建一个多行输入框

rpa.dialog.multpasswordbox

创建一个登录框

rpa.dialog.diropenbox

返回用户选择的目录名(带完整路径),如果用户选择“Cancel”则返回None

rpa.dialog.fileopenbox

从指定目录打开文件

rpa.dialog.filesavebox

保存文件到指定目录

rpa.dialog.choicebox

创建一个列表选择框


rpa.mouse.click

执行鼠标点击操作.

rpa.mouse.moveTo

鼠标移动到指定位置.

rpa.mouse.moveRel

鼠标从上一位置移动到指定位置,相对移动.

rpa.mouse.position

获取鼠标当前所在位置,返回一个(x,y)坐标

rpa.mouse.dragTo

鼠标从当前位置拖动到指定位置

rpa.mouse.scroll

鼠标滑轮移动的距离


rpa.keyword.typewrite

键盘输入数字、字母...

rpa.keyword.hotkey

键盘输入组合键,其中输入的参数为需要键入的组合键内容

rpa.keyword.press

键盘输入单个按键内容,参数为要输入的按键


rpa.clipboard.copy

复制内容到剪切板

rpa.clipboard.paste

从剪切板粘贴

rpa.clipboard.copyImg

复制图片

rpa.clipboard.pasteImg

粘贴图片


rpa.webdriver.create

创建并启动一个浏览器

rpa.webdriver.bind

绑定已启动地浏览器

rpa.webdriver.get

打开浏览器网页

rpa.webdriver.quitOrClose

退出或关闭当前浏览器

rpa.webdriver.explicitWait

设置获取元素时需要等待的时间

rpa.webdriver.parseHtml

获取当前浏览器页面的网页源码

rpa.webdriver.executeJs

执行 js 脚本

rpa.webdriver.setCookie

设置当前浏览器页面的 cookie 中的参数值

rpa.webdriver.getCookie

获取当前 cookie 并返回 cookie 值

rpa.webdriver.refresh

刷新当前浏览器页面

rpa.webdriver.findElement

定位元素,并返回会获取到的元素值

rpa.webdriver.findElements

定位多个元素,并返回会获取到的元素值

rpa.webdriver.operElement

元素触发处理

rpa.webdriver.toFrame

切换iframe并返回切换到的iframe

rpa.webdriver.parentFrame

切换到上一个iframe,并返回iframe值

rpa.webdriver.submit

表单提交

rpa.webdriver.scrollIntoView

滚动至元素处

rpa.webdriver.scroll

网页向左右或上下滚动

rpa.webdriver.elementDrag

元素拖动

rpa.webdriver.elementDragByOffset

元素偏移拖动

rpa.webdriver.maxOrMin

浏览器窗口最大或最小化

rpa.webdriver.getWindowHandle

获取当前浏览器窗口并返回

rpa.webdriver.getAllWindowHandle

获取所有窗口

rpa.webdriver.changeWindow

切换到下一个窗口

rpa.webdriver.changeAssignWindow

切换到指定窗口

rpa.webdriver.changeEndWindow

切换到最后一个窗口

rpa.webdriver.closeOtherWindow

关闭其他窗口

rpa.webdriver.forwardOrBack

浏览器页面前进或后退

rpa.webdriver.screenShot

截取当前浏览器图片,并返回图片存放路径

rpa.webdriver.elementScreenshot

浏览器元素截图

rpa.webdriver.getAlert

获取弹窗

rpa.webdriver.textAlert

获取弹窗内容

rpa.webdriver.acceptAlert

点击弹窗确认

rpa.webdriver.sendkeysAlert

输入数据至弹窗

rpa.webdriver.dismissAlert

弹窗取消


rpa.page.create

创建一个浏览器页面并返回上下文在后续的启动浏览器中对上下文操作

rpa.page.newPage

选择启动浏览器类型,并创建page对象

rpa.page.goPage

在创建的浏览器页面里打开一个新网页

rpa.page.locator

在打开的页面中根据Xpath定位元素

rpa.page.waitUtil

等待元素加载

rpa.page.handle

对定位的元素执行操作,参数"operation"为操作属性

rpa.page.swtichFrame

定位网页iframe

rpa.page.executeJs

执行js脚本

rpa.page.keyboardType

通过键盘在网页输入指定字符串

rpa.page.keyboardPress

键入键盘按键

rpa.page.mouseClick

通过鼠标点击指定坐标位置

rpa.page.mouseDbclick

通过鼠标双击指定坐标位置

rpa.page.mouseMove

将鼠标移动到指定位置

rpa.page.mouseWheel

鼠标滚动到指定坐标位置

rpa.page.screenShot

浏览器页面截图

rpa.page.dialog

对话框操作

rpa.page.reload

刷新页面

rpa.page.getPageSource

获取并返回网页源码

rpa.page.close

关闭当前网页

quit

退出当前打开的浏览器


rpa.window.get

指定操作窗口

rpa.window.setActive

设置活动窗口

rpa.window.visiblity

窗口隐藏/显示

rpa.window.isExist

窗口是否存在

rpa.window.getSize

获取窗口大小

rpa.window.minMax

窗口最大化/最小化

rpa.window.reSize

窗口调整

rpa.window.top

窗口置顶

rpa.window.pid

获取进程PID

rpa.window.close

关闭窗口

rpa.window.findControl

查找指定元素

rpa.window.getChildren

获取子元素

rpa.window.getParent

获取父元素

rpa.window.oper

元素指定操作

rpa.window.operControlIsExist

判断元素是否存在

rpa.window.getAttribute

获取元素特征


rpa.picture.moveTo

鼠标移动至图像

rpa.picture.findAndClick

识别并点击图像

rpa.picture.findAndDrag

识别并拖动图像

rpa.picture.compare

图像对比


rpa.android.list

查看连接设备

rpa.android.connect

查看手机设备连接并在终端输出一个手机序列号

rpa.android.deviceInfo

获取手机信息

rpa.android.deviceDetailInfo

获取手机详细信息

rpa.android.deviceSerial

获取手机序列号

rpa.android.closeConnect

关闭手机连接

rpa.android.startApp

启动APP

rpa.android.closeApp

关闭APP

rpa.android.restart

重启手机

rpa.android.close

关闭手机

rpa.android.getElement

获取元素对象

rpa.android.touch

点击元素

rpa.android.input

输入信息至元素

rpa.android.clear

清除元素内容

rpa.android.text

获取元素文本

rpa.android.touchSlide

触摸滑动

rpa.android.clickKey

键盘按键

rpa.android.capture

屏幕截图

rpa.android.clickScreen

点击屏幕

rpa.android.getClipboardContent

获取剪切板内容

rpa.android.setClipboardContent

设置剪切板内容

rpa.android.getScreenDirection

获取屏幕方向

rpa.android.getUITree

获取UI树

rpa.android.pushFile

推送文件至手机

rpa.android.getFile

获取文件从手机


rpa.commonfile.openFile

打开普通文件

rpa.commonfile.read

读取文件

rpa.commonfile.write

写入字符串到文件对象中

rpa.commonfile.addwrite

不改变原文件文本,追加文本写入文件

rpa.commonfile.close

关闭文件

rpa.commonfile.getName

获取文件名称

rpa.commonfile.getExtension

获取文件扩展名

rpa.commonfile.dirname

获取文件路径

rpa.commonfile.getsize

获取文件大小

rpa.commonfile.getdirsize

获取文件夹大小

rpa.commonfile.copy

复制文件并粘贴到另一目录