Appium Python Client

Warnings

• breaking The `desired_capabilities` dictionary for `webdriver.Remote` has been replaced by `options` objects (e.g., `AppiumOptions`). Passing a dictionary directly will likely lead to errors or unexpected behavior.
  Fix: Instead of `webdriver.Remote(command_executor, desired_capabilities=caps)`, use `options = AppiumOptions(); options.platformName = 'Android'; ...; webdriver.Remote(command_executor, options=options)`.
• breaking Direct `find_element_by_*` methods (e.g., `find_element_by_id`, `find_element_by_xpath`) are deprecated and largely removed, aligning with Selenium 4 changes.
  Fix: Use the unified `driver.find_element(AppiumBy.STRATEGY, "locator_value")` pattern. For example, `driver.find_element(AppiumBy.ID, "someId")`.
• gotcha For Appium server 2.x, the default URL changed from `http://localhost:4723/wd/hub` to simply `http://localhost:4723`. Using the old `/wd/hub` path will result in connection failures.
  Fix: Ensure your `APPIUM_SERVER_URL` or `command_executor` points to `http://localhost:4723`.
• gotcha The Appium server (the Node.js application) must be installed and running independently before you can execute any Python client scripts. The Python client acts as a bridge to the server.
  Fix: Install Appium globally via `npm install -g appium` and start it with `appium` in your terminal before running tests.
• gotcha While `AppiumOptions` is a base class, for real-world scenarios, it's often more appropriate and robust to use platform-specific option classes like `UiAutomator2Options` (for Android) or `XCUITestOptions` (for iOS). These provide specific capabilities and validations.
  Fix: Import and use `from appium.options.android import UiAutomator2Options` or `from appium.options.ios import XCUITestOptions` and instantiate them instead of `AppiumOptions`.

Install

• pip install Appium-Python-Client Install latest version

Imports

• webdriver

  from appium import webdriver

  The `webdriver` object is now directly available under the `appium` top-level package.
• AppiumOptions

  from appium.options.common.base import AppiumOptions

  Specific option classes are found in `appium.options.common.base` or platform-specific submodules.
• AppiumBy

  from appium.webdriver.common.appiumby import AppiumBy

  `MobileBy` was deprecated; `AppiumBy` is the current standard for Appium-specific locator strategies.

Quickstart

This quickstart demonstrates how to connect to an Appium server, define basic Android capabilities using `AppiumOptions`, initialize the `webdriver.Remote` instance, and perform a simple element interaction (finding and clicking an element by accessibility ID). Ensure the Appium server (Node.js) is running before executing this script. Environment variables are used for flexibility, with sensible defaults.

import os
from appium import webdriver
from appium.options.common.base import AppiumOptions
from appium.webdriver.common.appiumby import AppiumBy

APPIUM_SERVER_URL = os.environ.get('APPIUM_SERVER_URL', 'http://localhost:4723')

options = AppiumOptions()
options.platformName = os.environ.get('APPIUM_PLATFORM_NAME', 'Android')
options.automationName = os.environ.get('APPIUM_AUTOMATION_NAME', 'UiAutomator2')
options.deviceName = os.environ.get('APPIUM_DEVICE_NAME', 'Android Emulator')
options.appPackage = os.environ.get('APPIUM_APP_PACKAGE', 'com.android.settings')
options.appActivity = os.environ.get('APPIUM_APP_ACTIVITY', '.Settings')

print(f"Connecting to Appium server at: {APPIUM_SERVER_URL}")
print(f"Using capabilities: {options.to_capabilities()}")

driver = None
try:
    driver = webdriver.Remote(APPIUM_SERVER_URL, options=options)
    print("Driver initialized successfully.")

    # Example action: Find and click 'Display' setting
    # Requires an Android emulator/device with the default Settings app
    el = driver.find_element(AppiumBy.ACCESSIBILITY_ID, "Display")
    print(f"Found element: {el.text}")
    el.click()
    print("Clicked 'Display' setting.")

except Exception as e:
    print(f"An error occurred: {e}")
finally:
    if driver:
        driver.quit()
        print("Driver quit.")