Driver

ContestoWebDriver

class contesto.core.driver.ContestoWebDriver(*args, **kwargs)

Adds a cookie to your current session.

Args:
  • cookie_dict: A dictionary object, with required keys - “name” and “value”;
    optional keys - “path”, “domain”, “secure”, “expiry”
Usage:
driver.add_cookie({‘name’ : ‘foo’, ‘value’ : ‘bar’}) driver.add_cookie({‘name’ : ‘foo’, ‘value’ : ‘bar’, ‘path’ : ‘/’}) driver.add_cookie({‘name’ : ‘foo’, ‘value’ : ‘bar’, ‘path’ : ‘/’, ‘secure’:True})
application_cache

Returns a ApplicationCache Object to interact with the browser app cache

back()

Goes one step backward in the browser history.

Usage:driver.back()
browser
Return type:str
close()

Closes the current window.

Usage:driver.close()
create_web_element(element_id)

Creates a web element with the specified element_id.

current_url

Gets the URL of the current page.

Usage:driver.current_url
current_window_handle

Returns the handle of the current window.

Usage:driver.current_window_handle
delete_all_cookies()

Delete all cookies in the scope of the session.

Usage:driver.delete_all_cookies()

Deletes a single cookie with the given name.

Usage:driver.delete_cookie(‘my_cookie’)
desired_capabilities

returns the drivers current desired capabilities being used

execute(driver_command, params=None)
execute_async_script(script, *args)

Asynchronously Executes JavaScript in the current window/frame.

Args:
  • script: The JavaScript to execute.
  • *args: Any applicable arguments for your JavaScript.
Usage:

driver.execute_async_script(‘document.title’)
execute_script(script, *args)

Synchronously Executes JavaScript in the current window/frame.

Args:
  • script: The JavaScript to execute.
  • *args: Any applicable arguments for your JavaScript.
Usage:

driver.execute_script(‘document.title’)
file_detector
find_element(by='id', value=None)

‘Private’ method used by the find_element_by_* methods.

Usage:Use the corresponding find_element_by_* instead of this.
Return type:WebElement
find_element_by_class_name(name)

Finds an element by class name.

Args:
  • name: The class name of the element to find.
Usage:

driver.find_element_by_class_name(‘foo’)
find_element_by_css_selector(css_selector)

Finds an element by css selector.

Args:
  • css_selector: The css selector to use when finding elements.
Usage:

