Python移動端錄屏庫
背景
日常移動端專項測試和自動化測試通常有一些場景如：Ui自動化的操作捕獲、App啟動耗時、視頻啟播耗時等，通常都有需要邊操作邊錄屏，而對於啟動耗時測試通常還需要質量較高且幀率穩定的視頻源（如果用stagesepx），本文將介紹雙端基於腳本化的錄屏解決方案，讓錄屏更好的和你的case結合
概述
它是一個python庫，更准確的說是一個錄屏的裝飾器，名為screcord，意為：screen + record，底層是對scrcpy和xrecord調用的極簡封裝
scrcpy和xrecord
因為screcord底層是對scrcpy和xrecord調用，故在正式介紹之前先梳理一下目前雙端現有的錄屏方案
安卓端
| 方案 | 自動化控制 | 兼容性 | 視頻源質量 |
|---|---|---|---|
| 自帶錄屏功能 | 難 | 差 | 較好 |
| 錄屏軟件 | 難 | 差 | 較差 |
screenrecord |
易 | 部分機型沒有 | 一般 |
| scrcpy | 易 | 好 | 可選 |
iOS端
| 方案 | 自動化控制 | 兼容性 | 視頻源質量 |
|---|---|---|---|
| 自帶錄屏功能 | 難 | 好 | 好 |
| 錄屏軟件 | 難 | 差 | 較差 |
| xrecord | 易 | 好 | 好 |
從以上的對比中可以看出：
原理
錄屏原理
當你正確安裝了scrcpy之后，只需要輸入如下命令，即可錄取指定設備的屏幕
scrcpy -s device --render-expired-frames -Nr ./demo.pm4
--render-expired-frames：盡可能最大幀率
-N：不再PC端展示
-r：錄制mp4/mkv文件
iOS端，下載xrecord並通過alias指定xrecord到對應的文件路徑
alias xrecord='./xrecord/bin/xrecord'
xrecord -q -i device -o ./demo.mp4 -f
-i, --id:
Device ID.
-o, --out:
Output File.
-f, --force:
Overwrite existing files.
-q, --quicktime:
Include QuickTime devices (necessary for iOS recording).
screcord的封裝原理
知道了scrcpy和xrecord的錄屏原理之后，就可以通過腳本封裝實現了，原理為：
- 通過
_cmd區分平台拼接錄屏命令行 - 在
record裝飾器中通過subprocess.Popen()啟動任務 - 當case執行完畢后再調用
proc.terminate()結束任務
# record裝飾器
def record(
platform: typing.Union[str],
device: typing.Union[str],
file_path: typing.Union[str, os.PathLike],
offset: typing.Tuple[int] = (1, 1),
pre_kill: typing.Union[bool] = True
):
"""record wrapper
platform: 'a', 'android', 'i', 'ios'
device: android device id or iOS udid
file_path: mp4 file path
offset: default (1, 1), mean of: before record sleep 1s and after record sleep 1s
pre_kill: before start whether kill or not, default True
"""
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
ofs = _update_offset(offset)
proc_name, cmd = _cmd(platform, device=device, fp=file_path)
p = start(proc_name, cmd, pre_kill)
try:
time.sleep(ofs[0])
func(*args, **kwargs)
time.sleep(ofs[1])
except Exception as e:
logger.error(e)
finally:
stop(proc_name, p)
return wrapper
return decorator
從_cmd()可以看到，它是通過platform來區分平台，再通過傳入的device, file_path拼接成為cmd
# _cmd，雙端錄屏命令行拼接方法
def _cmd(platform: str, **kwargs):
"""build cmd according to platform
"""
platform = platform.lower()
assert platform in ('a', 'android', 'i', 'ios'), f"platform should in ('a', 'android', 'i', 'ios')"
if platform in ('a', 'android'):
cmd = 'scrcpy -s "{device}" --render-expired-frames -Nr "{fp}"'.format(**kwargs)
proc_name = 'scrcpy'
else:
kwargs['xrecord'] = os.path.join(
os.path.dirname(screcord.__file__), 'xrecord'
)
cmd = '"{xrecord}" -q -i="{device}" -o="{fp}" -f'.format(**kwargs)
proc_name = 'xrecord'
logger.info(
f'\n===== CMD INFO ====='
f'\nplatform: {platform}'
f'\nname: {proc_name}'
f'\ncmd: {cmd}'
f'\n===================='
)
return proc_name, cmd
使用
首先，安裝screcord庫，要求py3.6+
pip3 install screcord
在case的方法上引入record這個裝飾器即可
record 方法入參格式如下：
- platform - 安卓/iOS可縮寫為：
a/i- file_path - 錄屏視頻的文件路徑，建議mp4格式
- offset - 偏移量，tuple類型，表示錄屏開始后，在case開始前等待幾秒，case執行完等待幾秒，通常用於case前后的等待緩沖期
- pre_kill - 在開始錄屏前是否需要kill掉已有的進程
from screcord import record
# 安卓端
device = "xxxxx"
video_fp = "./demo.mp4"
@record('android', device, video_fp, offset=(1, 2))
def start_app():
# your case
......
# iOS端
device = "xxxxx"
video_fp = "./demo.mp4"
@record('ios', self.device, video_fp, offset=(1, 1), pre_kill=False)
def start_app():
# your case
......
值得注意的是：
- iOS端已經將
xrecord納入screcord庫，故無需再單獨安裝 - 因為
scrcpy同意時刻只允許一個進程運行，所以安卓端建議將pre_kill置為True - iOS端建議將pre_kill置為False，因為每次啟動
xrecord時候都會重連設備，這會導致WDA服務中斷