class WebDriver(webdriver.Remote):
def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False):
super(WebDriver, self).__init__(command_executor, desired_capabilities, browser_profile, proxy, keep_alive)
if self.command_executor is not None:
self._addCommands()
self.error_handler = MobileErrorHandler()
self._switch_to = MobileSwitchTo(self)
# add new method to the `find_by_*` pantheon
By.IOS_UIAUTOMATION = MobileBy.IOS_UIAUTOMATION
By.IOS_PREDICATE = MobileBy.IOS_PREDICATE
By.ANDROID_UIAUTOMATOR = MobileBy.ANDROID_UIAUTOMATOR
By.ACCESSIBILITY_ID = MobileBy.ACCESSIBILITY_ID
@property
def contexts(self):
"""
返回当前会话的所有上下文
:Usage:
driver.contexts
"""
return self.execute(Command.CONTEXTS)['value']
@property
def current_context(self):
"""
返回当前会话的当前上下文
:Usage:
driver.current_context
"""
return self.execute(Command.GET_CURRENT_CONTEXT)['value']
@property
def context(self):
"""
返回当前会话的当前上下文
:Usage:
driver.context
"""
return self.current_context
def find_element_by_ios_uiautomation(self, uia_string):
"""
Finds an element by uiautomation in iOS.
:Args:
- uia_string - The element name in the iOS UIAutomation library
:Usage:
driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')
"""
return self.find_element(by=By.IOS_UIAUTOMATION, value=uia_string)
def find_elements_by_ios_uiautomation(self, uia_string):
"""Finds elements by uiautomation in iOS.
:Args:
- uia_string - The element name in the iOS UIAutomation library
:Usage:
driver.find_elements_by_ios_uiautomation('.elements()[1].cells()[2]')
"""
return self.find_elements(by=By.IOS_UIAUTOMATION, value=uia_string)
def find_element_by_ios_predicate(self, predicate_string):
"""Find an element by ios predicate string.
:Args:
- predicate_string - The predicate string
:Usage:
driver.find_element_by_ios_predicate('label == "myLabel"')
"""
return self.find_element(by=By.IOS_PREDICATE, value=predicate_string)
def find_elements_by_ios_predicate(self, predicate_string):
"""Finds elements by ios predicate string.
:Args:
- predicate_string - The predicate string
:Usage:
driver.find_elements_by_ios_predicate('label == "myLabel"')
"""
return self.find_elements(by=By.IOS_PREDICATE, value=predicate_string)
def find_element_by_android_uiautomator(self, uia_string):
"""Finds element by uiautomator in Android.
:Args:
- uia_string - The element name in the Android UIAutomator library
:Usage:
driver.find_element_by_android_uiautomator('.elements()[1].cells()[2]')
"""
return self.find_element(by=By.ANDROID_UIAUTOMATOR, value=uia_string)
def find_elements_by_android_uiautomator(self, uia_string):
"""Finds elements by uiautomator in Android.
:Args:
- uia_string - The element name in the Android UIAutomator library
:Usage:
driver.find_elements_by_android_uiautomator('.elements()[1].cells()[2]')
"""
return self.find_elements(by=By.ANDROID_UIAUTOMATOR, value=uia_string)
def find_element_by_accessibility_id(self, id):
"""Finds an element by accessibility id.
:Args:
- id - a string corresponding to a recursive element search using the
Id/Name that the native Accessibility options utilize
:Usage:
driver.find_element_by_accessibility_id()
"""
return self.find_element(by=By.ACCESSIBILITY_ID, value=id)
def find_elements_by_accessibility_id(self, id):
"""Finds elements by accessibility id.
:Args:
- id - a string corresponding to a recursive element search using the
Id/Name that the native Accessibility options utilize
:Usage:
driver.find_elements_by_accessibility_id()
"""
return self.find_elements(by=By.ACCESSIBILITY_ID, value=id)
def create_web_element(self, element_id):
"""
Creates a web element with the specified element_id.
Overrides method in Selenium WebDriver in order to always give them
Appium WebElement
"""
return MobileWebElement(self, element_id)
# convenience method added to Appium (NOT Selenium 3)
def scroll(self, origin_el, destination_el):
"""Scrolls from one element to another
:Args:
- originalEl - the element from which to being scrolling
- destinationEl - the element to scroll to
:Usage:
driver.scroll(el1, el2)
"""
action = TouchAction(self)
action.press(origin_el).move_to(destination_el).release().perform()
return self
# convenience method added to Appium (NOT Selenium 3)
def drag_and_drop(self, origin_el, destination_el):
"""Drag the origin element to the destination element
:Args:
- originEl - the element to drag
- destinationEl - the element to drag to
"""
action = TouchAction(self)
action.long_press(origin_el).move_to(destination_el).release().perform()
return self
# convenience method added to Appium (NOT Selenium 3)
def tap(self, positions, duration=None):
"""Taps on an particular place with up to five fingers, holding for a
certain time
:Args:
- positions - an array of tuples representing the x/y coordinates of
the fingers to tap. Length can be up to five.
- duration - (optional) length of time to tap, in ms
:Usage:
driver.tap([(100, 20), (100, 60), (100, 100)], 500)
"""
if len(positions) == 1:
action = TouchAction(self)
x = positions[0][0]
y = positions[0][1]
if duration:
action.long_press(x=x, y=y, duration=duration).release()
else:
action.tap(x=x, y=y)
action.perform()
else:
ma = MultiAction(self)
for position in positions:
x = position[0]
y = position[1]
action = TouchAction(self)
if duration:
action.long_press(x=x, y=y, duration=duration).release()
else:
action.press(x=x, y=y).release()
ma.add(action)
ma.perform()
return self
# convenience method added to Appium (NOT Selenium 3)
def swipe(self, start_x, start_y, end_x, end_y, duration=None):
"""Swipe from one point to another point, for an optional duration.
:Args:
- start_x - x-coordinate at which to start
- start_y - y-coordinate at which to start
- end_x - x-coordinate at which to stop
- end_y - y-coordinate at which to stop
- duration - (optional) time to take the swipe, in ms.
:Usage:
driver.swipe(100, 100, 100, 400)
"""
# `swipe` is something like press-wait-move_to-release, which the server
# will translate into the correct action
action = TouchAction(self)
action \
.press(x=start_x, y=start_y) \
.wait(ms=duration) \
.move_to(x=end_x, y=end_y) \
.release()
action.perform()
return self
# convenience method added to Appium (NOT Selenium 3)
def flick(self, start_x, start_y, end_x, end_y):
"""Flick from one point to another point.
:Args:
- start_x - x-coordinate at which to start
- start_y - y-coordinate at which to start
- end_x - x-coordinate at which to stop
- end_y - y-coordinate at which to stop
:Usage:
driver.flick(100, 100, 100, 400)
"""
action = TouchAction(self)
action \
.press(x=start_x, y=start_y) \
.move_to(x=end_x, y=end_y) \
.release()
action.perform()
return self
# convenience method added to Appium (NOT Selenium 3)
def pinch(self, element=None, percent=200, steps=50):
"""Pinch on an element a certain amount
:Args:
- element - the element to pinch
- percent - (optional) amount to pinch. Defaults to 200%
- steps - (optional) number of steps in the pinch action
:Usage:
driver.pinch(element)
"""
if element:
element = element.id
opts = {
'element': element,
'percent': percent,
'steps': steps,
}
self.execute_script('mobile: pinchClose', opts)
return self
# convenience method added to Appium (NOT Selenium 3)
def zoom(self, element=None, percent=200, steps=50):
"""Zooms in on an element a certain amount
:Args:
- element - the element to zoom
- percent - (optional) amount to zoom. Defaults to 200%
- steps - (optional) number of steps in the zoom action
:Usage:
driver.zoom(element)
"""
if element:
element = element.id
opts = {
'element': element,
'percent': percent,
'steps': steps,
}
self.execute_script('mobile: pinchOpen', opts)
return self
def app_strings(self, language=None, string_file=None):
"""Returns the application strings from the device for the specified
language.
:Args:
- language - strings language code
- string_file - the name of the string file to query
"""
data = {}
if language != None:
data['language'] = language
if string_file != None:
data['stringFile'] = string_file
return self.execute(Command.GET_APP_STRINGS, data)['value']
def reset(self):
"""Resets the current application on the device.
"""
self.execute(Command.RESET)
return self
def hide_keyboard(self, key_name=None, key=None, strategy=None):
"""Hides the software keyboard on the device. In iOS, use `key_name` to press
a particular key, or `strategy`. In Android, no parameters are used.
:Args:
- key_name - key to press
- strategy - strategy for closing the keyboard (e.g., `tapOutside`)
"""
data = {}
if key_name is not None:
data['keyName'] = key_name
elif key is not None:
data['key'] = key
else:
# defaults to `tapOutside` strategy
strategy = 'tapOutside'
data['strategy'] = strategy
self.execute(Command.HIDE_KEYBOARD, data)
return self
# Needed for Selendroid
def keyevent(self, keycode, metastate=None):
"""Sends a keycode to the device. Android only. Possible keycodes can be
found in http://developer.android.com/reference/android/view/KeyEvent.html.
:Args:
- keycode - the keycode to be sent to the device
- metastate - meta information about the keycode being sent
"""
data = {
'keycode': keycode,
}
if metastate is not None:
data['metastate'] = metastate
self.execute(Command.KEY_EVENT, data)
return self
def press_keycode(self, keycode, metastate=None):
"""Sends a keycode to the device. Android only. Possible keycodes can be
found in http://developer.android.com/reference/android/view/KeyEvent.html.
:Args:
- keycode - the keycode to be sent to the device
- metastate - meta information about the keycode being sent
"""
data = {
'keycode': keycode,
}
if metastate is not None:
data['metastate'] = metastate
self.execute(Command.PRESS_KEYCODE, data)
return self
def long_press_keycode(self, keycode, metastate=None):
"""Sends a long press of keycode to the device. Android only. Possible keycodes can be
found in http://developer.android.com/reference/android/view/KeyEvent.html.
:Args:
- keycode - the keycode to be sent to the device
- metastate - meta information about the keycode being sent
"""
data = {
'keycode': keycode
}
if metastate != None:
data['metastate'] = metastate
self.execute(Command.LONG_PRESS_KEYCODE, data)
return self
@property
def current_activity(self):
"""Retrieves the current activity on the device.
"""
return self.execute(Command.GET_CURRENT_ACTIVITY)['value']
def wait_activity(self, activity, timeout, interval=1):
"""Wait for an activity: block until target activity presents
or time out.
This is an Android-only method.
:Agrs:
- activity - target activity
- timeout - max wait time, in seconds
- interval - sleep interval between retries, in seconds
"""
try:
WebDriverWait(self, timeout, interval).until(
lambda d: d.current_activity == activity)
return True
except TimeoutException:
return False
def set_value(self, element, value):
"""Set the value on an element in the application.
:Args:
- element - the element whose value will be set
- Value - the value to set on the element
"""
data = {
'id': element.id,
'value': [value],
}
self.execute(Command.SET_IMMEDIATE_VALUE, data)
return self
def pull_file(self, path):
"""Retrieves the file at `path`. Returns the file's content encoded as
Base64.
:Args:
- path - the path to the file on the device
"""
data = {
'path': path,
}
return self.execute(Command.PULL_FILE, data)['value']
def pull_folder(self, path):
"""Retrieves a folder at `path`. Returns the folder's contents zipped
and encoded as Base64.
:Args:
- path - the path to the folder on the device
"""
data = {
'path': path,
}
return self.execute(Command.PULL_FOLDER, data)['value']
def push_file(self, path, base64data):
"""Puts the data, encoded as Base64, in the file specified as `path`.
:Args:
- path - the path on the device
- base64data - data, encoded as Base64, to be written to the file
"""
data = {
'path': path,
'data': base64data,
}
self.execute(Command.PUSH_FILE, data)
return self
def background_app(self, seconds):
"""Puts the application in the background on the device for a certain
duration.
:Args:
- seconds - the duration for the application to remain in the background
"""
data = {
'seconds': seconds,
}
self.execute(Command.BACKGROUND, data)
return self
def is_app_installed(self, bundle_id):
"""Checks whether the application specified by `bundle_id` is installed
on the device.
:Args:
- bundle_id - the id of the application to query
"""
data = {
'bundleId': bundle_id,
}
return self.execute(Command.IS_APP_INSTALLED, data)['value']
def install_app(self, app_path):
"""Install the application found at `app_path` on the device.
:Args:
- app_path - the local or remote path to the application to install
"""
data = {
'appPath': app_path,
}
self.execute(Command.INSTALL_APP, data)
return self
def remove_app(self, app_id):
"""Remove the specified application from the device.
:Args:
- app_id - the application id to be removed
"""
data = {
'appId': app_id,
}
self.execute(Command.REMOVE_APP, data)
return self
def launch_app(self):
"""Start on the device the application specified in the desired capabilities.
"""
self.execute(Command.LAUNCH_APP)
return self
def close_app(self):
"""Stop the running application, specified in the desired capabilities, on
the device.
"""
self.execute(Command.CLOSE_APP)
return self
def start_activity(self, app_package, app_activity, **opts):
"""Opens an arbitrary activity during a test. If the activity belongs to
another application, that application is started and the activity is opened.
This is an Android-only method.
:Args:
- app_package - The package containing the activity to start.
- app_activity - The activity to start.
- app_wait_package - Begin automation after this package starts (optional).
- app_wait_activity - Begin automation after this activity starts (optional).
- intent_action - Intent to start (optional).
- intent_category - Intent category to start (optional).
- intent_flags - Flags to send to the intent (optional).
- optional_intent_arguments - Optional arguments to the intent (optional).
- dont_stop_app_on_reset - Should the app be stopped on reset (optional)?
"""
data = {
'appPackage': app_package,
'appActivity': app_activity
}
arguments = {
'app_wait_package': 'appWaitPackage',
'app_wait_activity': 'appWaitActivity',
'intent_action': 'intentAction',
'intent_category': 'intentCategory',
'intent_flags': 'intentFlags',
'optional_intent_arguments': 'optionalIntentArguments',
'dont_stop_app_on_reset': 'dontStopAppOnReset'
}
for key, value in arguments.items():
if key in opts:
data[value] = opts[key]
self.execute(Command.START_ACTIVITY, data)
return self
def end_test_coverage(self, intent, path):
"""Ends the coverage collection and pull the coverage.ec file from the device.
Android only.
See https://github.com/appium/appium/blob/master/docs/en/android_coverage.md
:Args:
- intent - description of operation to be performed
- path - path to coverage.ec file to be pulled from the device
"""
data = {
'intent': intent,
'path': path,
}
return self.execute(Command.END_TEST_COVERAGE, data)['value']
def lock(self, seconds):
"""Lock the device for a certain period of time. iOS only.
:Args:
- the duration to lock the device, in seconds
"""
data = {
'seconds': seconds,
}
self.execute(Command.LOCK, data)
return self
def shake(self):
"""Shake the device.
"""
self.execute(Command.SHAKE)
return self
def touch_id(self, match):
"""Do a fingerprint scan
"""
data = {
'match': match
}
self.execute(Command.TOUCH_ID, data)
return self
def open_notifications(self):
"""Open notification shade in Android (API Level 18 and above)
"""
self.execute(Command.OPEN_NOTIFICATIONS, {})
return self
@property
def network_connection(self):
"""Returns an integer bitmask specifying the network connection type.
Android only.
Possible values are available through the enumeration `appium.webdriver.ConnectionType`
"""
return self.execute(Command.GET_NETWORK_CONNECTION, {})['value']
def set_network_connection(self, connectionType):
"""Sets the network connection type. Android only.
Possible values:
Value (Alias) | Data | Wifi | Airplane Mode
-------------------------------------------------
0 (None) | 0 | 0 | 0
1 (Airplane Mode) | 0 | 0 | 1
2 (Wifi only) | 0 | 1 | 0
4 (Data only) | 1 | 0 | 0
6 (All network on) | 1 | 1 | 0
These are available through the enumeration `appium.webdriver.ConnectionType`
:Args:
- connectionType - a member of the enum appium.webdriver.ConnectionType
"""
data = {
'parameters': {
'type': connectionType
}
}
return self.execute(Command.SET_NETWORK_CONNECTION, data)['value']
@property
def available_ime_engines(self):
"""Get the available input methods for an Android device. Package and
activity are returned (e.g., ['com.android.inputmethod.latin/.LatinIME'])
Android only.
"""
return self.execute(Command.GET_AVAILABLE_IME_ENGINES, {})['value']
def is_ime_active(self):
"""Checks whether the device has IME service active. Returns True/False.
Android only.
"""
return self.execute(Command.IS_IME_ACTIVE, {})['value']
def activate_ime_engine(self, engine):
"""Activates the given IME engine on the device.
Android only.
:Args:
- engine - the package and activity of the IME engine to activate (e.g.,
'com.android.inputmethod.latin/.LatinIME')
"""
data = {
'engine': engine
}
self.execute(Command.ACTIVATE_IME_ENGINE, data)
return self
def deactivate_ime_engine(self):
"""Deactivates the currently active IME engine on the device.
Android only.
"""
self.execute(Command.DEACTIVATE_IME_ENGINE, {})
return self
@property
def active_ime_engine(self):
"""Returns the activity and package of the currently active IME engine (e.g.,
'com.android.inputmethod.latin/.LatinIME').
Android only.
"""
return self.execute(Command.GET_ACTIVE_IME_ENGINE, {})['value']
def get_settings(self):
"""Returns the appium server Settings for the current session.
Do not get Settings confused with Desired Capabilities, they are
separate concepts. See https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md
"""
return self.execute(Command.GET_SETTINGS, {})['value']
def update_settings(self, settings):
"""Set settings for the current session.
For more on settings, see: https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md
:Args:
- settings - dictionary of settings to apply to the current test session
"""
data = {"settings": settings}
self.execute(Command.UPDATE_SETTINGS, data)
return self
def toggle_location_services(self):
"""Toggle the location services on the device. Android only.
"""
self.execute(Command.TOGGLE_LOCATION_SERVICES, {})
return self
def set_location(self, latitude, longitude, altitude):
"""Set the location of the device
:Args:
- latitude - String or numeric value between -90.0 and 90.00
- longitude - String or numeric value between -180.0 and 180.0
- altitude - String or numeric value
"""
data = {
"location": {
"latitude": str(latitude),
"longitude": str(longitude),
"altitude": str(altitude)
}
}
self.execute(Command.SET_LOCATION, data)
return self
@property
def device_time(self):
"""Returns the date and time fomr the device
"""
return self.execute(Command.GET_DEVICE_TIME, {})['value']
def _addCommands(self):
self.command_executor._commands[Command.CONTEXTS] = \
('GET', '/session/$sessionId/contexts')
self.command_executor._commands[Command.GET_CURRENT_CONTEXT] = \
('GET', '/session/$sessionId/context')
self.command_executor._commands[Command.SWITCH_TO_CONTEXT] = \
('POST', '/session/$sessionId/context')
self.command_executor._commands[Command.TOUCH_ACTION] = \
('POST', '/session/$sessionId/touch/perform')
self.command_executor._commands[Command.MULTI_ACTION] = \
('POST', '/session/$sessionId/touch/multi/perform')
self.command_executor._commands[Command.GET_APP_STRINGS] = \
('POST', '/session/$sessionId/appium/app/strings')
# Needed for Selendroid
self.command_executor._commands[Command.KEY_EVENT] = \
('POST', '/session/$sessionId/appium/device/keyevent')
self.command_executor._commands[Command.PRESS_KEYCODE] = \
('POST', '/session/$sessionId/appium/device/press_keycode')
self.command_executor._commands[Command.LONG_PRESS_KEYCODE] = \
('POST', '/session/$sessionId/appium/device/long_press_keycode')
self.command_executor._commands[Command.GET_CURRENT_ACTIVITY] = \
('GET', '/session/$sessionId/appium/device/current_activity')
self.command_executor._commands[Command.SET_IMMEDIATE_VALUE] = \
('POST', '/session/$sessionId/appium/element/$id/value')
self.command_executor._commands[Command.PULL_FILE] = \
('POST', '/session/$sessionId/appium/device/pull_file')
self.command_executor._commands[Command.PULL_FOLDER] = \
('POST', '/session/$sessionId/appium/device/pull_folder')
self.command_executor._commands[Command.PUSH_FILE] = \
('POST', '/session/$sessionId/appium/device/push_file')
self.command_executor._commands[Command.BACKGROUND] = \
('POST', '/session/$sessionId/appium/app/background')
self.command_executor._commands[Command.IS_APP_INSTALLED] = \
('POST', '/session/$sessionId/appium/device/app_installed')
self.command_executor._commands[Command.INSTALL_APP] = \
('POST', '/session/$sessionId/appium/device/install_app')
self.command_executor._commands[Command.REMOVE_APP] = \
('POST', '/session/$sessionId/appium/device/remove_app')
self.command_executor._commands[Command.START_ACTIVITY] = \
('POST', '/session/$sessionId/appium/device/start_activity')
self.command_executor._commands[Command.LAUNCH_APP] = \
('POST', '/session/$sessionId/appium/app/launch')
self.command_executor._commands[Command.CLOSE_APP] = \
('POST', '/session/$sessionId/appium/app/close')
self.command_executor._commands[Command.END_TEST_COVERAGE] = \
('POST', '/session/$sessionId/appium/app/end_test_coverage')
self.command_executor._commands[Command.LOCK] = \
('POST', '/session/$sessionId/appium/device/lock')
self.command_executor._commands[Command.SHAKE] = \
('POST', '/session/$sessionId/appium/device/shake')
self.command_executor._commands[Command.TOUCH_ID] = \
('POST', '/session/$sessionId/appium/simulator/touch_id')
self.command_executor._commands[Command.RESET] = \
('POST', '/session/$sessionId/appium/app/reset')
self.command_executor._commands[Command.HIDE_KEYBOARD] = \
('POST', '/session/$sessionId/appium/device/hide_keyboard')
self.command_executor._commands[Command.OPEN_NOTIFICATIONS] = \
('POST', '/session/$sessionId/appium/device/open_notifications')
self.command_executor._commands[Command.GET_NETWORK_CONNECTION] = \
('GET', '/session/$sessionId/network_connection')
self.command_executor._commands[Command.SET_NETWORK_CONNECTION] = \
('POST', '/session/$sessionId/network_connection')
self.command_executor._commands[Command.GET_AVAILABLE_IME_ENGINES] = \
('GET', '/session/$sessionId/ime/available_engines')
self.command_executor._commands[Command.IS_IME_ACTIVE] = \
('GET', '/session/$sessionId/ime/activated')
self.command_executor._commands[Command.ACTIVATE_IME_ENGINE] = \
('POST', '/session/$sessionId/ime/activate')
self.command_executor._commands[Command.DEACTIVATE_IME_ENGINE] = \
('POST', '/session/$sessionId/ime/deactivate')
self.command_executor._commands[Command.GET_ACTIVE_IME_ENGINE] = \
('GET', '/session/$sessionId/ime/active_engine')
self.command_executor._commands[Command.REPLACE_KEYS] = \
('POST', '/session/$sessionId/appium/element/$id/replace_value')
self.command_executor._commands[Command.GET_SETTINGS] = \
('GET', '/session/$sessionId/appium/settings')
self.command_executor._commands[Command.UPDATE_SETTINGS] = \
('POST', '/session/$sessionId/appium/settings')
self.command_executor._commands[Command.TOGGLE_LOCATION_SERVICES] = \
('POST', '/session/$sessionId/appium/device/toggle_location_services')
self.command_executor._commands[Command.SET_LOCATION] = \
('POST', '/session/$sessionId/location')
self.command_executor._commands[Command.LOCATION_IN_VIEW] = \
('GET', '/session/$sessionId/element/$id/location_in_view')
self.command_executor._commands[Command.GET_DEVICE_TIME] = \
('GET', '/session/$sessionId/appium/device/system_time')
self.command_executor._commands[Command.CLEAR] = \
('POST', '/session/$sessionId/element/$id/clear')
浙公网安备 33010602011771号