driver.find_element_by_css_selector(‘#foo’)
find_element_by_id(id_)

Finds an element by id.

Args:
  • id_ - The id of the element to be found.
Usage:

driver.find_element_by_id(‘foo’)
find_element_by_link_text(link_text)

Finds an element by link text.

Args:
  • link_text: The text of the element to be found.
Usage:

driver.find_element_by_link_text(‘Sign In’)
find_element_by_name(name)

Finds an element by name.

Args:
  • name: The name of the element to find.
Usage:

driver.find_element_by_name(‘foo’)
find_element_by_partial_link_text(link_text)

Finds an element by a partial match of its link text.

Args:
  • link_text: The text of the element to partially match on.
Usage:

driver.find_element_by_partial_link_text(‘Sign’)
find_element_by_sizzle(sizzle_selector)
Return type:ContestoWebElement
Raise:ElementNotFound
find_element_by_tag_name(name)

Finds an element by tag name.

Args:
  • name: The tag name of the element to find.
Usage:

driver.find_element_by_tag_name(‘foo’)
find_element_by_xpath(xpath)

Finds an element by xpath.

Args:
  • xpath - The xpath locator of the element to find.
Usage:

driver.find_element_by_xpath(‘//div/td[1]’)
find_elements(by='id', value=None)

‘Private’ method used by the find_elements_by_* methods.

Usage:Use the corresponding find_elements_by_* instead of this.
Return type:list of WebElement
find_elements_by_class_name(name)

Finds elements by class name.

Args:
  • name: The class name of the elements to find.
Usage:

driver.find_elements_by_class_name(‘foo’)
find_elements_by_css_selector(css_selector)

Finds elements by css selector.

Args:
  • css_selector: The css selector to use when finding elements.
Usage:

driver.find_elements_by_css_selector(‘.foo’)
find_elements_by_id(id_)

Finds multiple elements by id.

Args:
  • id_ - The id of the elements to be found.
Usage:

driver.find_elements_by_id(‘foo’)
find_elements_by_link_text(text)

Finds elements by link text.

Args:
  • link_text: The text of the elements to be found.
Usage:

driver.find_elements_by_link_text(‘Sign In’)
find_elements_by_name(name)

Finds elements by name.

Args:
  • name: The name of the elements to find.
Usage:

driver.find_elements_by_name(‘foo’)
find_elements_by_partial_link_text(link_text)

Finds elements by a partial match of their link text.

Args:
  • link_text: The text of the element to partial match on.
Usage:

driver.find_element_by_partial_link_text(‘Sign’)
find_elements_by_sizzle(sizzle_selector)
Return type:list of ContestoWebElement
Raise:ElementNotFound
find_elements_by_tag_name(name)

Finds elements by tag name.

Args:
  • name: The tag name the use when finding elements.
Usage:

driver.find_elements_by_tag_name(‘foo’)
find_elements_by_xpath(xpath)

Finds multiple elements by xpath.

Args:
  • xpath - The xpath locator of the elements to be found.
Usage:

driver.find_elements_by_xpath(“//div[contains(@class, ‘foo’)]”)
forward()

Goes one step forward in the browser history.

Usage:driver.forward()
get(url)

Loads a web page in the current browser session.

Get a single cookie by name. Returns the cookie if found, None if not.

Usage:driver.get_cookie(‘my_cookie’)
get_cookies()

Returns a set of dictionaries, corresponding to cookies visible in the current session.

Usage:driver.get_cookies()
get_log(log_type)

Gets the log for a given log type

Args:
  • log_type: type of log that which will be returned
Usage:

driver.get_log(‘browser’) driver.get_log(‘driver’) driver.get_log(‘client’) driver.get_log(‘server’)
get_screenshot_as_base64()
Gets the screenshot of the current window as a base64 encoded string
which is useful in embedded images in HTML.
Usage:driver.get_screenshot_as_base64()
get_screenshot_as_file(filename)
Gets the screenshot of the current window. Returns False if there is
any IOError, else returns True. Use full paths in your filename.
Args:
  • filename: The full path you wish to save your screenshot to.
Usage:

driver.get_screenshot_as_file(‘/Screenshots/foo.png’)
get_screenshot_as_png()

Gets the screenshot of the current window as a binary data.

Usage:driver.get_screenshot_as_png()
get_window_position(windowHandle='current')

Gets the x,y position of the current window.

Usage:driver.get_window_position()
get_window_size(windowHandle='current')

Gets the width and height of the current window.

Usage:driver.get_window_size()
implicitly_wait(time_to_wait)
Sets a sticky timeout to implicitly wait for an element to be found,
or a command to complete. This method only needs to be called one time per session. To set the timeout for calls to execute_async_script, see set_script_timeout.
Args:
  • time_to_wait: Amount of time to wait (in seconds)
Usage:

driver.implicitly_wait(30)
log_types

Gets a list of the available log types

Usage:driver.log_types
maximize_window()

Maximizes the current window that webdriver is using

mobile
name

Returns the name of the underlying browser for this instance.

Usage:
  • driver.name
orientation

Gets the current orientation of the device

Usage:orientation = driver.orientation
page_loaded()
page_source

Gets the source of the current page.

Usage:driver.page_source
quit()

Quits the driver and closes every associated window.

Usage:driver.quit()
refresh()

Refreshes the current page.

Usage:driver.refresh()
save_screenshot(filename)
Gets the screenshot of the current window. Returns False if there is
any IOError, else returns True. Use full paths in your filename.
Args:
  • filename: The full path you wish to save your screenshot to.
Usage:

driver.get_screenshot_as_file(‘/Screenshots/foo.png’)
set_page_load_timeout(time_to_wait)
Set the amount of time to wait for a page load to complete
before throwing an error.
Args:
  • time_to_wait: The amount of time to wait
Usage:

driver.set_page_load_timeout(30)
set_script_timeout(time_to_wait)
Set the amount of time that the script should wait during an
execute_async_script call before throwing an error.
Args:
  • time_to_wait: The amount of time to wait (in seconds)
Usage:

driver.set_script_timeout(30)
set_window_position(x, y, windowHandle='current')

Sets the x,y position of the current window. (window.moveTo)

Args:
  • x: the x-coordinate in pixels to set the window position
  • y: the y-coordinate in pixels to set the window position
Usage:

driver.set_window_position(0,0)
set_window_size(width, height, windowHandle='current')

Sets the width and height of the current window. (window.resizeTo)

Args:
  • width: the width in pixels to set the window to
  • height: the height in pixels to set the window to
Usage:

driver.set_window_size(800,600)
start_client()

Called before starting a new session. This method may be overridden to define custom startup behavior.

start_session(desired_capabilities, browser_profile=None)

Creates a new session with the desired capabilities.

Args:
  • browser_name - The name of the browser to request.
  • version - Which browser version to request.
  • platform - Which platform to request the browser on.
  • javascript_enabled - Whether the new session should support JavaScript.
  • browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only used if Firefox is requested.
stop_client()

Called after executing a quit command. This method may be overridden to define custom shutdown behavior.

switch_to
switch_to_active_element()

Deprecated use driver.switch_to.active_element

switch_to_alert()

Deprecated use driver.switch_to.alert

switch_to_default_content()

Deprecated use driver.switch_to.default_content

switch_to_frame(frame_reference)

Deprecated use driver.switch_to.frame

switch_to_window(window_name)

Deprecated use driver.switch_to.window

testMethodName
Return type:str
title

Returns the title of the current page.

Usage:driver.title
window_handles

Returns the handles of all windows within the current session.

Usage:driver.window_handles

ContestoMobileDriver

class contesto.core.driver.ContestoMobileDriver(*args, **kwargs)
activate_ime_engine(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’)
active_ime_engine

Returns the activity and package of the currently active IME engine (e.g., ‘com.android.inputmethod.latin/.LatinIME’). Android only.

Adds a cookie to your current session.

Args:
  • cookie_dict: A dictionary object, with required keys - “name” and “value”;
    optional keys - “path”, “domain”, “secure”, “expiry”
Usage:
driver.add_cookie({‘name’ : ‘foo’, ‘value’ : ‘bar’}) driver.add_cookie({‘name’ : ‘foo’, ‘value’ : ‘bar’, ‘path’ : ‘/’}) driver.add_cookie({‘name’ : ‘foo’, ‘value’ : ‘bar’, ‘path’ : ‘/’, ‘secure’:True})
app_strings(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
application_cache

Returns a ApplicationCache Object to interact with the browser app cache

available_ime_engines

Get the available input methods for an Android device. Package and activity are returned (e.g., [‘com.android.inputmethod.latin/.LatinIME’]) Android only.

back()

Goes one step backward in the browser history.

Usage:driver.back()
background_app(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
close()

Closes the current window.

Usage:driver.close()
close_app()

Stop the running application, specified in the desired capabilities, on the device.

context

Returns the current context of the current session.

Usage:driver.context
contexts

Returns the contexts within the current session.

Usage:driver.contexts
create_web_element(element_id)

Creates a web element with the specified element_id. Overrides method in Selenium WebDriver in order to always give them Appium WebElement

current_activity

Retrieves the current activity on the device.

current_context

Returns the current context of the current session.

Usage:driver.current_context
current_url

Gets the URL of the current page.

Usage:driver.current_url
current_window_handle

Returns the handle of the current window.

Usage:driver.current_window_handle
deactivate_ime_engine()

Deactivates the currently active IME engine on the device. Android only.

delete_all_cookies()

Delete all cookies in the scope of the session.

Usage:driver.delete_all_cookies()

Deletes a single cookie with the given name.

Usage:driver.delete_cookie(‘my_cookie’)
desired_capabilities

returns the drivers current desired capabilities being used

device_time

Returns the date and time fomr the device

drag_and_drop(origin_el, destination_el)

Drag the origin element to the destination element

Args:
  • originEl - the element to drag
  • destinationEl - the element to drag to
end_test_coverage(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
execute(driver_command, params=None)
execute_async_script(script, *args)

Asynchronously Executes JavaScript in the current window/frame.

Args:
  • script: The JavaScript to execute.
  • *args: Any applicable arguments for your JavaScript.
Usage:

driver.execute_async_script(‘document.title’)
execute_script(script, *args)

Synchronously Executes JavaScript in the current window/frame.

Args:
  • script: The JavaScript to execute.
  • *args: Any applicable arguments for your JavaScript.
Usage:

driver.execute_script(‘document.title’)
file_detector
find_element(by='id', value=None)

‘Private’ method used by the find_element_by_* methods.

Usage:Use the corresponding find_element_by_* instead of this.
Return type:WebElement
find_element_by_accessibility_id(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()
find_element_by_android_uiautomator(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]’)
find_element_by_class_name(name)

Finds an element by class name.

Args:
  • name: The class name of the element to find.
Usage:

driver.find_element_by_class_name(‘foo’)
find_element_by_css_selector(css_selector)

Finds an element by css selector.

Args:
  • css_selector: The css selector to use when finding elements.
Usage:

driver.find_element_by_css_selector(‘#foo’)
find_element_by_id(id_)

Finds an element by id.

Args:
  • id_ - The id of the element to be found.
Usage:

driver.find_element_by_id(‘foo’)
find_element_by_ios_predicate(predicate_string)

Find an element by ios predicate string.

Args:
  • predicate_string - The predicate string
Usage:

driver.find_element_by_ios_predicate(‘label == “myLabel”’)
find_element_by_ios_uiautomation(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]’)
find_element_by_link_text(link_text)

Finds an element by link text.

Args:
  • link_text: The text of the element to be found.
Usage:

driver.find_element_by_link_text(‘Sign In’)
find_element_by_name(name)

Finds an element by name.

Args:
  • name: The name of the element to find.
Usage:

driver.find_element_by_name(‘foo’)
find_element_by_partial_link_text(link_text)

Finds an element by a partial match of its link text.

Args:
  • link_text: The text of the element to partially match on.
Usage:

driver.find_element_by_partial_link_text(‘Sign’)
find_element_by_tag_name(name)

Finds an element by tag name.

Args:
  • name: The tag name of the element to find.
Usage:

driver.find_element_by_tag_name(‘foo’)
find_element_by_xpath(xpath)

Finds an element by xpath.

Args:
  • xpath - The xpath locator of the element to find.
Usage:

driver.find_element_by_xpath(‘//div/td[1]’)
find_elements(by='id', value=None)

‘Private’ method used by the find_elements_by_* methods.

Usage:Use the corresponding find_elements_by_* instead of this.
Return type:list of WebElement
find_elements_by_accessibility_id(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()
find_elements_by_android_uiautomator(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]’)
find_elements_by_class_name(name)

Finds elements by class name.

Args:
  • name: The class name of the elements to find.
Usage:

driver.find_elements_by_class_name(‘foo’)
find_elements_by_css_selector(css_selector)

Finds elements by css selector.

Args:
  • css_selector: The css selector to use when finding elements.
Usage:

driver.find_elements_by_css_selector(‘.foo’)
find_elements_by_id(id_)

Finds multiple elements by id.

Args:
  • id_ - The id of the elements to be found.
Usage:

driver.find_elements_by_id(‘foo’)
find_elements_by_ios_predicate(predicate_string)

Finds elements by ios predicate string.

Args:
  • predicate_string - The predicate string
Usage:

driver.find_elements_by_ios_predicate(‘label == “myLabel”’)
find_elements_by_ios_uiautomation(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]’)
find_elements_by_link_text(text)

Finds elements by link text.

Args:
  • link_text: The text of the elements to be found.
Usage:

driver.find_elements_by_link_text(‘Sign In’)
find_elements_by_name(name)

Finds elements by name.

Args:
  • name: The name of the elements to find.
Usage:

driver.find_elements_by_name(‘foo’)
find_elements_by_partial_link_text(link_text)

Finds elements by a partial match of their link text.

Args:
  • link_text: The text of the element to partial match on.
Usage:

driver.find_element_by_partial_link_text(‘Sign’)
find_elements_by_tag_name(name)

Finds elements by tag name.

Args:
  • name: The tag name the use when finding elements.
Usage:

driver.find_elements_by_tag_name(‘foo’)
find_elements_by_xpath(xpath)

Finds multiple elements by xpath.

Args:
  • xpath - The xpath locator of the elements to be found.
Usage:

driver.find_elements_by_xpath(“//div[contains(@class, ‘foo’)]”)
flick(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)
forward()

Goes one step forward in the browser history.

Usage:driver.forward()
get(url)

Loads a web page in the current browser session.

Get a single cookie by name. Returns the cookie if found, None if not.

Usage:driver.get_cookie(‘my_cookie’)
get_cookies()

Returns a set of dictionaries, corresponding to cookies visible in the current session.

Usage:driver.get_cookies()
get_log(log_type)

Gets the log for a given log type

Args:
  • log_type: type of log that which will be returned
Usage:

driver.get_log(‘browser’) driver.get_log(‘driver’) driver.get_log(‘client’) driver.get_log(‘server’)
get_screenshot_as_base64()
Gets the screenshot of the current window as a base64 encoded string
which is useful in embedded images in HTML.
Usage:driver.get_screenshot_as_base64()
get_screenshot_as_file(filename)
Gets the screenshot of the current window. Returns False if there is
any IOError, else returns True. Use full paths in your filename.
Args:
  • filename: The full path you wish to save your screenshot to.
Usage:

driver.get_screenshot_as_file(‘/Screenshots/foo.png’)
get_screenshot_as_png()

Gets the screenshot of the current window as a binary data.

Usage:driver.get_screenshot_as_png()
get_settings()

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

get_window_position(windowHandle='current')

Gets the x,y position of the current window.

Usage:driver.get_window_position()
get_window_size(windowHandle='current')

Gets the width and height of the current window.

Usage:driver.get_window_size()
hide_keyboard(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)
implicitly_wait(time_to_wait)
Sets a sticky timeout to implicitly wait for an element to be found,
or a command to complete. This method only needs to be called one time per session. To set the timeout for calls to execute_async_script, see set_script_timeout.
Args:
  • time_to_wait: Amount of time to wait (in seconds)
Usage:

driver.implicitly_wait(30)
install_app(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
is_app_installed(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
is_ime_active()

Checks whether the device has IME service active. Returns True/False. Android only.

keyevent(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
launch_app()

Start on the device the application specified in the desired capabilities.

lock(seconds)

Lock the device for a certain period of time. iOS only.

Args:
  • the duration to lock the device, in seconds
log_types

Gets a list of the available log types

Usage:driver.log_types
long_press_keycode(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
maximize_window()

Maximizes the current window that webdriver is using

mobile
name

Returns the name of the underlying browser for this instance.

Usage:
  • driver.name
network_connection

Returns an integer bitmask specifying the network connection type. Android only. Possible values are available through the enumeration appium.webdriver.ConnectionType

open_notifications()

Open notification shade in Android (API Level 18 and above)

orientation

Gets the current orientation of the device

Usage:orientation = driver.orientation
page_source

Gets the source of the current page.

Usage:driver.page_source
pinch(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)
press_keycode(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
pull_file(path)

Retrieves the file at path. Returns the file’s content encoded as Base64.

Args:
  • path - the path to the file on the device
pull_folder(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
push_file(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
quit()

Quits the driver and closes every associated window.

Usage:driver.quit()
refresh()

Refreshes the current page.

Usage:driver.refresh()
remove_app(app_id)

Remove the specified application from the device.

Args:
  • app_id - the application id to be removed
reset()

Resets the current application on the device.

save_screenshot(filename)
Gets the screenshot of the current window. Returns False if there is
any IOError, else returns True. Use full paths in your filename.
Args:
  • filename: The full path you wish to save your screenshot to.
Usage:

driver.get_screenshot_as_file(‘/Screenshots/foo.png’)
scroll(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)
set_location(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
set_network_connection(connectionType)

Sets the network connection type. Android only. Possible values:

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
set_page_load_timeout(time_to_wait)
Set the amount of time to wait for a page load to complete
before throwing an error.
Args:
  • time_to_wait: The amount of time to wait
Usage:

driver.set_page_load_timeout(30)
set_script_timeout(time_to_wait)
Set the amount of time that the script should wait during an
execute_async_script call before throwing an error.
Args:
  • time_to_wait: The amount of time to wait (in seconds)
Usage:

driver.set_script_timeout(30)
set_value(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
set_window_position(x, y, windowHandle='current')

Sets the x,y position of the current window. (window.moveTo)

Args:
  • x: the x-coordinate in pixels to set the window position
  • y: the y-coordinate in pixels to set the window position
Usage:

driver.set_window_position(0,0)
set_window_size(width, height, windowHandle='current')

Sets the width and height of the current window. (window.resizeTo)

Args:
  • width: the width in pixels to set the window to
  • height: the height in pixels to set the window to
Usage:

driver.set_window_size(800,600)
shake()

Shake the device.

start_activity(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)?
start_client()

Called before starting a new session. This method may be overridden to define custom startup behavior.

start_session(desired_capabilities, browser_profile=None)

Creates a new session with the desired capabilities.

Args:
  • browser_name - The name of the browser to request.
  • version - Which browser version to request.
  • platform - Which platform to request the browser on.
  • javascript_enabled - Whether the new session should support JavaScript.
  • browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only used if Firefox is requested.
stop_client()

Called after executing a quit command. This method may be overridden to define custom shutdown behavior.

swipe(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)
switch_to
switch_to_active_element()

Deprecated use driver.switch_to.active_element

switch_to_alert()

Deprecated use driver.switch_to.alert

switch_to_default_content()

Deprecated use driver.switch_to.default_content

switch_to_frame(frame_reference)

Deprecated use driver.switch_to.frame

switch_to_window(window_name)

Deprecated use driver.switch_to.window

tap(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)
testMethodName
Return type:str
title

Returns the title of the current page.

Usage:driver.title
toggle_location_services()

Toggle the location services on the device. Android only.

touch_id(match)

Do a fingerprint scan

update_settings(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
wait_activity(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
window_handles

Returns the handles of all windows within the current session.

Usage:driver.window_handles
zoom(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)