Python自动化Clicknium指南1

Clicknium 是一个Python UI自动化库，主要用来自动化Windows桌面应用和网页应用。由于Clicknium没中文文档， 本文将系统的介绍一下Clicknium的使用方法。

1、基本概念

Clicknium通过录制鼠标点击UI元素，自动生成Locator，其中存储了该UI元素的各种属性，使Clicknium可以通过locator重新定位到对应的UI元素。 定位到UI元素后，Clicknium提供了各种常见的操作UI的方法，比如输入（set_text）、鼠标点击（Click）等，就能轻松完成UI自动化脚本。

Clicknium开发套件

Clicknium Python SDK是Clicknium的自动化核心， 围绕这一核心，Clicknium还提供了一系列插件协助开发自动化脚本：

• Clicknium VS Code 插件：管理、调试locator，提供Python代码补全和智能提示。

• Clicknium 浏览器插件：加强网页自动化能力，支持Chrome、Firefox、Edge、Brave、Vivaldi。

• Clicknium Recorder：支持录制UI元素，生成locator。

Clicknium Python SDK 可通过pip install clicknium安装。 在VS Code 中搜索Clicknium安装拓展后，可以在拓展中管理Clicknium的各种插件和SDK的安装和升级。

2. 开发环境配置

需在Windows环境下：

在VS Code 扩展中搜索Clicknium并安装：

在Clicknium explorer中安装Python module和需要的插件：

​Python module也可通过：pip install clicknium安装。 安装较慢的同学，可以将pypi切换为清华源

3.自动化脚本开发流程

3.1 sample脚本

首先看一下示例的sample。打开VS Code，Ctrl+shift+P输入Clicknium: Sample 然后选择一个新建一个空目录用来存放sample project。

这时候我们得到了下面的sample project，按F5运行，Ctrl+F5调试。

sample project目录结构：

/.locator locator信息

/.locator/sample_img是locator的快照

/.locator/sample.cnstore是locator store里面存放这locator的属性

代码分析：

• 第一部分：安装浏览器插件

    if cc.edge.extension.install_or_update():
      print("Please open edge browser to enable clicknium extension, then run sample again.")
      

很好理解自动安装edge浏览器的插件。自动化浏览器需要安装对应的浏览器插件。

• 第二部分：网页自动化，自动打开浏览器，进入bing搜索，在输入框中输入clicknium并点击搜索按钮。

    tab = cc.edge.open("https://www.bing.com/")
    tab.find_element(locator.sample.bing.search_sb_form_q).set_text('clicknium')
    tab.find_element(locator.sample.bing.svg).click()
    sleep(3)
    tab.close()

第一行：利用clicknium调用edge浏览器打开bing首页，返回对应浏览器tab。

第二行：在tab内调用find_element,在参数中传入输入框locator，调用set_text API传入文本信息。

第三行：在tab内调用find_element,在参数中传入搜索按钮的locator，调用click函数。

第四、五行：等待3秒钟，关闭对应的tab。

通过这部分代码，可以大致理解clicknium的逻辑。 Clicknium提供了诸如find_element等函数，接受locator参数获取到UI元素。同时提供了一些操作UI的通用方法，比如set_text, click等来模拟人工操作。

• 第三部分：Windows桌面端自动化。打开记事本(notepad),并输入clicknium

    process = subprocess.Popen("notepad")
    ui(locator.sample.notepad.document_15).set_text("clicknium")

接口与网页端自动化类似。