repository·master·Indexed 27 days ago
https://github.com/airtestproject/airtestA cross-platform UI automation framework for games and mobile apps using image recognition. It provides a Python API via airtest.core.api for device connection, app management, and simulated inputs, as well as a CLI for executing .air test cases, generating reports, and extracting script metadata.
airtest.core package is the central entry point for the Airtest framework. It provides the core logic and organizes functionality into specialized subpackages and submodules for different platforms and capabilities.Before starting, verify if your target platform and engine are supported by both Airtest and the Poco UI recognition framework.
| Platforms | Airtest | Poco |
|---|---|---|
| Android | √ | √ |
| Emulator | √ | √ |
| iOS | √ (via iOS-Tagent) | √ (via ios-tagent) |
| Windows | √ | Not yet |
| Cocos2dx-js & Cocos2dx-lua | √ | √ |
| Unity3D | √ | √ |
| Egret | √ | √ |
| WeChat Applet & Webview | √ | √ |
| Netease engines | √ | √ |
| Other engines | √ | √ |
airtest.core.android.touch_methods package provides various implementations for performing touch operations on Android devices. Depending on your device setup and requirements, you can use different submodules to handle touch input via different drivers or proxies.To work with specific regions of the screen, use aircv.crop_image() to create a partial screenshot. You can then use Template.match_in() to find an image within that specific cropped area.
Note: Coordinates returned by match_in() are relative to the cropped image. To get absolute screen coordinates, you must add the offset used during cropping.
from airtest.core.api import *
from airtest.aircv import *
auto_setup(__file__)
screen = G.DEVICE.snapshot()
# 1. Create a partial screenshot using coordinates (x, y, width, height)
local_screen = aircv.crop_image(screen, (0, 949, 1067, 1500))
# 2. Define target and find it in the partial screenshot
template = Template(r"png_code/settings.png")
pos = template.match_in(local_screen)
# 3. Convert relative pos to absolute screen coordinates
# (pos[0] + offset_x, pos[1] + offset_y)
print(pos[0] + 0, pos[1] + 949)from airtest.core.api import *
from airtest.aircv import *
auto_setup(__file__)
screen = G.DEVICE.snapshot()
# Partial screenshot
local_screen = aircv.crop_image(screen,(0,949,1067,1500))
# Set our target screenshot as a Template object
tempalte = Template(r"png_code/settings.png")
# Find the specified image object in the partial screenshot
pos = tempalte.match_in(local_screen)
# Return the coordinates of the image object found (the coordinates are relative to the coordinates of the local screenshot)
print(pos)
# To return the coordinates of the target in the entire screen, both x and y need to be added with the minimum x and y set during the partial screenshot
print(pos[0]+0,pos[1]+949)You can modularize your automation by writing common functions in one .air script and importing them into others. Use the using API from airtest.core.api to manage context changes, which automatically handles sys.path updates and Template search path adjustments.
To use it, pass the path to the .air script to the using() function, then import your desired functions as standard Python modules.
from airtest.core.api import using
using("common.air")
from common import common_function
common_function()Airtest supports several verified Android emulators. Common supported emulators include:
Airtest includes adb executables for all platforms. You can use them to verify if your device is recognized.
Windows:
Navigate to airtest\airtest\core\android\static\adb\windows and run:
E:\airtest\airtest\core\android\static\adb\windows>adb devicesMAC:
Navigate to airtest/core/android/static/adb/mac. If the adb binary lacks executable permissions, run chmod +x adb before executing:
./adb devicesDevices with the status device are online and ready for use.
List of devices attached
c2b1c2a7 deviceairtest.core.win.Windows class. This class provides the primary interface for interacting with Windows-based applications and desktop elements.Install the Airtest framework using pip.
pip install -U airtestAirtest is compatible with most Android phones (Android version 2.3 to 11) and certain tablets.
Xiaomi (MIUI 11 or above):
To connect to Xiaomi devices running MIUI 11 or higher, you must use the cap_method=JAVACAP mode.
If you encounter connection issues, check manufacturer-specific settings for your device.
Android devices are identified using the connection string format:
Android://<adbhost>:<adbport>/<serialno>
adbhost: IP of the host where the ADB server is located (default: 127.0.0.1).adbport: ADB port (default: 5037).serialno: The device serial number obtained from adb devices.Android:///Android://127.0.0.1:5037/c2b1c2a7Android://127.0.0.1:5037/10.254.60.1:5555 (where the last part is the remote serial/IP).In Python code:
from airtest.core.api import *
connect_device("Android:///c2b1c2a7")From Command Line:
airtest run untitled.air --device Android:///c2b1c2a7 --log log/from airtest.core.api import *
connect_device("Android:///Phone Serial Number")To connect an Android device without AirtestIDE, ensure Developer Options and USB Debugging are enabled on the phone. You can verify the connection using the adb devices command.
Airtest provides bundled adb executables in the following directories:
airtest/core/android/static/adb/windows/adb.exeairtest/core/android/static/adb/mac/adb (Note: You may need to run chmod +x adb to grant execution permissions).If a device shows as unauthorized in the adb devices list, you must accept the USB debugging prompt on the phone's screen. If no devices appear, ensure the official manufacturer drivers are installed on your PC.
adb devices