replaykit.py

Replaykit Python SDK 是对 replaykit的 Python 代码封装。 replaykit 可以在 Windows 7+, MacOS Mavericks+ 和 Linux x64 上运行，同样本 Python SDK 也是跨平台的。

replaykit 是 Appetizer 实现多设备控制和录制重放功能的核心驱动, 对所有 Android 设备提供以下功能：

• 从单台设备录制屏幕触碰事件，在多台设备上重放 (需要屏幕横宽比一致)
• 同时控制多台设备 (例如, 运行一个 shell 命令，安装 apk 等)
• 将一台设备的屏幕触碰事件，镜像操作到多台设备上 (需要屏幕横宽比一致)

安装要求

• 下载 replaykit
• 安装 Android SDK 自带的 adb 命令行工具，确保 adb 的路径在PATH环境变量中
• 将需要调试的设备通过 USB 连接到开发机，并开启 ADB 调试（设置->开发者选项）。确保命令行执行adb devices可以看到连接的设备

安装

通过 pip支持 Python 2.7, 3.x

pip install appetizer

使用

所有的 SDK API 都通过 Python 标准的 docstring 提供详细的功能描述、参数类型、返回值类型等文档内容。开始使用前首先需要初始化一个 Appetizer 对象，后继所有的功能由这个对象提供。初始化需要提供replaykit的路径，如下：

from appetizer import Appetizer
appetizer = Appetizer(toolkit='path/to/the/toolkit/executable`) # e.g., './replaykit/linux/appetizer'

多设备控制

Appetizer 可以同时在多个设备上执行同一个命令，类似一个 adb 的多机版本:

# 列举所有已经连接的可以使用的设备
print (appetizer.devices.list())
# 获取一个设备的屏幕截图
appetizer.devices.take_screenshot("path/to/save/jpg/file", "serial_number")
# 安装APK文件到多个设备
appetizer.devices.control(["serialno1", "serialno2"], 'install', ['path/to/APK/file'])
# 启动一个APP
appetizer.devices.control(["serialno1", "serialno2"], 'launch_pkg', ['com.example.app'])
# 在多个设备上同时执行一个shell命令并获取返回信息
print(appetizer.devices.control(["serialno1", "serialno2"], 'shell', ['ls | grep system'])
# 镜像控制：将一个设备上的触摸屏输入实时投射到多个从属设备上
task = appetizer.devices.mirror("master_serialno", ["slave_serialno1", "slave_serialno2"])
# task对象代表了正在执行的镜像控制任务
time.sleep(5)
task.stop()

Trace 管理

Trace 管理功能能够录制并重放触摸屏输入事件

# 从一个设备录制触屏输入
record_task = appetizer.trace.record("path/to/trace/file", "device_serial_number")
time.sleep(10)
record_task.stop()
# 向多个设备重放录制的触屏输入trace，要求多个设备与原设备有同样的纵宽比
appetizer.trace.replay("path/to/trace/file", ['serialno1', 'serialno2'])
# 获取trace的信息，例如长度、纵宽比等
print(appetizer.trace.get_info("path/to/trace/file"))

ADB server 控制

ADB 是 Appetizer 与多个设备通讯的桥梁。adb 命令行工具必须正确安装，并且 adb server 必须正常运行在开发机上。以下代码段展示了如何用本 Python SDK 控制本机的 adb server:

# 检测本机以及安装的adb命令行工具（通过PATH环境变量）
print(appetizer.adb.detect_adb())
# 启动本机的 adb server
appetizer.adb.start_server()
# 停止本机的 adb server
appetizer.adb.kill_server()
# 检查本机adb server的运行情况
print(appetizer.adb.check_server())