IMPORTANT!!

这个仓库不再维护了，不建议在正式环境里使用。替代品：

• 跟这个库一样用subprocess实现的：miniadb
• 用socket实现的：adbutils

---

pyatool

English Version

python android toolkit 🔨

TL;DR

直接用我们提供的标准库，对android设备进行各种操作。

from pyatool import PYAToolkit

# 初始化
device = PYAToolkit('123456F')

# 1. 直接调用
package_list = device.show_package()
# 2. 或者 通过标准库（有自动补全，能够看到真实的方法实现）
package_list = device.std.show_package(toolkit=device)

# 具体返回内容与调用的方法实现有关
print(package_list)

• 完整API参见官方文档
• 更多使用例子参见demo.py

安装

请使用python3

pip install pyatool

目标

• 简化日常开发中对设备的操作
• 简洁的方法自定义与增删
• 无痛融入到现有框架内
• 减少重复工作，共享开发
• 降低使用门槛，让所有人都可以快速上手

还想要更多功能？

自定义函数

pyatool提供的自定义API让开发者能够很方便地自定义需要的方法并挂载到上面。事实上，它自带的方法也是通过这种方法开发的。

简单定制

例如，我们想自定义一个方法show_package用于展示已安装的包并做进一步处理：

# 自定义需要的函数，传入名称与对应的adb命令
PYAToolkit.bind_cmd(func_name='show_package', cmd='shell pm list package')

# 初始化
device_toolkit = PYAToolkit('123456F')

# 然后你就可以直接使用了：
result = device_toolkit.show_package()

# 它将执行下列命令并将执行结果返回到result：
adb -s 123456F shell pm list package

再也不用看到那些烦人的os与subprocess。pyatool也覆盖了多台设备同时连接时的状况，所有烦人的adb -s 123456F shell再见~

高级定制

当然，我们平时的需求不可能仅仅需要一条adb命令。pyatool也支持了更复杂的定制。例如我们需要一个函数，用于下载apk并安装到手机上：

def download_and_install(url, toolkit=None):
    resp = requests.get(url)
    if not resp.ok:
        return False
    with tempfile.NamedTemporaryFile('wb+', suffix='.apk', delete=False) as temp:
        temp.write(resp.content)
        temp.close()
        toolkit.adb.run(['install', '-r', '-d', '-t', temp.name])
        os.remove(temp.name)
    return True


PYAToolkit.bind_func(real_func=download_and_install)

其中，你的函数必须包含名为toolkit的可选参数，它将提供一些方法用于简化开发流程。例如，通过toolkit.device_id获取设备id、toolkit.adb.run用于执行adb命令。

# 之后就可以自由使用
device_toolkit = PYAToolkit('123456F')
device_toolkit.download_and_install()

单次开发

pyatool如此设计的目的是为了能够尽量减少重复工作。为了方便所有人加入开发，往内置库中添加方法非常容易。

如果你编写了一些好方法并希望将其合入pyatool标准库以方便后续使用，你只需要将你的方法添加到 extras.py 中，发起PR！

具体案例

在实际开发中，我们可能会频繁给设备安装apk；例如一旦设备连入电脑，自动给该设备安装apk。而结合whenconnect，只需要几行代码就可以实现：

from pyatool import PYAToolkit
from whenconnect import when_connect


VERSION = 'v0.1.4'
BASE_URL = r'https://github.com/williamfzc/simhand2/releases/download/{}/{}'
TEST_APK = r'app-debug-androidTest.apk'
MAIN_APK = r'app-debug.apk'

TEST_DL_URL = BASE_URL.format(VERSION, TEST_APK)
MAIN_DL_URL = BASE_URL.format(VERSION, MAIN_APK)


def install_sh(device_id):
    pya = PYAToolkit(device_id)
    pya.install_from(url=TEST_DL_URL)
    pya.install_from(url=MAIN_DL_URL)
    print('install simhand2 ok in {}'.format(device_id))


when_connect(device='all', do=install_sh)

就完成了。在运行之后，一旦有android设备接入，将会自动为其安装apk。

意见与建议

欢迎issue与PR

协议

MIT