Events module¶
Device的基类,封装了绝大部分对设备的模拟操作事件。
- class Events(d)¶
基类:
object
模拟事件类。
- app_is_running(sopid: str, syberdroid: bool = False) bool ¶
查询应用是否正在运行。
- 参数
sopid – 应用sopid
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
应用正在运行返回True,否则为False
- back(delay: int = 0) bool ¶
点击设备返回按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- backspace(delay: int = 0) bool ¶
点击退格按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- clear_app_data(sopid: str, syberdroid: bool = False) bool ¶
清除应用数据。
- 参数
sopid – 应用sopid
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
成功返回True,否则为False
- click(point: uitestrunner_syberos.DataStruct.Point, delay: int = 0) bool ¶
点击屏幕。
- 参数
point – 坐标点类Point对象
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- close(sopid: str, uiappid: str, syberdroid: bool = False) bool ¶
关闭应用。
- 参数
sopid – 应用sopid
uiappid – 应用uiappid
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
成功返回True,否则为False
- connect_open_wifi(ssid: str, timeout: Optional[int] = None) bool ¶
连接设备至开放WiFi网络。
- 参数
ssid – WiFi网络名称
timeout – 超时时间(单位:秒),默认为框架超时时间
- 返回
成功返回True,否则为False
- copy() bool ¶
复制,模拟键盘的Ctrl+C事件
- 返回
成功返回True,否则为False
- cut() bool ¶
剪切,模拟键盘的Ctrl+X事件
- 返回
成功返回True,否则为False
- dir_copy(source_path: str, target_path: str) bool ¶
复制设备中指定文件夹。
- 参数
source_path – 设备中原始文件夹路径
target_path – 设备中目标文件夹路径
- 返回
成功返回True,否则为False
- dir_exist(dir_path: str) bool ¶
判断设备中指定文件夹是否存在。
- 参数
dir_path – 设备中文件夹路径
- 返回
存在返回True,否则为False
- dir_list(dir_path: str) List[uitestrunner_syberos.DataStruct.FileInfo] ¶
获取设备中指定文件夹内的目录信息。
- 参数
dir_path – 设备中指定路径
- 返回
FileInfo列表
- dir_move(source_path: str, target_path: str) bool ¶
移动/重命名设备中指定文件夹。
- 参数
source_path – 设备中原始文件夹路径/名称
target_path – 设备中目标文件夹路径/名称
- 返回
成功返回True,否则为False
- dir_remove(dir_path: str) bool ¶
删除设备中指定文件夹。
- 参数
dir_path – 设备中文件夹路径
- 返回
成功返回True,否则为False
- down() bool ¶
方向键-下
- 返回
成功返回True,否则为False
- drag(p1: uitestrunner_syberos.DataStruct.Point, p2: uitestrunner_syberos.DataStruct.Point, delay: int = 1) bool ¶
拖动。
- 参数
p1 – 坐标点类Point对象,起始点
p2 – 坐标点类Point对象,终点
delay – 起始点长按时间,默认1秒
- 返回
成功返回True,否则为False
- enter() bool ¶
回车
- 返回
成功返回True,否则为False
- file_copy(source_path: str, target_path: str) bool ¶
复制设备中指定文件。
- 参数
source_path – 设备中原始文件路径
target_path – 设备中目标文件路径
- 返回
成功返回True,否则为False
- file_exist(file_path: str) bool ¶
判断设备中指定文件是否存在。
- 参数
file_path – 设备中文件路径
- 返回
存在返回True,否则为False
- file_move(source_path: str, target_path: str) bool ¶
移动/重命名设备中指定文件。
- 参数
source_path – 设备中原始文件路径/名称
target_path – 设备中目标文件路径/名称
- 返回
成功返回True,否则为False
- file_remove(file_path: str) bool ¶
删除设备中指定文件。
- 参数
file_path – 设备中文件路径
- 返回
成功返回True,否则为False
- get_audio_input_port() uitestrunner_syberos.DataStruct.AudioManagerPortType ¶
获取音频输出入端口。
- 返回
AudioManagerPortType枚举值
- get_audio_output_port() uitestrunner_syberos.DataStruct.AudioManagerPortType ¶
获取音频输出端口。
- 返回
AudioManagerPortType枚举值
- get_auto_brightness() bool ¶
获取自动系统屏幕亮度状态。
- 返回
开关状态
- get_blank_timeout() int ¶
获取设备由暗屏状态至灭屏状态的超时时间。
- 返回
时间(单位:秒)
- get_brightness() int ¶
获取系统当前屏幕亮度值。
- 返回
亮度值
- get_dim_timeout() int ¶
获取设备由亮屏状态至暗屏状态的超时时间。
- 返回
时间(单位:秒)
- get_display_state() uitestrunner_syberos.DataStruct.DisplayState ¶
获取设备当前的屏幕状态。
- 返回
DisplayState枚举值
- get_lock_state() uitestrunner_syberos.DataStruct.LockState ¶
获取设备锁屏当前的锁定状态。
- 返回
LockState枚举值
- get_panel_state() bool ¶
获取设备快捷面板展开状态。
- 返回
展开返回True,否则为False
- get_rotation_allowed() bool ¶
获取设备自动旋转屏幕开关状态。
- 返回
开关状态,True为开启,False为关闭
- get_screen_orientation() uitestrunner_syberos.DataStruct.ScreenOrientation ¶
获取设备屏幕方向。
- 返回
ScreenOrientation枚举值
- get_system_auto_time() bool ¶
获取设备自动获取时间功能的开关状态。
- 返回
开启返回True,否则为False
- get_system_stat() uitestrunner_syberos.DataStruct.SystemStat ¶
获取设备负载及电源状态相关信息。
- 返回
SystemStat,系统状态数据对象
- get_volume(role_type: uitestrunner_syberos.DataStruct.AudioManagerRoleType) int ¶
获取指定角色的当前音量值。
- 参数
role_type – AudioManagerRoleType枚举值
- 返回
音量值
- get_volume_active_role() uitestrunner_syberos.DataStruct.AudioManagerRoleType ¶
获取当前活跃的音量角色。
- 返回
AudioManagerRoleType枚举值
- get_volume_by_step(role_type: uitestrunner_syberos.DataStruct.AudioManagerRoleType) int ¶
获取指定角色的当前音量设置步数。
- 参数
role_type – AudioManagerRoleType枚举值
- 返回
步数
- get_volume_steps() int ¶
获取音量设置总步数。
- 返回
步数
- go_home(timeout: Optional[int] = None) bool ¶
去到桌面。
- 参数
timeout – 超时时间(单位:秒),默认为框架超时时间
- 返回
成功返回True,否则为False
- home(delay: int = 0) bool ¶
点击设备主屏幕按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- install(file_path: str, syberdroid: bool = False) bool ¶
安装应用。
- 参数
file_path – 控制端.sop(.apk)文件的路径
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
成功返回True,否则为False
- is_installed(sopid: str, syberdroid: bool = False) bool ¶
判断指定应用是否已经安装。
- 参数
sopid – 指定应用的sopid
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
已安装返回True,否则为False
- is_network_available() bool ¶
获取当前网络状态是否可用。
- 返回
网络可用状态
- is_topmost(sopid: str, syberdroid: bool = False) bool ¶
判断指定应用是否显示在屏幕最上层。
- 参数
sopid – 指定应用的sopid
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
在最上层返回True,否则为False
- is_uninstallable(sopid: str) bool ¶
判断指定应用是否允许卸载。
- 参数
sopid – 指定应用的sopid
- 返回
允许卸载返回True,否则为False
- latest_toast() str ¶
获取系统最新一次弹出的toast文本(设备会自动清除已被读取或覆盖的toast信息)
- 返回
文本字符串
- launch(sopid: str, uiappid: str, timeout: Optional[int] = None, syberdroid: bool = False) bool ¶
启动应用。
- 参数
sopid – 应用sopid
uiappid – 应用uiappid
timeout – 超时时间(单位:秒),默认为框架超时时间
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
成功返回True,否则为False
- left() bool ¶
方向键-左
- 返回
成功返回True,否则为False
- lock() bool ¶
将设备锁屏设置为锁定状态。
- 返回
成功返回True,否则为False
- max_brightness() int ¶
获取系统最大屏幕亮度值。
- 返回
亮度值
点击设备菜单按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- mkdir(dir_path: str) bool ¶
在设备中创建一个文件夹。
- 参数
dir_path – 设备中要创建的文件夹路径
- 返回
成功返回True,否则为False
- multi_click(points: List[uitestrunner_syberos.DataStruct.Point], delay: int = 0) bool ¶
多指点击屏幕。
- 参数
points – 坐标点类Point对象列表
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- multi_swipe(points1: List[uitestrunner_syberos.DataStruct.Point], points2: List[uitestrunner_syberos.DataStruct.Point]) bool ¶
多指滑动屏幕。
- 参数
points1 – 坐标点类Point对象列表,起始点
points2 – 坐标点类Point对象列表,终点
- 返回
成功返回True,否则为False
- password_exists() bool ¶
查询设备是否存在锁屏密码。
- 返回
存在返回True,否则为False
- paste() bool ¶
粘贴,模拟键盘的Ctrl+V事件
- 返回
成功返回True,否则为False
- power(delay: int = 0) bool ¶
点击设备电源按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- recover_ambient_light_sensor() bool ¶
恢复环境光物理sensor的数据上报功能。
- 返回
成功返回True,否则为False
- recover_orientation_sensor() bool ¶
恢复设备方向物理sensor的数据上报功能。
- 返回
成功返回True,否则为False
- recover_proximity_sensor() bool ¶
恢复接近物理sensor的数据上报功能。
- 返回
成功返回True,否则为False
- right() bool ¶
方向键-右
- 返回
成功返回True,否则为False
- route_drag(pl: List[uitestrunner_syberos.DataStruct.Point], delay: int = 1) bool ¶
沿路径滑动屏幕。
- 参数
pl – 坐标点类Point对象列表,起始点->途经点1->…途经点n->终止点,至少两个点
delay – 起始点长按时间,默认1秒
- 返回
成功返回True,否则为False
- route_swipe(pl: List[uitestrunner_syberos.DataStruct.Point]) bool ¶
沿路径滑动屏幕。
- 参数
pl – 坐标点类Point对象列表,起始点->途经点1->…途经点n->终止点,至少两个点
- 返回
成功返回True,否则为False
- select_all() bool ¶
全选,模拟键盘的Ctrl+A事件
- 返回
成功返回True,否则为False
- send_ambient_light_event(lux: int) bool ¶
发送环境光sensor模拟事件(此接口会自动屏蔽物理sensor的数据上报)。
- 参数
lux – 亮度值
- 返回
成功返回True,否则为False
- send_orientation_event(orientation: uitestrunner_syberos.DataStruct.Orientation) bool ¶
发送设备方向sensor模拟事件(此接口会自动屏蔽物理sensor的数据上报)。
- 参数
orientation – Orientation枚举值
- 返回
成功返回True,否则为False
- send_proximity_event(within_proximity: bool) bool ¶
发送接近sensor模拟事件(此接口会自动屏蔽物理sensor的数据上报)。
- 参数
within_proximity – 时候接近
- 返回
成功返回True,否则为False
- set_audio_input_port(port_type: uitestrunner_syberos.DataStruct.AudioManagerPortType) bool ¶
设置音频输入端口。
- 参数
port_type – AudioManagerPortType枚举值
- 返回
成功返回True,否则为False
- set_audio_output_port(port_type: uitestrunner_syberos.DataStruct.AudioManagerPortType) bool ¶
设置音频输出端口。
- 参数
port_type – AudioManagerPortType枚举值
- 返回
成功返回True,否则为False
- set_auto_brightness(enable: bool) bool ¶
设置自动系统屏幕亮度。
- 参数
enable – 开关状态
- 返回
成功返回True,否则为False
- set_blank_timeout(timeout: int) bool ¶
设置设备由暗屏状态至灭屏状态的超时时间。
- 参数
timeout – 时间(单位:秒)
- 返回
成功返回True,否则为False
- set_brightness(brightness: int) bool ¶
设置系统屏幕亮度值。
- 参数
brightness – 亮度值
- 返回
成功返回True,否则为False
- set_dim_timeout(timeout: int) bool ¶
设置设备由亮屏状态至暗屏状态的超时时间。
- 参数
timeout – 时间(单位:秒)
- 返回
成功返回True,否则为False
- set_display_dim() bool ¶
设置设备屏幕状态为暗屏。
- 返回
成功返回True,否则为False
- set_display_off() bool ¶
设置设备屏幕状态为灭屏。
- 返回
成功返回True,否则为False
- set_display_on() bool ¶
设置设备屏幕状态为亮屏。
- 返回
成功返回True,否则为False
- set_panel_close() bool ¶
设置设备快捷面板为收起状态。
- 返回
成功返回True,否则为False
- set_panel_open() bool ¶
设置设备快捷面板为展开状态。
- 返回
成功返回True,否则为False
- set_password(password_type: uitestrunner_syberos.DataStruct.PasswordType, password: str) uitestrunner_syberos.DataStruct.AuthenError ¶
设置设备锁屏密码。
- 参数
password_type – 密码类型,PasswordType枚举值
password – 密码字符串。
简单密码为4位纯数字;
复杂密码为8-16位字符串,至少包含字母、数字、符号中的两种,不能包含3个及以上连续或相同的字母或数字;
图形密码为6位字母字符串,范围小写a-p,分别对应到4x4矩阵的个个点位。 :return: AuthenError枚举值
- set_rotation_allowed(allowed: bool = True) bool ¶
设置设备自动旋转屏幕开关状态。
- 参数
allowed – 开关状态,True为开启,False为关闭
- 返回
成功返回True,否则为False
- set_system_auto_time(state: bool) bool ¶
设置设备自动获取时间功能的开关状态。
- 参数
state – 开关状态,开启为True,关闭为False
- 返回
成功返回True,否则为False
- set_system_time(secs: int) bool ¶
设置设备系统时间。
- 参数
secs – unix时间戳(自1970年1月1日0点0分0秒至今的总秒数)
- 返回
成功返回True,否则为False
- set_volume(role_type: uitestrunner_syberos.DataStruct.AudioManagerRoleType, volume: int) bool ¶
设置指定角色的音量值。
- 参数
role_type – AudioManagerRoleType枚举值
volume – 要设置的音量值
- 返回
成功返回True,否则为False
- set_volume_by_step(role_type: uitestrunner_syberos.DataStruct.AudioManagerRoleType, step: int) bool ¶
设置指定角色的音量步数。
- 参数
role_type – AudioManagerRoleType枚举值
step – 要设置的音量步数
- 返回
成功返回True,否则为False
- shift_down() bool ¶
shift加方向键-下
- 返回
成功返回True,否则为False
- shift_left() bool ¶
shift加方向键-左
- 返回
成功返回True,否则为False
- shift_right() bool ¶
shift加方向键-右
- 返回
成功返回True,否则为False
- shift_up() bool ¶
shift加方向键-上
- 返回
成功返回True,否则为False
- submit_string(text: str) bool ¶
向当前拥有焦点的元素控件提交文本(模拟输入法事件)。
- 参数
text – 文本字符串
- 返回
成功返回True,否则为False
- swipe(p1: uitestrunner_syberos.DataStruct.Point, p2: uitestrunner_syberos.DataStruct.Point) bool ¶
滑动屏幕。
- 参数
p1 – 坐标点类Point对象,起始点
p2 – 坐标点类Point对象,终点
- 返回
成功返回True,否则为False
- system_time() int ¶
获取设备系统时间。
- 返回
unix时间戳(自1970年1月1日0点0分0秒至今的总秒数)
- uninstall(sopid: str, syberdroid: bool = False) bool ¶
卸载应用。
- 参数
sopid – 要卸载的应用sopid
syberdroid – 是否为安卓兼容应用,默认为否
- 返回
成功返回True,否则为False
- unlock() bool ¶
将设备锁屏设置为解锁状态。
- 返回
成功返回True,否则为False
- up() bool ¶
方向键-上
- 返回
成功返回True,否则为False
- upload_file(file_path: str, remote_path: str, timeout: Optional[int] = None) bool ¶
上传文件至设备。
- 参数
file_path – 控制端原文件路径
remote_path – 设备中目标路径
timeout – 超时时间(单位:秒),默认为框架超时时间
- 返回
成功返回True,否则为False
- volume_down(delay: int = 0) bool ¶
点击设备音量下按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False
- volume_up(delay: int = 0) bool ¶
点击设备音量上按键。
- 参数
delay – 点击延时时间(单位:毫秒),默认无延时
- 返回
成功返回True,否则为False