An extension library for adding WebDriver Protocol and Appium commands to the Selenium Python language binding for use with the mobile testing framework Appium.
There are three ways to install and use the Appium Python client.
-
Install from PyPi, as 'Appium-Python-Client'.
pip install Appium-Python-Client
You can see the history from here
-
Install from source, via PyPi. From 'Appium-Python-Client', download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
tar -xvf Appium-Python-Client-X.X.tar.gz cd Appium-Python-Client-X.X python setup.py install -
Install from source via GitHub.
git clone [email protected]:appium/python-client.git cd python-client python setup.py install
| Appium Python Client | Selenium binding | Python version |
|---|---|---|
3.0.0+ |
4.12.0+ |
3.8+ |
2.10.0 - 2.11.1 |
4.1.0 - 4.11.2 |
3.7+ |
2.2.0 - 2.9.0 |
4.1.0 - 4.9.0 |
3.7+ |
2.0.0 - 2.1.4 |
4.0.0 |
3.7+ |
1.0.0 - 1.3.0 |
3.x |
3.7+ |
0.52 and below |
3.x |
2.7, 3.4 - 3.7 |
The Appium Python Client depends on Selenium Python binding, thus the Selenium Python binding update might affect the Appium Python Client behavior. For example, some changes in the Selenium binding could break the Appium client.
Note We strongly recommend you manage dependencies with version management tools such as Pipenv and requirements.txt to keep compatible version combinations.
- Removal
MultiActionandTouchActionare removed. Please use W3C WebDriver actions ormobile:extensions- appium/webdriver/extensions/action_helpers.py
- https://www.selenium.dev/documentation/webdriver/actions_api/
- https://www.youtube.com/watch?v=oAJ7jwMNFVU
- https://appiumpro.com/editions/30-ios-specific-touch-action-methods
- https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
- Deprecated
AppiumBy.WINDOWS_UI_AUTOMATION, which has no usage right now.
optionskeyword argument in thewebdriver.Remoteconstructor such asXCUITestOptionsinstead ofdesired_capabilities- Available options are https://github.com/appium/python-client/tree/master/appium/options
- Please check the Usage below as an example.
- Not a "new" change, but the
desired_capabilitiesargument has been removed since v3.
- Available options are https://github.com/appium/python-client/tree/master/appium/options
- Replacement
start_activitymethod: Please usemobile: startActivitylaunch_app,close_appandresetmethods: Please refer to appium/appium#15807available_ime_engines,is_ime_active,activate_ime_engine,deactivate_ime_engineandactive_ime_enginemethods: Please usemobile: shellset_valueandset_textmethods: Please useelement.send_keysorsend_keysby W3C Actions
- Removal
end_test_coveragemethod is no longer availablesessionproperty is no longer availableall_sessionsproperty is no longer available
- Enhancement
- Updated base Selenium Python binding version to v4
- Removed
forceMjsonwpsince Selenium v4 and Appium Python client v2 expect only W3C WebDriver protocol
- Removed
- Methods
ActionHelpers#scroll,ActionHelpers#drag_and_drop,ActionHelpers#tap,ActionHelpers#swipeandActionHelpers#flicknow call W3C actions as its backend- Please check each behavior. Their behaviors could slightly differ.
- Added
strict_sslto relax SSL errors such as self-signed ones
- Updated base Selenium Python binding version to v4
- Deprecated
MultiActionandTouchActionare deprecated. Please use W3C WebDriver actions ormobile:extensionslaunch_app,close_app, andresetare deprecated. Please read issues#15807 for more details
On UIA2, some elements can be handled with touch pointer action instead of the default mouse pointer action in the Selenium Python client.
For example, the below action builder is to replace the default one with the touch pointer action.
from selenium.webdriver import ActionChains
from selenium.webdriver.common.actions import interaction
from selenium.webdriver.common.actions.action_builder import ActionBuilder
from selenium.webdriver.common.actions.pointer_input import PointerInput
actions = ActionChains(driver)
# override as 'touch' pointer action
actions.w3c_actions = ActionBuilder(driver, mouse=PointerInput(interaction.POINTER_TOUCH, "touch"))
actions.w3c_actions.pointer_action.move_to_location(start_x, start_y)
actions.w3c_actions.pointer_action.pointer_down()
actions.w3c_actions.pointer_action.pause(2)
actions.w3c_actions.pointer_action.move_to_location(end_x, end_y)
actions.w3c_actions.pointer_action.release()
actions.perform()- appium/webdriver/extensions/action_helpers.py
- https://www.selenium.dev/documentation/webdriver/actions_api/
The Appium Python Client is fully compliant with the WebDriver Protocol including several helpers to make mobile testing in Python easier.
To use the new functionality now, and to use the superset of functions, instead of
including the Selenium webdriver module in your test code, use that from
Appium instead.
from appium import webdriverFrom there much of your test code will work with no change.
As a base for the following code examples, the following set up the UnitTest environment:
# Python/Pytest
import pytest
from appium import webdriver
# Options are only available since client version 2.3.0
# If you use an older client then switch to desired_capabilities
# instead: https://github.com/appium/python-client/pull/720
from appium.options.android import UiAutomator2Options
from appium.options.ios import XCUITestOptions
from appium.webdriver.appium_service import AppiumService
from appium.webdriver.common.appiumby import AppiumBy
APPIUM_PORT = 4723
APPIUM_HOST = '127.0.0.1'
# HINT: fixtures below could be extracted into conftest.py
# HINT: and shared across all tests in the suite
@pytest.fixture(scope='session')
def appium_service():
service = AppiumService()
service.start(
# Check the output of `appium server --help` for the complete list of
# server command line arguments
args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)],
timeout_ms=20000,
)
yield service
service.stop()
def create_ios_driver(custom_opts = None):
options = XCUITestOptions()
options.platformVersion = '13.4'
options.udid = '123456789ABC'
if custom_opts is not None:
options.load_capabilities(custom_opts)
# Appium1 points to http://127.0.0.1:4723/wd/hub by default
return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', options=options)
def create_android_driver(custom_opts = None):
options = UiAutomator2Options()
options.platformVersion = '10'
options.udid = '123456789ABC'
if custom_opts is not None:
options.load_capabilities(custom_opts)
# Appium1 points to http://127.0.0.1:4723/wd/hub by default
return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', options=options)
@pytest.fixture
def ios_driver_factory():
return create_ios_driver
@pytest.fixture
def ios_driver():
# prefer this fixture if there is no need to customize driver options in tests
driver = create_ios_driver()
yield driver
driver.quit()
@pytest.fixture
def android_driver_factory():
return create_android_driver
@pytest.fixture
def android_driver():
# prefer this fixture if there is no need to customize driver options in tests
driver = create_android_driver()
yield driver
driver.quit()
def test_ios_click(appium_service, ios_driver_factory):
# Usage of the context manager ensures the driver session is closed properly
# after the test completes. Otherwise, make sure to call `driver.quit()` on teardown.
with ios_driver_factory({
'appium:app': '/path/to/app/UICatalog.app.zip'
}) as driver:
el = driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
el.click()
def test_android_click(appium_service, android_driver_factory):
# Usage of the context manager ensures the driver session is closed properly
# after the test completes. Otherwise, make sure to call `driver.quit()` on teardown.
with android_driver_factory({
'appium:app': '/path/to/app/test-app.apk',
'appium:udid': '567890',
}) as driver:
el = driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
el.click()If your Selenium/Appium server decorates the new session capabilities response with the following keys:
directConnectProtocoldirectConnectHostdirectConnectPortdirectConnectPath
Then python client will switch its endpoint to the one specified by the values of those keys.
from appium import webdriver
# Options are only available since client version 2.3.0
# If you use an older client then switch to desired_capabilities
# instead: https://github.com/appium/python-client/pull/720
from appium.options.ios import XCUITestOptions
# load_capabilities API could be used to
# load options mapping stored in a dictionary
options = XCUITestOptions().load_capabilities({
'platformVersion': '13.4',
'deviceName': 'iPhone Simulator',
'app': '/full/path/to/app/UICatalog.app.zip',
})
driver = webdriver.Remote(
# Appium1 points to http://127.0.0.1:4723/wd/hub by default
'http://127.0.0.1:4723',
options=options,
direct_connection=True
)strict_ssl option allows you to send commands to an invalid certificate host like a self-signed one.
from appium import webdriver
# Options are only available since client version 2.3.0
# If you use an older client then switch to desired_capabilities
# instead: https://github.com/appium/python-client/pull/720
from appium.options.common import AppiumOptions
options = AppiumOptions()
options.platform_name = 'mac'
options.automation_name = 'safari'
# set_capability API allows to provide any custom option
# calls to it could be chained
options.set_capability('browser_name', 'safari')
# Appium1 points to http://127.0.0.1:4723/wd/hub by default
driver = webdriver.Remote('http://127.0.0.1:4723', options=options, strict_ssl=False)The first argument of webdriver.Remote can set an arbitrary command executor for you.
- Set init arguments for the pool manager Appium Python client uses to manage HTTP requests.
from appium import webdriver
from appium.options.ios import XCUITestOptions
import urllib3
from appium.webdriver.appium_connection import AppiumConnection
# Retry connection error up to 3 times.
init_args_for_pool_manage = {
'retries': urllib3.util.retry.Retry(total=3, connect=3, read=False)
}
appium_executor = AppiumConnection(
remote_server_addr='http://127.0.0.1:4723',
init_args_for_pool_manage=init_args_for_pool_manage
)
options = XCUITestOptions()
options.platformVersion = '13.4'
options.udid = '123456789ABC'
options.app = '/full/path/to/app/UICatalog.app.zip'
driver = webdriver.Remote(appium_executor, options=options)- Define a subclass of
AppiumConnection
from appium import webdriver
from appium.options.ios import XCUITestOptions
from appium.webdriver.appium_connection import AppiumConnection
class CustomAppiumConnection(AppiumConnection):
# Can add your own methods for the custom class
pass
custom_executor = CustomAppiumConnection(remote_server_addr='http://127.0.0.1:4723')
options = XCUITestOptions().load_capabilities({
'platformVersion': '13.4',
'deviceName': 'iPhone Simulator',
'app': '/full/path/to/app/UICatalog.app.zip',
})
driver = webdriver.Remote(custom_executor, options=options)- https://appium.github.io/python-client-sphinx/ is detailed documentation
- functional tests also may help to see concrete examples.
- Code Style: PEP-0008
- Apply
black,isortandmypyas pre commit hook - Run
makecommand for development. Seemake helpoutput for details
- Apply
- Docstring style: Google Style
gitchangeloggeneratesCHANGELOG.rst
pip install --user pipenvpython -m pipenv lock --clear- If you experience
Locking Failed! unknown locale: UTF-8error, then refer pypa/pipenv#187 to solve it.
- If you experience
python -m pipenv install --dev --systempre-commit install
You can run all of the tests running on CI via tox in your local.
$ toxYou also can run particular tests like below.
$ pytest test/unitRun with pytest-xdist
$ pytest -n 2 test/unit$ pytest test/functional/ios/search_context/find_by_ios_class_chain_tests.py- Create simulators named 'iPhone X - 8100' and 'iPhone X - 8101'
- Install test libraries via pip,
pip install pytest pytest-xdist - Run tests
$ pytest -n 2 test/functional/ios/search_context/find_by_ios_class_chain_tests.pyFollow the below steps.
$ pip install twine
$ pip install git+git://github.com/vaab/gitchangelog.git # Getting via GitHub repository is necessary for Python 3.7
# Type the new version number and 'yes' if you can publish it
# You can test the command with DRY_RUN
$ DRY_RUN=1 ./release.sh
$ ./release.sh # releaseApache License v2
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent