webdriver.extensions.action_helpers.ActionHelpers(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
drag_and_drop(origin_el: appium.webdriver.webelement.WebElement, destination_el: appium.webdriver.webelement.WebElement) → T¶Drag the origin element to the destination element
originEl (appium.webdriver.webelement.WebElement) – the element to drag
destinationEl (appium.webdriver.webelement.WebElement) – the element to drag to
appium.webdriver.webelement.WebElement
flick(start_x: int, start_y: int, end_x: int, end_y: int) → T¶Flick from one point to another point.
start_x (int) – x-coordinate at which to start
start_y (int) – y-coordinate at which to start
end_x (int) – x-coordinate at which to stop
end_y (int) – y-coordinate at which to stop
driver.flick(100, 100, 100, 400)
appium.webdriver.webelement.WebElement
scroll(origin_el: appium.webdriver.webelement.WebElement, destination_el: appium.webdriver.webelement.WebElement, duration: Optional[int] = None) → T¶Scrolls from one element to another
originalEl (appium.webdriver.webelement.WebElement) – the element from which to being scrolling
destinationEl (appium.webdriver.webelement.WebElement) – the element to scroll to
duration (int) – a duration after pressing originalEl and move the element to destinationEl. Default is 600 ms for W3C spec. Zero for MJSONWP.
driver.scroll(el1, el2)
appium.webdriver.webelement.WebElement
swipe(start_x: int, start_y: int, end_x: int, end_y: int, duration: int = 0) → T¶Swipe from one point to another point, for an optional duration.
start_x (int) – x-coordinate at which to start
start_y (int) – y-coordinate at which to start
end_x (int) – x-coordinate at which to stop
end_y (int) – y-coordinate at which to stop
duration (int, optional) – time to take the swipe, in ms.
driver.swipe(100, 100, 100, 400)
appium.webdriver.webelement.WebElement
tap(positions: List[Tuple[int, int]], duration: Optional[int] = None) → T¶Taps on an particular place with up to five fingers, holding for a certain time
positions (list of tuple) – an array of tuples representing the x/y coordinates of
the fingers to tap. Length can be up to five.
duration (int, optional) – length of time to tap, in ms
driver.tap([(100, 20), (100, 60), (100, 100)], 500)
appium.webdriver.webelement.WebElement
webdriver.extensions.applications.Applications(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
activate_app(app_id: str) → T¶Activates the application if it is not running or is running in the background.
app_id (str) – the application id to be activated
appium.webdriver.webdriver.WebDriver
app_strings(language: str = None, string_file: str = None) → Dict[str, str]¶Returns the application strings from the device for the specified language.
language (str) – strings language code
string_file (str) – the name of the string file to query
The key is string id and the value is the content.
Dict[str, str]
background_app(seconds: int) → T¶Puts the application in the background on the device for a certain duration.
seconds (int) – the duration for the application to remain in the background
appium.webdriver.webdriver.WebDriver
close_app() → T¶Stop the running application, specified in the desired capabilities, on the device.
appium.webdriver.webdriver.WebDriver
install_app(app_path: str, **options: Any) → T¶Install the application found at app_path on the device.
app_path (str) – the local or remote path to the application to install
replace (bool) – [Android only] whether to reinstall/upgrade the package if it is already present on the device under test. True by default
timeout (int) – [Android only] how much time to wait for the installation to complete. 60000ms by default.
allowTestPackages (bool) – [Android only] whether to allow installation of packages marked as test in the manifest. False by default
useSdcard (bool) – [Android only] whether to use the SD card to install the app. False by default
grantPermissions (bool) – [Android only] whether to automatically grant application permissions on Android 6+ after the installation completes. False by default
appium.webdriver.webdriver.WebDriver
is_app_installed(bundle_id: str) → bool¶Checks whether the application specified by bundle_id is installed on the device.
bundle_id (str) – the id of the application to query
True if app is installed
bool
launch_app() → T¶Start on the device the application specified in the desired capabilities.
appium.webdriver.webdriver.WebDriver
query_app_state(app_id: str) → int¶Queries the state of the application.
app_id (str) – the application id to be queried
One of possible application state constants. See ApplicationState class for more details.
remove_app(app_id: str, **options: Any) → T¶Remove the specified application from the device.
app_id (str) – the application id to be removed
keepData (bool) – [Android only] whether to keep application data and caches after it is uninstalled. False by default
timeout (int) – [Android only] how much time to wait for the uninstall to complete. 20000ms by default.
appium.webdriver.webdriver.WebDriver
reset() → T¶Resets the current application on the device.
terminate_app(app_id: str, **options: Any) → bool¶Terminates the application if it is running.
app_id (str) – the application id to be terminates
timeout (int) – [Android only] how much time to wait for the uninstall to complete. 500ms by default.
True if the app has been successfully terminated
bool
webdriver.extensions.clipboard.Clipboard(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
get_clipboard(content_type: str = 'plaintext') → bytes¶Receives the content of the system clipboard
content_type (str) – One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT is supported on Android
Clipboard content. Or return an empty string if the clipboard is empty
base64-encoded string
get_clipboard_text() → str¶Receives the text of the system clipboard
The actual clipboard text or an empty string if the clipboard is empty
str
set_clipboard(content: bytes, content_type: str = 'plaintext', label: Optional[str] = None) → T¶Set the content of the system clipboard
content (bytes) – The content to be set as bytearray string
content_type (str) – One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT is supported on Android
label (str, optional) – label argument, which only works for Android
appium.webdriver.webdriver.WebDriver
set_clipboard_text(text: str, label: Optional[str] = None) → T¶Copies the given text to the system clipboard
text (str) – The text to be set
label (str, optional) – label argument, which only works for Android
appium.webdriver.webdriver.WebDriver
webdriver.extensions.context.Context(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
context¶Returns the current context of the current session.
driver.context
The context of the current session
str
contexts¶Returns the contexts within the current session.
driver.contexts
The contexts within the current session
list of str
current_context¶Returns the current context of the current session.
driver.current_context
The context of the current session
str
webdriver.extensions.device_time.DeviceTime(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
device_time¶Returns the date and time from the device.
The date and time
str
get_device_time(format: Optional[str] = None) → str¶Returns the date and time from the device.
format (str, optional) – The set of format specifiers. Read https://momentjs.com/docs/
to get the full list of supported datetime format specifiers.
If unset, return device_time() as default format is YYYY-MM-DDTHH:mm:ssZ,
which complies to ISO-8601
self.driver.get_device_time()
self.driver.get_device_time(“YYYY-MM-DD”)
The date and time
str
webdriver.extensions.execute_driver.ExecuteDriver(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
execute_driver(script: str, script_type: str = 'webdriverio', timeout_ms: Optional[int] = None) → Any¶Run a set of script against the current session, allowing execution of many commands in one Appium request. Please read http://appium.io/docs/en/commands/session/execute-driver for more details about the acceptable scripts and the output format.
script (str) – The string consisting of the script itself
script_type (str) – The name of the script type. Defaults to ‘webdriverio’.
timeout_ms (int, optional) – The number of ms Appium should wait for the script to finish before killing it due to timeout_ms.
self.driver.execute_driver(script=’return [];’)
self.driver.execute_driver(script=’return [];’, script_type=’webdriverio’)
self.driver.execute_driver(script=’return [];’, script_type=’webdriverio’, timeout_ms=10000)
The result of the script. It has ‘result’ and ‘logs’ keys.
ExecuteDriver.Result
WebDriverException – If something error happenes in the script. The message has the original error message.
webdriver.extensions.execute_mobile_command.ExecuteMobileCommand(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
battery_info¶Retrieves battery information for the device under test.
Any value lower than 0 means the level cannot be retrieved
1: Unplugged 2: Charging 3: Full Any other value means the state cannot be retrieved
2: Charging 3: Discharging 4: Not charging 5: Full Any other value means the state cannot be retrieved
dict
Sends a physical button name to the device to simulate the user pressing.
iOS only. Possible button names can be found in https://github.com/appium/WebDriverAgent/blob/master/WebDriverAgentLib/Categories/XCUIDevice%2BFBHelpers.h
button_name (str) – the button name to be sent to the device
appium.webdriver.webdriver.WebDriver
webdriver.extensions.hw_actions.HardwareActions(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
finger_print(finger_id: int) → Any¶Authenticate users by using their finger print scans on supported Android emulators.
finger_id (int) – Finger prints stored in Android Keystore system (from 1 to 10)
TODO
is_locked() → bool¶Checks whether the device is locked.
True if the device is locked
bool
lock(seconds: Optional[int] = None) → T¶Lock the device. No changes are made if the device is already unlocked.
seconds (int, optional) – The duration to lock the device, in seconds.
The device is going to be locked forever until unlock is called
if it equals or is less than zero, otherwise this call blocks until
the timeout expires and unlocks the screen automatically.
appium.webdriver.webdriver.WebDriver
shake() → T¶Shake the device.
appium.webdriver.webdriver.WebDriver
toggle_touch_id_enrollment() → T¶Toggle enroll touchId on iOS Simulator
appium.webdriver.webdriver.WebDriver
touch_id(match: bool) → T¶Simulate touchId on iOS Simulator
match (bool) – Simulates a successful touch (True) or a failed touch (False)
appium.webdriver.webdriver.WebDriver
unlock() → T¶Unlock the device. No changes are made if the device is already locked.
appium.webdriver.webdriver.WebDriver
webdriver.extensions.images_comparison.ImagesComparison(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
find_image_occurrence(base64_full_image: bytes, base64_partial_image: bytes, **opts: Any) → Dict[str, Union[bytes, Dict]]¶Performs images matching by template to find possible occurrence of the partial image in the full image.
Read https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html for more details on this topic. The method supports all image formats, which are supported by OpenCV itself.
base64_full_image (bytes) – base64-encoded content of the full image
base64_partial_image (bytes) – base64-encoded content of the partial image
visualize (bool) – Set it to True in order to return the visualization of the matching operation. False by default
operation. This entry is only present if visualize option is enabled
The rect is represented by a dictionary with ‘x’, ‘y’, ‘width’ and ‘height’ keys
The dictionary containing the following entries
get_images_similarity(base64_image1: bytes, base64_image2: bytes, **opts: Any) → Dict[str, Union[bytes, Dict]]¶Performs images matching to calculate the similarity score between them.
The flow there is similar to the one used in find_image_occurrence, but it is mandatory that both images are of equal resolution. The method supports all image formats, which are supported by OpenCV itself.
base64_image1 (bytes) – base64-encoded content of the first image
base64_image2 (bytes) – base64-encoded content of the second image
visualize (bool) – Set it to True in order to return the visualization of the matching operation. False by default
operation. This entry is only present if visualize option is enabled
1.0 is the highest score (means both images are totally equal).
The dictionary containing the following entries
match_images_features(base64_image1: bytes, base64_image2: bytes, **opts: Any) → Dict[str, Any]¶Performs images matching by features.
Read https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html for more details on this topic. The method supports all image formats, which are supported by OpenCV itself.
base64_image1 (bytes) – base64-encoded content of the first image
base64_image2 (bytes) – base64-encoded content of the second image
visualize (bool) – Set it to True in order to return the visualization of the matching operation. matching visualization. False by default
detectorName (str) – One of possible feature detector names: ‘AKAZE’, ‘AGAST’, ‘BRISK’, ‘FAST’, ‘GFTT’, ‘KAZE’, ‘MSER’, ‘SIFT’, ‘ORB’ Some of these detectors are not enabled in the default OpenCV deployment. ‘ORB’ By default.
matchFunc (str) – One of supported matching functions names: ‘FlannBased’, ‘BruteForce’, ‘BruteForceL1’, ‘BruteForceHamming’, ‘BruteForceHammingLut’, ‘BruteForceSL2’ ‘BruteForce’ by default
goodMatchesFactor (int) – The maximum count of “good” matches (e. g. with minimal distances). This count is unlimited by default.
operation. This entry is only present if visualize option is enabled
The more matching edges there are no both images the more similar they are.
It is equal to count if goodMatchesFactor does not limit the matches, otherwise it contains the total count of matches before goodMatchesFactor is applied.
with ‘x’ and ‘y’ keys
were found. The rect is represented by a dictionary with ‘x’, ‘y’, ‘width’ and ‘height’ keys
with ‘x’ and ‘y’ keys
were found. The rect is represented by a dictionary with ‘x’, ‘y’, ‘width’ and ‘height’ keys
The dictionary containing the following entries
webdriver.extensions.ime.IME(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
activate_ime_engine(engine: str) → T¶Activates the given IME engine on the device.
Android only.
engine (str) – the package and activity of the IME engine to activate (e.g., ‘com.android.inputmethod.latin/.LatinIME’)
appium.webdriver.webdriver.WebDriver
active_ime_engine¶Returns the activity and package of the currently active IME engine(e.g., ‘com.android.inputmethod.latin/.LatinIME’).
Android only.
The activity and package of the currently active IME engine
str
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.
The available input methods for an Android device
list of str
deactivate_ime_engine() → T¶Deactivates the currently active IME engine on the device.
Android only.
appium.webdriver.webdriver.WebDriver
is_ime_active() → bool¶Checks whether the device has IME service active. Android only.
True if IME service is active
bool
webdriver.extensions.keyboard.Keyboard(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
hide_keyboard(key_name: Optional[str] = None, key: Optional[str] = None, strategy: Optional[str] = None) → T¶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.
key_name (str, optional) – key to press
key (str, optional) –
strategy (str, optional) – strategy for closing the keyboard (e.g., tapOutside)
is_keyboard_shown() → bool¶Attempts to detect whether a software keyboard is present
True if keyboard is shown
bool
keyevent(keycode: int, metastate: Optional[int] = None) → T¶Sends a keycode to the device.
Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.
keycode (int) – the keycode to be sent to the device
metastate (int, optional) – meta information about the keycode being sent
appium.webdriver.webdriver.WebDriver
long_press_keycode(keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) → T¶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.
keycode (int) – the keycode to be sent to the device
metastate (int, optional) – meta information about the keycode being sent
flags (int, optional) – the set of key event flags
appium.webdriver.webdriver.WebDriver
press_keycode(keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) → T¶Sends a keycode to the device.
Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.
keycode (int) – the keycode to be sent to the device
metastate (int, optional) – meta information about the keycode being sent
flags (int, optional) – the set of key event flags
appium.webdriver.webdriver.WebDriver
webdriver.extensions.location.Location(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
location¶Retrieves the current location
latitude (float)
longitude (float)
altitude (float)
set_location(latitude: Union[float, str], longitude: Union[float, str], altitude: Union[float, str] = None) → T¶Set the location of the device
latitude (Union[float, str]) – String or numeric value between -90.0 and 90.00
longitude (Union[float, str]) – String or numeric value between -180.0 and 180.0
altitude (Union[float, str], optional) – String or numeric value (Android real device only)
appium.webdriver.webdriver.WebDriver
toggle_location_services() → T¶Toggle the location services on the device.
Android only.
appium.webdriver.webdriver.WebDriver
webdriver.extensions.log_event.LogEvent(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
get_events(type: List[str] = None) → Dict[str, Union[str, int]]¶Retrieves events information from the current session (Since Appium 1.16.0)
type (list of str) – The event type to filter with
events = driver.get_events()
events = driver.get_events([‘appium:funEvent’])
cmd: (str) The command name that has been sent to the appium server startTime: (int) Received time endTime: (int) Response time
dict
log_event(vendor: str, event: str) → T¶Log a custom event on the Appium server. (Since Appium 1.16.0)
vendor (str) – The vendor to log
event (str) – The event to log
driver.log_event(‘appium’, ‘funEvent’)
appium.webdriver.webdriver.WebDriver
webdriver.extensions.remote_fs.RemoteFS(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
pull_file(path: str) → str¶Retrieves the file at path.
path (str) – the path to the file on the device
The file’s contents encoded as Base64.
str
pull_folder(path: str) → str¶Retrieves a folder at path.
path (str) – the path to the folder on the device
The folder’s contents zipped and encoded as Base64.
str
push_file(destination_path: str, base64data: Optional[str] = None, source_path: Optional[str] = None) → T¶Puts the data from the file at source_path, encoded as Base64, in the file specified as path.
Specify either base64data or source_path, if both specified default to source_path
destination_path (str) – the location on the device/simulator where the local file contents should be saved
base64data (str, optional) – file contents, encoded as Base64, to be written to the file on the device/simulator
source_path (str, optional) – local file path for the file to be loaded on device
appium.webdriver.webdriver.WebDriver
webdriver.extensions.screen_record.ScreenRecord(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
start_recording_screen(**options: Any) → Union[bytes, str]¶Start asynchronous screen recording process.
remotePath (str) – The remotePath upload option is the path to the remote location, where the resulting video from the previous screen recording should be uploaded. The following protocols are supported: http/https (multipart), ftp. Missing value (the default setting) means the content of the resulting file should be encoded as Base64 and passed as the endpoint response value, but an exception will be thrown if the generated media file is too big to fit into the available process memory. This option only has an effect if there is/was an active screen recording session and forced restart is not enabled (the default setting).
user (str) – The name of the user for the remote authentication. Only has an effect if both remotePath and password are set.
password (str) – The password for the remote authentication. Only has an effect if both remotePath and user are set.
method (str) – The HTTP method name (‘PUT’/’POST’). PUT method is used by default. Only has an effect if remotePath is set.
timeLimit (int) – The actual time limit of the recorded video in seconds. The default value for both iOS and Android is 180 seconds (3 minutes). The maximum value for Android is 3 minutes. The maximum value for iOS is 10 minutes.
forcedRestart (bool) – Whether to ignore the result of previous capture and start a new recording immediately (True value). By default (False) the endpoint will try to catch and return the result of the previous capture if it’s still available.
bugReport (str) – Makes the recorder to display an additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs. This option is only supported since API level 27 (Android P).
videoQuality (str) – [iOS only] The video encoding quality: ‘low’, ‘medium’, ‘high’, ‘photo’. Defaults to ‘medium’.
videoType (str) – [iOS only] The format of the screen capture to be recorded. Available formats: Execute ffmpeg -codecs in the terminal to see the list of supported video codecs. ‘mjpeg’ by default. (Since Appium 1.10.0)
videoFps (int) – [iOS only] The Frames Per Second rate of the recorded video. Change this value if the resulting video is too slow or too fast. Defaults to 10. This can decrease the resulting file size.
videoFilters (str) – [iOS only] The FFMPEG video filters to apply. These filters allow to scale, flip, rotate and do many other useful transformations on the source video stream. The format of the property must comply with https://ffmpeg.org/ffmpeg-filters.html. (Since Appium 1.15)
videoScale (str) – [iOS only] The scaling value to apply. Read https://trac.ffmpeg.org/wiki/Scaling for possible values. No scale is applied by default. If videoFilters are set then the scale setting is effectively ignored. (Since Appium 1.10.0)
pixelFormat (str) – [iOS only] Output pixel format. Run ffmpeg -pix_fmts to list possible values. For Quicktime compatibility, set to “yuv420p” along with videoType: “libx264”. (Since Appium 1.12.0)
videoSize (str) – [Android only] The video size of the generated media file. The format is WIDTHxHEIGHT. The default value is the device’s native display resolution (if supported), 1280x720 if not. For best results, use a size supported by your device’s Advanced Video Coding (AVC) encoder.
bitRate (int) – [Android only] The video bit rate for the video, in megabits per second. The default value is 4. You can increase the bit rate to improve video quality, but doing so results in larger movie files.
if stop_recording_screen isn’t called after previous start_recording_screen. Otherwise returns an empty string.
bytes
stop_recording_screen(**options: Any) → bytes¶Gather the output from the previously started screen recording to a media file.
remotePath (str) – The remotePath upload option is the path to the remote location, where the resulting video should be uploaded. The following protocols are supported: http/https (multipart), ftp. Missing value (the default setting) means the content of the resulting file should be encoded as Base64 and passed as the endpoint response value, but an exception will be thrown if the generated media file is too big to fit into the available process memory.
user (str) – The name of the user for the remote authentication. Only has an effect if both remotePath and password are set.
password (str) – The password for the remote authentication. Only has an effect if both remotePath and user are set.
method (str) – The HTTP method name (‘PUT’/’POST’). PUT method is used by default. Only has an effect if remotePath is set.
if the file has been successfully uploaded to a remote location (depends on the actual remotePath value).
bytes
webdriver.extensions.session.Session(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
all_sessions¶Retrieves all sessions that are open
sessions = driver.all_sessions
containing all open sessions
list of dict
events¶Retrieves events information from the current session
events = driver.events
containing events timing information from the current session
dict
session¶Retrieves session information from the current session
session = driver.session
containing information from the current session
dict
webdriver.extensions.settings.Settings(command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)¶Bases: selenium.webdriver.remote.webdriver.WebDriver
get_settings() → Dict[str, Any]¶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
Current settings
dict
update_settings(settings: Dict[str, Any]) → T¶Set settings for the current session.
For more on settings, see: https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md
settings (dict) – dictionary of settings to apply to the current test session