Device module¶

SyberOS设备类，继承自Events基类，负责驱动设备模拟事件与获取布局信息。

class Device(host: Optional[str] = None, port: Optional[int] = None, syslog_enable: bool = False, _main: bool = True)¶

基类：uitestrunner_syberos.Events.Events

Device初始化，获取设备初始信息，创建相关子线程与子进程等。

参数

host – 设备通信IP地址(默认为192.168.100.100)
port – 设备通信端口(默认为10008，一般不需修改)
syslog_enable – 是否开启syslog(默认为关闭状态，不可中途修改)
_main – 主进程标识符(禁止用户使用)

变量

xml_string – 储存最后一次的设备UI布局信息xml字符串
default_timeout – 框架整体的默认超时时间
control_host_type – 控制端平台类型，枚举类型Controller

delete_watcher(name: str) → None¶

删除一个已有的监视者。

参数: name – 监视者标识名称
返回: 无

display_height() → int¶

获取当前设备屏幕高度。

返回: 屏幕高度像素数int值

display_width() → int¶

获取当前设备屏幕宽度。

返回: 屏幕宽度像素数int值

find_item_by_xpath(sopid: str, xpath: str) → uitestrunner_syberos.Item.Item¶

获取元素控件实例化对象。

参数

sopid – 设备应用的sopid
xpath – xpath值字符串

返回

Item对象

find_item_by_xpath_key(sopid: str, xpath_key: str) → uitestrunner_syberos.Item.Item¶

获取元素控件实例化对象。

参数

sopid – 设备应用的sopid
xpath_key – xpath信息ini文件中的键

返回

Item对象

get_environment(key: str, module: str = 'General') → str¶

获取支撑脚本执行的环境变量，保存在脚本目录下的environment.ini文件中。

参数

key – 键
module – 模块名称，默认值：General

返回

环境变量值

get_framework_info() → dict¶

获取设备内的测试框架信息。

返回: 字典形式信息键值对，可能为空

get_text_item_list(item: uitestrunner_syberos.Item.Item, rotation: Optional[int] = None) → List[uitestrunner_syberos.TextItemFromOcr.TextItemFromOcr]¶

根据元素控件的截图进行OCR图像识别获取文本元素实例化对象列表。

参数

item – 传入的元素控件
rotation – 元素的旋转角度，默认自动获取

返回

TextItemFromOcr对象列表

get_text_item_list_full_screen(rotation: Optional[int] = None) → List[uitestrunner_syberos.TextItemFromOcr.TextItemFromOcr]¶

全屏截图进行OCR图像识别获取文本元素实例化对象列表。

参数: rotation – 元素的旋转角度，默认自动获取
返回: TextItemFromOcr对象列表

get_topmost_info() → dict¶

获取当前显示顶层的应用信息。

返回: 字典格式的应用信息

get_xpath(sop_id: str, key: str) → str¶

通过sopid与key在xpath信息ini文件中查询xpath值。

参数

sop_id – 设备应用的sopid
key – 键

返回

xpath值字符串

grab_image_to_base64(cx: int, cy: int, width: int, height: int, rotation: int = 0, scale: float = 1) → str¶

获取指定位置、大小及状态的范围截图。

参数

cx – 范围旋转缩放前的中心点横坐标
cy – 范围旋转缩放前的中心点纵坐标
width – 范围旋转缩放前的宽度
height – 范围旋转缩放前的高度
rotation – 顺时针旋转角度
scale – 缩放系数

返回

截图的base64形态

has_environment(key: str, module: str = 'General') → bool¶

获取指定环境变量是否存在。

参数

key – 键
module – 模块名称，默认值：General

返回

os_version() → str¶

获取SyberOS系统版本。

返回: 系统版本字符串

pause_watcher(name: str) → None¶

暂停一个已有的监视者。

参数: name – 监视者标识名称
返回: 无

refresh_layout() → None¶

刷新当前设备的UI布局信息。

返回: 无

screenshot(path: Optional[str] = None) → str¶

获取设备当前屏幕截图。

参数: path – 截图存放路径(默认为前脚本目录下的screenshots文件夹或者用户通过Device.set_screenshots_path(path: str)接口设置的路径)
返回: 截图名称

serial_number() → str¶

获取当前设备硬件序列号。

返回: 序列号字符串

set_default_timeout(timeout: int) → None¶

设置当前框架默认超时时间(默认为30秒)。

参数: timeout – 超时时间(单位:秒)
返回: 无

set_screenshots_path(path: str) → None¶

设置存放系统截图的文件夹路径(默认为当前脚本目录下的screenshots文件夹)。

参数: path – 文件夹路径
返回: 无

set_syslog_output(is_enable: bool, keyword: str = '') → None¶

设置设备log输出(打印至控制端标准输出stdout)开关。

参数

is_enable – log输出开关, bool值, True为开启，False为关闭
keyword – 筛选关键字(筛选最小单位行)，如果为空则全部打印

返回

无

set_syslog_save_start(save_path: str = '/home/runner/work/uitestrunner_syberos/uitestrunner_syberos/src/syslog/', save_name: Optional[str] = None, save_keyword: str = '') → None¶

设置保存设备log开始。

参数

save_path – 保存文件路径，指定一个文件夹的相对或绝对路径，默认在当前脚本目录下的syslog文件夹
save_name – log文件保存名称，默认以时间戳命名
save_keyword – 筛选关键字(筛选最小单位行)，如果为空则全部保存

返回

无

set_syslog_save_stop() → None¶

停止保存设备log，如果不调用此方法则会一直保存至进程结束。

返回: 无

set_xpath_list(path: str) → None¶

设置存放xpath信息的ini文件路径(默认为当前脚本目录下的xpath_list.ini)。

参数: path – 文件路径
返回: 无

start_watcher(name: str) → None¶

启动一个已有的监视者。

参数: name – 监视者标识名称
返回: 无

support_rotate_screen() → bool¶

读取配置文件获取设备是否支持旋转屏幕。

返回: 支持返回True，否则为False

syslog_output() → bool¶

获取设备log输出开关状态。

返回: log输出开关, bool值, True为开启，False为关闭

syslog_output_keyword() → str¶

查询当前设备log输出时的筛选关键字。

返回: 关键字字符串

syslog_save() → bool¶

获取当前是否正在保存设备log。

返回: bool值，True为正在保存中，False则相反

syslog_save_keyword() → str¶

获取当前设备log保存筛选关键字。

返回: 关键字字符串

syslog_save_name() → str¶

获取当前设备log保存名称。

返回: 名称字符串

syslog_save_path() → str¶

获取当前设备log保存目录。

返回: 路径字符串

watcher(name: str) → uitestrunner_syberos.Watcher.Watcher¶

创建一个待启动的监视者，可以根据指定条件作出相应反应。

参数: name – 标识名称，不可重复
返回: 返回一个实例化的Watcher对象