Appium Python Client

The webdriver.extensions package provides specialized modules that extend the core WebDriver functionality with mobile-specific capabilities and Appium commands. These extensions allow you to interact with device hardware, manage application states, handle clipboard operations, and perform advanced actions like screen recording or image comparison.

Key functional areas available via extensions include:

• Mobile Commands: execute_mobile_command for sending raw mobile commands.
• Device Interaction: clipboard, device_time, hw_actions, keyboard, and location.
• Application Management: applications, context, and session.
• Media & Logs: images_comparison, logs, log_event, and screen_record.
• System/Filesystem: remote_fs and settings.

The webdriver.extensions.flutter_integration package provides specialized tools for automating Flutter applications. It is composed of three main submodules:

1. flutter_commands: Contains commands specifically designed to interact with Flutter application internals.
2. flutter_finder: Provides specialized finder mechanisms to locate Flutter widgets within the application tree.
3. scroll_directions: Defines the available directions for performing scroll actions within Flutter widgets.

The client has a default read timeout of 120 seconds. To extend this, use one of the following methods:

1. Recommended: Configure the timeout via appium.webdriver.client_config.AppiumClientConfig or selenium.webdriver.remote.client_config.ClientConfig using the timeout argument, or provide init_args_for_pool_manager for the underlying urllib3.PoolManager.
2. Fallback: Set the GLOBAL_DEFAULT_TIMEOUT environment variable (Note: this method is being deprecated in favor of Selenium's binding changes).

Since client version 2.3.0, you should use specific Options classes instead of desired_capabilities. These classes provide type-safe ways to set capabilities for different automation engines.

Common automation options and their package paths:

• uiautomator2: appium.options.android.UiAutomator2Options
• espresso: appium.options.android.EspressoOptions
• xcuitest: appium.options.ios.XCUITestOptions
• safari: appium.options.ios.SafariOptions
• mac2: appium.options.mac.Mac2Options
• windows: appium.options.WindowsOptions
• gecko: appium.options.GeckoOptions
• flutterintegration: appium.options.flutter_integration.FlutterOptions
• any: appium.options.common.base.AppiumOptions

You can install the Appium Python client using one of the following three methods:

1. Via PyPI (Recommended)

Install the package directly using pip:

pip install Appium-Python-Client

2. From Source via PyPI Tarball

Download and unarchive the source tarball (e.g., Appium-Python-Client-X.X.tar.gz) from PyPI, then install it:

tar -xvf Appium-Python-Client-X.X.tar.gz
cd Appium-Python-Client-X.X
pip install .

3. From Source via GitHub

Clone the repository and install from the local directory:

git clone git@github.com:appium/python-client.git
cd python-client
pip install .

To connect to a host with an invalid or self-signed certificate, you can relax SSL validation.

For Appium Python client v4.3.0 and later (Recommended): Use selenium.webdriver.remote.client_config.ClientConfig with ignore_certificates=True.

For older versions: Pass strict_ssl=False as an argument to webdriver.Remote.

from appium import webdriver
from selenium.webdriver.remote.client_config import ClientConfig

# Recommended for v4.3.0+
client_config = ClientConfig(
    remote_server_addr='http://127.0.0.1:4723',
    ignore_certificates=True
)
driver = webdriver.Remote(client_config.remote_server_addr, options=options, client_config=client_config)

The project uses uv for dependency management. To set up a local development environment:

1. Install uv and sync dependencies:

   make install-uv
   exec $SHELL
   make sync-dev

2. If you need a specific Python version, run uv venv --python <V> (e.g., 3.12) before make sync-dev.
3. Activate the environment:

   source .venv/bin/activate

Upgrading from v3 to v4 involves the following changes:

Removed Classes

• MultiAction and TouchAction have been removed. Use W3C WebDriver actions or mobile: extensions instead.

Deprecated Constants

• AppiumBy.WINDOWS_UI_AUTOMATION is deprecated and has no current usage.

If you are upgrading from v4 to v5, note the following changes:

Use AppiumClientConfig

If you previously used keep_alive, direct_connection, or strict_ssl arguments directly in webdriver.Remote, you must now use the AppiumClientConfig object passed via the client_config argument.

Update Server URL

Use http://127.0.0.1:4723 as the default server URL instead of the legacy http://127.0.0.1:4444/wd/hub path.

from appium.webdriver.client_config import AppiumClientConfig

SERVER_URL_BASE = 'http://127.0.0.1:4723'
client_config = AppiumClientConfig(
    remote_server_addr=SERVER_URL_BASE,
    direct_connection=True,
    keep_alive=False,
    ignore_certificates=True,
)

driver = webdriver.Remote(
    options=UiAutomator2Options().load_capabilities(desired_caps),
    client_config=client_config
)

To access the full superset of Appium-specific functions and mobile testing helpers, import webdriver from appium instead of the standard Selenium module.

from appium import webdriver