Welcome to pyatool’s documentation!

Usage

使用方法如下

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,将 show_package 替换成API名称即可!

API

pyatool.extras.hello_world(toolkit=None)[source]

test only

Parameters:toolkit
Returns:
pyatool.extras.install_from(url: str = None, path: str = None, toolkit=None)[source]

根据url或path安装指定apk

Parameters:
  • url – apk对应的下载url
  • path – apk的本地路径
  • toolkit
Returns:

pyatool.extras.show_package(toolkit=None)[source]

展示设备上所有已安装的包

Parameters:toolkit
Returns:
pyatool.extras.get_current_activity(toolkit=None)[source]

获取设备的当前栈顶activity名称

Parameters:toolkit
Returns:
pyatool.extras.is_installed(package_name: str, toolkit=None)[source]

检测包是否已被安装到设备上

Parameters:
  • package_name – 待检测的包名
  • toolkit
Returns:

pyatool.extras.clean_cache(package_name: str, toolkit=None)[source]

清理对应包的缓存

Parameters:
  • package_name – 对应包名
  • toolkit
Returns:

pyatool.extras.uninstall(package_name: str, toolkit=None, save_data: bool = None)[source]

卸载指定包

Parameters:
  • package_name – 对应包名
  • toolkit
  • save_data – 是否保留data
Returns:

pyatool.extras.switch_airplane(status: bool, toolkit=None)[source]

切换飞行模式的开关

Parameters:
  • status – true or false
  • toolkit
Returns:

pyatool.extras.switch_wifi(status: bool, toolkit=None)[source]

切换wifi开关

Parameters:
  • status – true or false
  • toolkit
Returns:

pyatool.extras.input_text(content: str, toolkit=None)[source]

输入文字(不支持中文)。中文输入可以利用ADBKeyBoard (https://github.com/senzhk/ADBKeyBoard)

Parameters:
  • content – 期望的输入内容
  • toolkit
Returns:

pyatool.extras.start_activity(package_name: str, activity_name: str = None, toolkit=None)[source]

根据包名/活动名 启动应用/活动 (更复杂场景请使用 start_activity_with_command)

Parameters:
  • package_name – 包名
  • activity_name – 活动名
  • toolkit
Returns:

pyatool.extras.start_activity_with_command(command: str, toolkit=None)[source]

更灵活的 start_activity,实际上是运行 adb shell am start <command>

Parameters:
  • command – adb shell am start <command>
  • toolkit
Returns:

pyatool.extras.get_ip_address(toolkit=None)[source]

获取android设备ip地址

Parameters:toolkit
Returns:
pyatool.extras.set_ime(ime_name, toolkit=None)[source]

设置输入法(需要使用adb shell ime list -a 获取输入法包名)

Parameters:
  • ime_name – 输入法包名 eg:com.android.inputmethod.pinyin/.PinyinIME
  • toolkit
Returns:

pyatool.extras.push(src, target, toolkit=None)[source]

adb push <src> <target>

Parameters:
  • src
  • target
  • toolkit
Returns:

pyatool.extras.pull(src, target, toolkit=None)[source]

adb pull <src> <target>

Parameters:
  • src
  • target
  • toolkit
Returns:

pyatool.extras.send_broadcast(command: str, toolkit=None)[source]

发送广播,实际上是 adb shell am broadcast <command>

Parameters:
  • command – 在 am broadcast 后的命令
  • toolkit
Returns:

pyatool.extras.force_stop(package_name: str, toolkit=None)[source]

根据包名/活动名 停止应用

Parameters:
  • package_name – 包名
  • toolkit
Returns:

pyatool.extras.input_key_event(key_code, toolkit=None)[source]

send key event

Parameters:
  • key_code – 按钮对应的 keycode, 例如home键是3。参考https://developer.android.com/reference/kotlin/android/view/KeyEvent
  • toolkit
Returns:

pyatool.extras.swipe(x1, y1, x2, y2, toolkit=None)[source]

swipe from (x1, y1) to (x2, y2)

Parameters:
  • x1
  • y1
  • x2
  • y2
  • toolkit
Returns:

pyatool.extras.click(x, y)[source]
Parameters:
  • x
  • y
  • toolkit
Returns:

pyatool.extras.is_connected(toolkit=None)[source]

check if device is connected

Parameters:toolkit
Returns:
pyatool.extras.make_dir(target, toolkit=None)[source]

make empty dir: adb shell mkdir <target_dir>

Parameters:
  • target – 目标路径
  • toolkit
Returns:

pyatool.extras.remove_dir(target, toolkit=None)[source]

clean dir: adb shell rm -rf <target>

Parameters:
  • target – 目标路径
  • toolkit
Returns:

Indices and tables