From c596608bfde4ed0dc763952712e940000cfb2e67 Mon Sep 17 00:00:00 2001 From: Mori Atsushi Date: Sat, 11 May 2019 00:51:11 +0900 Subject: [PATCH] Update api doc for python (#12625) * Add TODO to python missing api doc * Add api doc * Add doc link * Add api doc * change url --- commands-yml/commands/device/activity/current-activity.yml | 2 +- commands-yml/commands/device/activity/current-package.yml | 2 +- commands-yml/commands/device/activity/start-activity.yml | 2 +- commands-yml/commands/device/app/background-app.yml | 2 +- commands-yml/commands/device/app/close-app.yml | 2 +- commands-yml/commands/device/app/end-test-coverage.yml | 2 +- commands-yml/commands/device/app/get-app-strings.yml | 2 +- commands-yml/commands/device/app/install-app.yml | 2 +- commands-yml/commands/device/app/is-app-installed.yml | 2 +- commands-yml/commands/device/app/launch-app.yml | 2 +- commands-yml/commands/device/app/remove-app.yml | 2 +- commands-yml/commands/device/app/reset-app.yml | 2 +- .../commands/device/authentication/finger-print.yml | 2 +- commands-yml/commands/device/emulator/power_ac.yml | 6 +++++- commands-yml/commands/device/emulator/power_capacity.yml | 6 +++++- commands-yml/commands/device/files/pull-file.yml | 2 +- commands-yml/commands/device/files/pull-folder.yml | 2 +- commands-yml/commands/device/files/push-file.yml | 2 +- commands-yml/commands/device/interactions/is-locked.yml | 4 ++++ commands-yml/commands/device/interactions/lock.yml | 2 +- commands-yml/commands/device/interactions/shake.yml | 2 +- commands-yml/commands/device/interactions/unlock.yml | 1 + commands-yml/commands/device/keys/hide-keyboard.yml | 2 +- commands-yml/commands/device/keys/is-keyboard-shown.yml | 1 + commands-yml/commands/device/keys/long-press-keycode.yml | 2 +- commands-yml/commands/device/keys/press-keycode.yml | 2 +- commands-yml/commands/device/network/gsm-call.yml | 6 +++++- commands-yml/commands/device/network/gsm-signal.yml | 6 +++++- commands-yml/commands/device/network/gsm-voice.yml | 6 +++++- commands-yml/commands/device/network/send-sms.yml | 3 ++- .../commands/device/network/toggle-location-services.yml | 2 +- commands-yml/commands/device/network/toggle-wifi.yml | 1 + .../device/performance-data/get-performance-data.yml | 4 ++++ .../device/performance-data/performance-data-types.yml | 4 ++++ .../device/recording-screen/start-recording-screen.yml | 1 + .../device/recording-screen/stop-recording-screen.yml | 1 + .../device/simulator/toggle-touch-id-enrollment.yml | 2 +- commands-yml/commands/device/simulator/touch-id.yml | 2 +- commands-yml/commands/device/system/open-notifications.yml | 2 +- commands-yml/commands/device/system/system-bars.yml | 6 +++++- commands-yml/commands/device/system/system-time.yml | 2 +- .../commands/element/attributes/location-in-view.yml | 4 ++++ commands-yml/commands/element/attributes/rect.yml | 4 ++++ 43 files changed, 83 insertions(+), 33 deletions(-) diff --git a/commands-yml/commands/device/activity/current-activity.yml b/commands-yml/commands/device/activity/current-activity.yml index 59f7c8c6b..aabdc2215 100644 --- a/commands-yml/commands/device/activity/current-activity.yml +++ b/commands-yml/commands/device/activity/current-activity.yml @@ -30,7 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/StartsActivity.html#currentActivity--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L447" + python: "https://github.com/appium/python-client/blob/master/README.md#retrieving-the-current-running-package-and-activity" javascript_wdio: "http://webdriver.io/api/mobile/currentActivity.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2519" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_activity-instance_method" diff --git a/commands-yml/commands/device/activity/current-package.yml b/commands-yml/commands/device/activity/current-package.yml index 3c823d784..612eb232e 100644 --- a/commands-yml/commands/device/activity/current-package.yml +++ b/commands-yml/commands/device/activity/current-package.yml @@ -27,7 +27,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/StartsActivity.html#getCurrentPackage--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L453" + python: "https://github.com/appium/python-client/blob/master/README.md#retrieving-the-current-running-package-and-activity" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2526" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_package-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#current_package-instance_method" diff --git a/commands-yml/commands/device/activity/start-activity.yml b/commands-yml/commands/device/activity/start-activity.yml index 0f1aa71a7..185a2baef 100644 --- a/commands-yml/commands/device/activity/start-activity.yml +++ b/commands-yml/commands/device/activity/start-activity.yml @@ -34,7 +34,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/AndroidMobileCommandHelper.html#startActivityCommand-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-boolean-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L591" + python: "https://github.com/appium/python-client/blob/master/README.md#start-an-arbitrary-activity" javascript_wdio: "http://webdriver.io/api/mobile/startActivity.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2948" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#start_activity-instance_method" diff --git a/commands-yml/commands/device/app/background-app.yml b/commands-yml/commands/device/app/background-app.yml index 3f3279cd0..51cc8d186 100644 --- a/commands-yml/commands/device/app/background-app.yml +++ b/commands-yml/commands/device/app/background-app.yml @@ -51,7 +51,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#runAppInBackground-java.time.Duration-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L529" + python: "https://github.com/appium/python-client/blob/master/README.md#backgrounding-an-application" javascript_wdio: "http://webdriver.io/api/mobile/background.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2841" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#background_app-instance_method" diff --git a/commands-yml/commands/device/app/close-app.yml b/commands-yml/commands/device/app/close-app.yml index 0d892d94c..cc800b4f6 100644 --- a/commands-yml/commands/device/app/close-app.yml +++ b/commands-yml/commands/device/app/close-app.yml @@ -29,7 +29,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#closeApp--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L584" + python: "https://github.com/appium/python-client/blob/master/README.md#closing-and-launching-an-application" javascript_wdio: "http://webdriver.io/api/mobile/closeApp.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2798" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#close_app-instance_method" diff --git a/commands-yml/commands/device/app/end-test-coverage.yml b/commands-yml/commands/device/app/end-test-coverage.yml index 9409bba39..9dcb10b47 100644 --- a/commands-yml/commands/device/app/end-test-coverage.yml +++ b/commands-yml/commands/device/app/end-test-coverage.yml @@ -26,7 +26,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/AndroidDriver.html#endTestCoverage-java.lang.String-java.lang.String-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L627" + python: "https://github.com/appium/python-client/blob/master/README.md#end-test-coverage" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2858" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#end_coverage-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#end_coverage-instance_method" diff --git a/commands-yml/commands/device/app/get-app-strings.yml b/commands-yml/commands/device/app/get-app-strings.yml index 22662fc03..b0b58c46f 100644 --- a/commands-yml/commands/device/app/get-app-strings.yml +++ b/commands-yml/commands/device/app/get-app-strings.yml @@ -29,7 +29,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/HasAppStrings.html#getAppStringMap--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L357" + python: "https://github.com/appium/python-client/blob/master/README.md#retrieving-application-strings" javascript_wdio: "http://webdriver.io/api/mobile/getAppStrings.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2916" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#app_strings-instance_method" diff --git a/commands-yml/commands/device/app/install-app.yml b/commands-yml/commands/device/app/install-app.yml index 796ac62b4..51f022710 100644 --- a/commands-yml/commands/device/app/install-app.yml +++ b/commands-yml/commands/device/app/install-app.yml @@ -34,7 +34,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#installApp-java.lang.String-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L554" + python: "https://github.com/appium/python-client/blob/master/README.md#installing-an-application" javascript_wdio: "http://webdriver.io/api/mobile/installApp.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2540" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#install_app-instance_method" diff --git a/commands-yml/commands/device/app/is-app-installed.yml b/commands-yml/commands/device/app/is-app-installed.yml index c56b2b678..671c46cde 100644 --- a/commands-yml/commands/device/app/is-app-installed.yml +++ b/commands-yml/commands/device/app/is-app-installed.yml @@ -34,7 +34,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#isAppInstalled-java.lang.String-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L542" + python: "https://github.com/appium/python-client/blob/master/README.md#checking-if-an-application-is-installed" javascript_wdio: "http://webdriver.io/api/mobile/isAppInstalled.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2586" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#app_installed%3F-instance_method" diff --git a/commands-yml/commands/device/app/launch-app.yml b/commands-yml/commands/device/app/launch-app.yml index 426050b1d..3edfd737c 100644 --- a/commands-yml/commands/device/app/launch-app.yml +++ b/commands-yml/commands/device/app/launch-app.yml @@ -37,7 +37,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#launchApp--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L578" + python: "https://github.com/appium/python-client/blob/master/README.md#closing-and-launching-an-application" javascript_wdio: "http://webdriver.io/api/mobile/launch.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2798" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#launch_app-instance_method" diff --git a/commands-yml/commands/device/app/remove-app.yml b/commands-yml/commands/device/app/remove-app.yml index 59502c3d7..5657d3610 100644 --- a/commands-yml/commands/device/app/remove-app.yml +++ b/commands-yml/commands/device/app/remove-app.yml @@ -35,7 +35,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#removeApp-java.lang.String-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L566" + python: "https://github.com/appium/python-client/blob/master/README.md#removing-an-application" javascript_wdio: "http://webdriver.io/api/mobile/removeApp.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2563" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#remove_app-instance_method" diff --git a/commands-yml/commands/device/app/reset-app.yml b/commands-yml/commands/device/app/reset-app.yml index c158392a6..14ac2be92 100644 --- a/commands-yml/commands/device/app/reset-app.yml +++ b/commands-yml/commands/device/app/reset-app.yml @@ -29,7 +29,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithApps.html#resetApp--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L372" + python: "https://github.com/appium/python-client/blob/master/README.md#resetting-an-application" javascript_wdio: "http://webdriver.io/api/mobile/reset.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2827" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#reset-instance_method" diff --git a/commands-yml/commands/device/authentication/finger-print.yml b/commands-yml/commands/device/authentication/finger-print.yml index b6748a70c..352641c2e 100644 --- a/commands-yml/commands/device/authentication/finger-print.yml +++ b/commands-yml/commands/device/authentication/finger-print.yml @@ -37,7 +37,7 @@ example_usage: client_docs: java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/WebElement.html#click--" - python: "https://github.com/appium/python-client/blob/07180f7547ffcd13c212de21d027ea0355f9ab96/appium/webdriver/webdriver.py#L1390" + python: "https://github.com/appium/python-client" javascript_wdio: "https://github.com/appium/appium-android-driver/blob/d16c7161d92ab6f6c9cec3f22218219ac3659716/lib/commands/actions.js#L260" javascript_wd: "https://github.com/appium/appium-android-driver/blob/d16c7161d92ab6f6c9cec3f22218219ac3659716/lib/commands/actions.js#L260" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device#finger_print-instance_method" diff --git a/commands-yml/commands/device/emulator/power_ac.yml b/commands-yml/commands/device/emulator/power_ac.yml index b6ef0ef92..b1ad8463d 100644 --- a/commands-yml/commands/device/emulator/power_ac.yml +++ b/commands-yml/commands/device/emulator/power_ac.yml @@ -11,6 +11,9 @@ example_usage: java: | driver.setPowerAC(PowerACState.OFF); + python: + | + self.driver.set_power_ac(Power.AC_OFF) ruby: | set_power_ac :on @@ -20,6 +23,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/" # TODO: Link + python: "https://github.com/appium/python-client" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#set_power_ac-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#set_power_ac-instance_method" @@ -38,7 +42,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/emulator/power_capacity.yml b/commands-yml/commands/device/emulator/power_capacity.yml index 5da68ca11..75a6d4be5 100644 --- a/commands-yml/commands/device/emulator/power_capacity.yml +++ b/commands-yml/commands/device/emulator/power_capacity.yml @@ -11,6 +11,9 @@ example_usage: java: | driver.setPowerCapacity(100); + python: + | + self.driver.set_power_capacity(50) ruby: | set_power_capacity 50 @@ -20,6 +23,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/" # TODO: Link + python: "https://github.com/appium/python-client" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#set_power_capacity-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#set_power_capacity-instance_method" @@ -38,7 +42,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/files/pull-file.yml b/commands-yml/commands/device/files/pull-file.yml index 4f277ffb3..fd9edfbd1 100644 --- a/commands-yml/commands/device/files/pull-file.yml +++ b/commands-yml/commands/device/files/pull-file.yml @@ -30,7 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithFiles.html#pullFile-java.lang.String-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L491" + python: "https://github.com/appium/python-client/blob/master/README.md#retrieve-a-file-from-the-device" javascript_wdio: "http://webdriver.io/api/mobile/pullFile.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2665" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#pull_file-instance_method" diff --git a/commands-yml/commands/device/files/pull-folder.yml b/commands-yml/commands/device/files/pull-folder.yml index b0052b88d..66a962595 100644 --- a/commands-yml/commands/device/files/pull-folder.yml +++ b/commands-yml/commands/device/files/pull-folder.yml @@ -30,7 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/InteractsWithFiles.html#pullFolder-java.lang.String-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L503" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/pullFolder.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2688" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#pull_folder-instance_method" diff --git a/commands-yml/commands/device/files/push-file.yml b/commands-yml/commands/device/files/push-file.yml index df0d2746a..cd25e5a0d 100644 --- a/commands-yml/commands/device/files/push-file.yml +++ b/commands-yml/commands/device/files/push-file.yml @@ -31,7 +31,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/PushesFiles.html#pushFile-java.lang.String-java.io.File-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L515" + python: "https://github.com/appium/python-client/blob/master/README.md#place-a-file-on-the-device" javascript_wdio: "http://webdriver.io/api/mobile/pushFile.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2640" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#push_file-instance_method" diff --git a/commands-yml/commands/device/interactions/is-locked.yml b/commands-yml/commands/device/interactions/is-locked.yml index 608dc3578..75421cb4b 100644 --- a/commands-yml/commands/device/interactions/is-locked.yml +++ b/commands-yml/commands/device/interactions/is-locked.yml @@ -6,6 +6,9 @@ example_usage: java: | boolean isLocked = driver.isDeviceLocked(); + python: + | + self.driver.is_locked() javascript_wd: | let isLocked = await driver.isLocked(); @@ -28,6 +31,7 @@ example_usage: client_docs: java: "http://appium.github.io/java-client/io/appium/java_client/LocksDevice.html#isDeviceLocked--" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/isLocked.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2407" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_locked%3F-instance_method" diff --git a/commands-yml/commands/device/interactions/lock.yml b/commands-yml/commands/device/interactions/lock.yml index 7406f5d69..5e54cc54e 100644 --- a/commands-yml/commands/device/interactions/lock.yml +++ b/commands-yml/commands/device/interactions/lock.yml @@ -34,7 +34,7 @@ example_usage: client_docs: java: "http://appium.github.io/java-client/io/appium/java_client/LocksDevice.html#lockDevice--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L643" + python: "https://github.com/appium/python-client/blob/master/README.md#lock-the-device" javascript_wdio: "http://webdriver.io/api/mobile/lock.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2363" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#lock-instance_method" diff --git a/commands-yml/commands/device/interactions/shake.yml b/commands-yml/commands/device/interactions/shake.yml index 9537e7654..2a9257670 100644 --- a/commands-yml/commands/device/interactions/shake.yml +++ b/commands-yml/commands/device/interactions/shake.yml @@ -31,7 +31,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/ios/ShakesDevice.html#shake--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L655" + python: "https://github.com/appium/python-client/blob/master/README.md#shake-the-device" javascript_wdio: "http://webdriver.io/api/mobile/shake.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2342" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#shake-instance_method" diff --git a/commands-yml/commands/device/interactions/unlock.yml b/commands-yml/commands/device/interactions/unlock.yml index 0a63f868c..c3b5339ff 100644 --- a/commands-yml/commands/device/interactions/unlock.yml +++ b/commands-yml/commands/device/interactions/unlock.yml @@ -34,6 +34,7 @@ example_usage: client_docs: java: "http://appium.github.io/java-client/io/appium/java_client/LocksDevice.html#unlockDevice--" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/unlock.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2386" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#unlock-instance_method" diff --git a/commands-yml/commands/device/keys/hide-keyboard.yml b/commands-yml/commands/device/keys/hide-keyboard.yml index fc073b431..1d1a2ae9f 100644 --- a/commands-yml/commands/device/keys/hide-keyboard.yml +++ b/commands-yml/commands/device/keys/hide-keyboard.yml @@ -33,7 +33,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/HidesKeyboard.html#hideKeyboard--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L378" + python: "https://github.com/appium/python-client/blob/master/README.md#hiding-the-keyboard-in-ios" javascript_wdio: "http://webdriver.io/api/mobile/hideDeviceKeyboard.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2723" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#hide_keyboard-instance_method" diff --git a/commands-yml/commands/device/keys/is-keyboard-shown.yml b/commands-yml/commands/device/keys/is-keyboard-shown.yml index 2b9145624..f97f5297d 100644 --- a/commands-yml/commands/device/keys/is-keyboard-shown.yml +++ b/commands-yml/commands/device/keys/is-keyboard-shown.yml @@ -21,6 +21,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/HasOnScreenKeyboard.html#isKeyboardShown--" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2638" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#is_keyboard_shown-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#is_keyboard_shown-instance_method" diff --git a/commands-yml/commands/device/keys/long-press-keycode.yml b/commands-yml/commands/device/keys/long-press-keycode.yml index 62f3d2fb2..8382eb5ae 100644 --- a/commands-yml/commands/device/keys/long-press-keycode.yml +++ b/commands-yml/commands/device/keys/long-press-keycode.yml @@ -32,7 +32,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/windows/PressesKeyCode.html#longPressKeyCode-int-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L431" + python: "https://github.com/appium/python-client/blob/master/README.md#long_press" javascript_wdio: "http://webdriver.io/api/mobile/longPressKeycode.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2478" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#long_press_keycode-instance_method" diff --git a/commands-yml/commands/device/keys/press-keycode.yml b/commands-yml/commands/device/keys/press-keycode.yml index 203f13689..5870c3622 100644 --- a/commands-yml/commands/device/keys/press-keycode.yml +++ b/commands-yml/commands/device/keys/press-keycode.yml @@ -32,7 +32,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/windows/PressesKeyCode.html#pressKeyCode-int-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L415" + python: "https://github.com/appium/python-client/blob/master/README.md#sending-a-key-event-to-an-android-device" javascript_wdio: "http://webdriver.io/api/mobile/longPressKeycode.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2457" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#press_keycode-instance_method" diff --git a/commands-yml/commands/device/network/gsm-call.yml b/commands-yml/commands/device/network/gsm-call.yml index 5dc698f54..353378ad5 100644 --- a/commands-yml/commands/device/network/gsm-call.yml +++ b/commands-yml/commands/device/network/gsm-call.yml @@ -6,6 +6,9 @@ example_usage: java: | driver.makeGsmCall("5551234567", GsmCallActions.CALL); + python: + | + self.driver.make_gsm_call('5551234567', GsmCallActions.CALL) javascript_wd: | await driver.gsmCall('555-123-4567', 'Phone'); @@ -27,6 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/SupportsSpecialEmulatorCommands.html#makeGsmCall-java.lang.String-io.appium.java_client.android.GsmCallActions-" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3183" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_call-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_call-instance_method" @@ -48,7 +52,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/network/gsm-signal.yml b/commands-yml/commands/device/network/gsm-signal.yml index 795d5ee1c..9e3e7299a 100644 --- a/commands-yml/commands/device/network/gsm-signal.yml +++ b/commands-yml/commands/device/network/gsm-signal.yml @@ -6,6 +6,9 @@ example_usage: java: | driver.setGsmSignalStrength(GsmSignalStrength.GOOD); + python: + | + self.driver.set_gsm_signal(GsmSignalStrength.GOOD) javascript_wd: | await driver.gsmSignal(3); @@ -27,6 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/SupportsSpecialEmulatorCommands.html#setGsmSignalStrength-io.appium.java_client.android.GsmSignalStrength-" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3221" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_signal-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_signal-instance_method" @@ -48,7 +52,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/network/gsm-voice.yml b/commands-yml/commands/device/network/gsm-voice.yml index f9f987513..2a4f974e7 100644 --- a/commands-yml/commands/device/network/gsm-voice.yml +++ b/commands-yml/commands/device/network/gsm-voice.yml @@ -6,6 +6,9 @@ example_usage: java: | driver.setGsmVoice(GsmVoiceState.HOME); + python: + | + self.driver.set_gsm_voice(GsmVoiceState.HOME) javascript_wd: | await driver.gsmVoice('Voice state'); @@ -27,6 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/SupportsSpecialEmulatorCommands.html#setGsmVoice-io.appium.java_client.android.GsmVoiceState-" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3241" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_voice-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#gsm_voice-instance_method" @@ -48,7 +52,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/network/send-sms.yml b/commands-yml/commands/device/network/send-sms.yml index e157c671a..f6347a7c3 100644 --- a/commands-yml/commands/device/network/send-sms.yml +++ b/commands-yml/commands/device/network/send-sms.yml @@ -30,6 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/SupportsSpecialEmulatorCommands.html#sendSMS-java.lang.String-java.lang.String-" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3183" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#send_sms-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Android/Device/Emulator#send_sms-instance_method" @@ -51,7 +52,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/network/toggle-location-services.yml b/commands-yml/commands/device/network/toggle-location-services.yml index e11e83900..bd3ee7db8 100644 --- a/commands-yml/commands/device/network/toggle-location-services.yml +++ b/commands-yml/commands/device/network/toggle-location-services.yml @@ -30,7 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/AndroidDriver.html#toggleLocationServices--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L774" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/toggleLocationServices.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2758" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_location_services-instance_method" diff --git a/commands-yml/commands/device/network/toggle-wifi.yml b/commands-yml/commands/device/network/toggle-wifi.yml index 39d8cd722..ed8e0b8fb 100644 --- a/commands-yml/commands/device/network/toggle-wifi.yml +++ b/commands-yml/commands/device/network/toggle-wifi.yml @@ -30,6 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/SupportsNetworkStateManagement.html#toggleWifi--" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/toggleWiFi.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2738" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/master/Appium/Core/Device#toggle_wifi-instance_method" diff --git a/commands-yml/commands/device/performance-data/get-performance-data.yml b/commands-yml/commands/device/performance-data/get-performance-data.yml index 16a8aa31b..938962281 100644 --- a/commands-yml/commands/device/performance-data/get-performance-data.yml +++ b/commands-yml/commands/device/performance-data/get-performance-data.yml @@ -6,6 +6,9 @@ example_usage: java: | List> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5); + python: + | + self.driver.get_performance_data('my.app.package', 'cpuinfo', 5) javascript_wd: | await driver.getPerformanceData('my.app.package', 'cpuinfo', 5); @@ -28,6 +31,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3412" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_performance_data-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_performance_data-instance_method" diff --git a/commands-yml/commands/device/performance-data/performance-data-types.yml b/commands-yml/commands/device/performance-data/performance-data-types.yml index 8643d0be5..0be910270 100644 --- a/commands-yml/commands/device/performance-data/performance-data-types.yml +++ b/commands-yml/commands/device/performance-data/performance-data-types.yml @@ -6,6 +6,9 @@ example_usage: java: | List performanceTypes = driver.getSupportedPerformanceDataTypes(); + python: + | + self.driver.get_performance_data_types() javascript_wd: | await driver.getSupportedPerformanceDataTypes(); @@ -27,6 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3398" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_performance_data_types-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#get_performance_data_types-instance_method" diff --git a/commands-yml/commands/device/recording-screen/start-recording-screen.yml b/commands-yml/commands/device/recording-screen/start-recording-screen.yml index a3a2a1a6e..88120f629 100644 --- a/commands-yml/commands/device/recording-screen/start-recording-screen.yml +++ b/commands-yml/commands/device/recording-screen/start-recording-screen.yml @@ -39,6 +39,7 @@ example_usage: client_docs: java: "https://static.javadoc.io/io.appium/java-client/6.1.0/io/appium/java_client/screenrecording/CanRecordScreen.html#startRecordingScreen-T-" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3412" ruby: - android: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#start_recording_screen-instance_method" diff --git a/commands-yml/commands/device/recording-screen/stop-recording-screen.yml b/commands-yml/commands/device/recording-screen/stop-recording-screen.yml index 289755a66..bba08b74a 100644 --- a/commands-yml/commands/device/recording-screen/stop-recording-screen.yml +++ b/commands-yml/commands/device/recording-screen/stop-recording-screen.yml @@ -33,6 +33,7 @@ example_usage: client_docs: java: "https://static.javadoc.io/io.appium/java-client/6.1.0/io/appium/java_client/screenrecording/CanRecordScreen.html#stopRecordingScreen--" + python: "https://github.com/appium/python-client" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3398" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#stop_recording_screen-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#stop_recording_screen-instance_method" diff --git a/commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml b/commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml index 1df3fbbaf..56fc79390 100644 --- a/commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml +++ b/commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml @@ -37,7 +37,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/ios/PerformsTouchID.html#performTouchID-boolean-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L670" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/toggleTouchIdEnrollment.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3150" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Device#toggle_touch_id_enrollment-instance_method" diff --git a/commands-yml/commands/device/simulator/touch-id.yml b/commands-yml/commands/device/simulator/touch-id.yml index e5534b9e3..9cbc65de6 100644 --- a/commands-yml/commands/device/simulator/touch-id.yml +++ b/commands-yml/commands/device/simulator/touch-id.yml @@ -49,7 +49,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/ios/PerformsTouchID.html#performTouchID-boolean-" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L661" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/touchId.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3133" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Device#touch_id-instance_method" diff --git a/commands-yml/commands/device/system/open-notifications.yml b/commands-yml/commands/device/system/open-notifications.yml index 86fe5c6fc..5ad489c07 100644 --- a/commands-yml/commands/device/system/open-notifications.yml +++ b/commands-yml/commands/device/system/open-notifications.yml @@ -30,7 +30,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/AndroidDriver.html#openNotifications--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L676" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/openNotifications.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3004" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#open_notifications-instance_method" diff --git a/commands-yml/commands/device/system/system-bars.yml b/commands-yml/commands/device/system/system-bars.yml index f8d9501f1..fe0d242b8 100644 --- a/commands-yml/commands/device/system/system-bars.yml +++ b/commands-yml/commands/device/system/system-bars.yml @@ -6,6 +6,9 @@ example_usage: java: | Map systemBars = driver.getSystemBars(); + python: + | + self.driver.get_system_bars() javascript_wdio: | driver.getSystemBars(); @@ -24,6 +27,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/android/HasAndroidDeviceDetails.html#getSystemBars--" + python: "https://github.com/appium/python-client" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#get_system_bars-instance_method" ruby_core: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#get_system_bars-instance_method" php: "https://github.com/appium/php-client/" # TODO @@ -44,7 +48,7 @@ driver_support: windows: false client_support: java: true - python: false + python: true ruby: true php: false csharp: false diff --git a/commands-yml/commands/device/system/system-time.yml b/commands-yml/commands/device/system/system-time.yml index 70e1ef05d..de65e8095 100644 --- a/commands-yml/commands/device/system/system-time.yml +++ b/commands-yml/commands/device/system/system-time.yml @@ -33,7 +33,7 @@ example_usage: client_docs: java: "https://appium.github.io/java-client/io/appium/java_client/HasDeviceTime.html#getDeviceTime--" - python: "https://github.com/appium/python-client/blob/master/appium/webdriver/webdriver.py#L798" + python: "https://github.com/appium/python-client" javascript_wdio: "http://webdriver.io/api/mobile/getDeviceTime.html" javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L3119" ruby: "https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_time-instance_method" diff --git a/commands-yml/commands/element/attributes/location-in-view.yml b/commands-yml/commands/element/attributes/location-in-view.yml index 7c45a0b87..98a6a6b0a 100644 --- a/commands-yml/commands/element/attributes/location-in-view.yml +++ b/commands-yml/commands/element/attributes/location-in-view.yml @@ -7,6 +7,10 @@ example_usage: | let element = await driver.elementByAccessibilityId("SomeAccessibilityID"); let location = await element.getLocationInView(); + python: + | + element = self.driver.find_element_by_accessibility_id('SomeAccessibilityID') + element.location_in_view javascript_wdio: | let location = driver.getLocationInView("~SomeAccessibilityId"); diff --git a/commands-yml/commands/element/attributes/rect.yml b/commands-yml/commands/element/attributes/rect.yml index 4e04c6e29..934f344f4 100644 --- a/commands-yml/commands/element/attributes/rect.yml +++ b/commands-yml/commands/element/attributes/rect.yml @@ -7,6 +7,10 @@ example_usage: | List element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID"); Rectangle rect = element.getRect(); + python: + | + element = self.driver.find_element_by_accessibility_id('SomeAccessibilityID') + element.rect javascript_wd: | let element = await driver.elementByAccessibilityId("SomeAccessibilityID");