devhelmkit 0.1.0__tar.gz

devhelmkit-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

devhelmkit-0.1.0/MANIFEST.in

@@ -0,0 +1,18 @@
+# sdist 包含清单
+# 源码分发包只包含运行时必需文件，排除 tests/docs/.github
+
+include LICENSE
+include README.md
+include pyproject.toml
+
+# 运行时包源码
+recursive-include assets *.so
+
+# 排除测试、文档、CI 配置
+recursive-exclude tests *
+recursive-exclude docs *
+recursive-exclude .github *
+exclude .gitignore
+exclude *.egg-info
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]

devhelmkit-0.1.0/PKG-INFO

@@ -0,0 +1,411 @@
+Metadata-Version: 2.4
+Name: devhelmkit
+Version: 0.1.0
+Summary: 跨平台 UI 自动化框架，当前聚焦 HarmonyOS
+Author: devhelmkit contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/yabi-zzh/devhelmkit
+Project-URL: Repository, https://github.com/yabi-zzh/devhelmkit
+Project-URL: Documentation, https://github.com/yabi-zzh/devhelmkit/tree/main/docs
+Project-URL: Issues, https://github.com/yabi-zzh/devhelmkit/issues
+Keywords: harmonyos,uiautomator,ui-automation,testing,hypium
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Pillow>=9.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Provides-Extra: webview
+Requires-Dist: selenium>=4.0; extra == "webview"
+Dynamic: license-file
+
+# devhelmkit
+
+跨平台 UI 自动化框架，当前聚焦 HarmonyOS。
+
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org)
+[![Status](https://img.shields.io/badge/status-alpha-orange.svg)](#)
+
+## 简介
+
+devhelmkit 提供鸿蒙端 UI 自动化测试能力，通过 `hdc` 直连设备，无需依赖测试框架即可独立运行。
+
+核心目标：
+
+- **简洁 API**：`d(text="登录").click()`、`d.app_start()`、`d.dump_hierarchy()`
+- **直连设备**：仅通过 `hdc` 通信，不依赖测试框架
+- **跨平台抽象**：`BaseDriver` 契约层 + 平台具体实现，当前鸿蒙完整可用，Android 预留接口
+- **保留高级能力**：鼠标、触控笔、指关节、触控板、多指手势等鸿蒙特性操作
+
+## 特性
+
+- 选择器链路：`d(text="xx")` / `d(id="xx")` / `d.xpath("//Text")`
+- 控件操作：点击、长按、输入、拖拽、滑动、属性查询
+- 设备控制：亮屏/息屏、解锁、按键、旋转、截图
+- 应用管理：启动、停止、安装、卸载
+- 高级手势：鼠标全套操作、触控笔（含压力）、指关节敲击、多指手势
+- 触控板：多指滑动、滑动后停顿
+- 事件监听：Toast 监听、UI 事件（对话框/窗口/组件事件）
+- webview 自动化：通过 chromedriver + selenium 测试应用内 web 页面
+- 双查找后端：uitest（设备端 RPC）+ uitree（本地 layout 解析）
+- 资源管理：socket/端口转发自动清理，可选停止设备端守护进程
+- 跨平台：支持 Windows / Linux / macOS，hdc 路径可配置
+
+## 安装
+
+### 前置条件
+
+- **Python 3.8+**（支持 Windows / Linux / macOS）
+- **HarmonyOS 设备**：已开启开发者模式与 USB 调试
+- **hdc 命令行工具**：HarmonyOS Device Connector，用于与设备通信
+
+#### 安装 hdc
+
+hdc 随 HarmonyOS SDK 一起发布，获取方式：
+
+1. 下载 [HarmonyOS SDK](https://developer.huawei.com/consumer/cn/download/)（选择 Command Line Tools for Windows/Linux/macOS）
+2. 解压后，hdc 位于 `sdk/<version>/toolchains/` 目录下
+3. 将该目录加入系统 `PATH` 环境变量
+4. 验证安装：
+
+```bash
+hdc -v
+# HarmonyOS Device Connector vX.X.X
+```
+
+连接设备后验证：
+
+```bash
+hdc list targets
+# FMR0223824042727
+```
+
+### 安装 devhelmkit
+
+#### 方式一：pip 安装（推荐）
+
+```bash
+pip install devhelmkit
+```
+
+#### 方式二：从源码安装
+
+```bash
+git clone https://github.com/devhelmkit/devhelmkit.git
+cd devhelmkit
+pip install -e .
+```
+
+### 依赖
+
+- `Pillow>=9.0.0`（截图功能）
+
+## 快速上手
+
+```python
+import devhelmkit
+
+# 自动发现设备并连接
+d = devhelmkit.connect()
+
+# 启动应用
+d.app_start("com.huawei.hmos.settings")
+
+# 控件查找与操作
+d(text="搜索").click()
+d(className="TextInput").input_text("devhelmkit")
+
+# 截图
+d.screenshot().save("screen.png")
+
+# 转储 UI 树
+xml = d.dump_hierarchy()
+
+# 关闭连接，释放 socket 与端口转发
+d.close()
+```
+
+### 资源释放
+
+推荐使用 `with` 语句或 `try/finally` 确保资源释放，无论是否异常都会
+自动关闭 socket、清理 hdc 端口转发：
+
+```python
+import devhelmkit
+
+with devhelmkit.connect() as d:
+    d.app_start("com.huawei.hmos.settings")
+    d(text="搜索").click()
+# 退出 with 块时自动调用 close()
+```
+
+如需在关闭时同时停止设备端 uitest 守护进程（默认保留以便复用）：
+
+```python
+# 方式一：运行时指定
+d.close(stop_daemon=True)
+
+# 方式二：通过配置项
+from devhelmkit.harmony.config import HarmonyDriverConfig
+
+config = HarmonyDriverConfig(stop_daemon_on_close=True)
+d = devhelmkit.connect(config=config)
+```
+
+### 运行示例
+
+仓库内置完整 demo，演示连接 → 操作 → 释放全流程：
+
+```bash
+# 基础示例（保留设备端守护进程）
+python examples/quickstart.py
+
+# 完整示例（退出时停止设备端守护进程）
+python examples/quickstart.py --stop-daemon
+
+# 指定设备序列号
+python examples/quickstart.py FMR0223824042727
+```
+
+### 指定设备
+
+```python
+# 多设备时指定序列号
+d = devhelmkit.connect(serial="1234567890ABCDEF")
+
+# 显式指定平台
+d = devhelmkit.connect(platform="harmony")
+```
+
+### 指定 hdc 路径
+
+当 hdc 未加入系统 PATH，或需指定特定版本时：
+
+```python
+import devhelmkit
+from devhelmkit.harmony.device.hdc import HdcDevice
+
+# 全局设置 hdc 路径（影响后续所有连接）
+HdcDevice.set_hdc_path("/path/to/hdc")
+
+d = devhelmkit.connect()
+```
+
+或通过配置项：
+
+```python
+from devhelmkit.harmony.config import HarmonyDriverConfig
+
+config = HarmonyDriverConfig(hdc_path="/path/to/hdc")
+d = devhelmkit.connect(config=config)
+```
+
+## API 示例
+
+### 控件操作
+
+```python
+# 等待控件出现
+d(text="登录").wait(timeout=10)
+
+# 输入文本
+d(id="username").input_text("admin")
+
+# 清空文本
+d(id="username").clear_text()
+
+# 长按
+d(text="项目").long_click()
+
+# 拖拽
+d(text="A").drag_to(text="B")
+
+# 获取属性
+print(d(text="标题").info)
+```
+
+### 手势
+
+```python
+# 滑动
+d.swipe(100, 500, 100, 100)
+
+# 多指手势
+d.two_finger_swipe((0, 400), (200, 400), (880, 400), (680, 400))
+
+# 自定义手势
+from devhelmkit.model.input import GestureAction
+
+g = GestureAction()
+g.add_step("move", 100, 200)
+g.add_step("move", 200, 300)
+d.inject_gesture(g, speed=1000)
+```
+
+### 鼠标操作
+
+```python
+# 鼠标点击（左键）
+d.mouse_click((500, 500))
+
+# 鼠标右键
+d.mouse_click((500, 500), button_id=1)
+
+# 鼠标滚轮
+d.mouse_scroll((500, 500), "down", steps=3)
+
+# 鼠标拖拽
+d.mouse_drag((100, 100), (300, 300))
+```
+
+### 触控笔
+
+```python
+# 触控笔点击
+d.pen_click((500, 500))
+
+# 触控笔长按（带压力）
+d.pen_long_click((500, 500), pressure=0.8)
+
+# 触控笔方向滑动
+d.pen_swipe("UP", distance=60)
+```
+
+### 事件监听
+
+```python
+# Toast 监听
+d.start_listen_toast()
+d(text="提交").click()
+print("Toast:", d.get_latest_toast(timeout=3))
+
+# 检查 Toast
+if d.check_toast("保存成功", fuzzy="contains"):
+    print("操作成功")
+```
+
+### 设备控制
+
+```python
+# 亮屏/息屏
+d.wake_up_display()
+d.close_display()
+
+# 按键
+d.press_keycode(23)  # 确认键
+
+# 截图
+img = d.screenshot()
+img.save("capture.png")
+
+# 安装应用
+d.app_install("/path/to/app.hap")
+```
+
+### webview 自动化
+
+webview 测试需要安装可选依赖 `selenium` 与 chromedriver：
+
+```bash
+# 安装 webview 可选依赖
+pip install devhelmkit[webview]
+```
+
+chromedriver 需按设备 webview 版本下载，放置于目录：
+
+```text
+chromedriver_search_path/
+├── chromedriver_114/
+│   ├── chromedriver.exe      # Windows
+│   ├── chromedriver          # Linux
+│   └── chromedriver.mac      # macOS
+└── chromedriver_132/
+    ├── chromedriver.exe
+    ├── chromedriver
+    └── chromedriver.mac
+```
+
+使用方式：
+
+```python
+# 连接应用 webview
+wv = d.webview(
+    "com.huawei.hmos.browser",
+    chromedriver_search_path="/path/to/chromedriver_search_path"
+)
+
+# 通过 selenium webdriver 操作页面
+wv.driver.get("https://www.baidu.com")
+wv.driver.find_element("id", "kw").send_keys("devhelmkit")
+
+# 释放资源（移除端口转发 + quit webdriver + 停止 chromedriver）
+wv.close()
+```
+
+## 架构
+
+```text
+devhelmkit/
+├── core/          # 跨平台契约层（BaseDriver / BaseComponent / SelectorSpec）
+├── model/         # 纯数据类型（Rect / KeyCode / GestureAction / ...）
+├── harmony/       # HarmonyOS 平台实现
+│   ├── driver.py      # 平台驱动门面
+│   ├── device/        # hdc 命令封装与 RPC 通道
+│   ├── rpc/           # bin 模式 RPC 协议与远程对象管理
+│   ├── finder/        # 控件查找（uitest + uitree 双后端）
+│   ├── agent/         # 设备端 uitest 守护进程管理
+│   └── webview/       # webview 自动化（chromedriver + selenium）
+├── android/       # Android 平台预留（阶段四）
+├── utils/         # 通用工具（日志/重试/超时）
+├── assets/so/     # 设备端 agent.so 资产
+├── examples/      # 示例代码（quickstart.py）
+└── tests/         # 单元测试与集成测试
+```
+
+详细设计文档见 [docs/design/](docs/design/README.md)。
+
+## 开发
+
+### 运行测试
+
+```bash
+# 离线单元测试（无需设备）
+python tests/test_api_offline.py
+
+# 真机集成测试
+python tests/test_device_info.py <设备SN>
+```
+
+### 代码结构约定
+
+- `core/` 禁止依赖平台实现层
+- `model/` 无内部依赖，可跨平台复用
+- 平台实现层内部按 `device/`、`rpc/`、`finder/` 分包
+- RPC 层不认识 UI 对象，设备通道不理解控件定位
+
+## 贡献
+
+欢迎提交 Issue 与 Pull Request。提交前请确保：
+
+1. 代码通过离线测试：`python tests/test_api_offline.py`
+2. 遵循现有代码风格与分层约束
+3. 新增 API 需同步更新 [API 接口文档](docs/api_reference.md)
+
+## 许可证
+
+[Apache License 2.0](LICENSE)