本文共 7912 字，大约阅读时间需要 26 分钟。

Appium Python API 文档

---

1. contexts

contexts(self)

返回当前会话中的上下文，可用于识别 H5 页面的控件。 用法：driver.contexts

---

2. current_context

current_context(self)

返回当前会话的当前上下文。 用法：driver.current_context

---

3. context

context(self)

返回当前会话的当前上下文。 用法：driver.context

---

4. find_element_by_ios_uiautomation

find_element_by_ios_uiautomation(self, uia_string)

在 iOS 上通过 uiautomation 查找元素。 用法：driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')

---

5. find_element_by_accessibility_id

find_element_by_accessibility_id(self, id)

通过访问性 ID 查找元素。 用法：driver.find_element_by_accessibility_id('id')

---

6. scroll

scroll(self, origin_el, destination_el)

从一个元素滚动到另一个元素。 用法：driver.scroll(el1, el2)

---

7. drag_and_drop

drag_and_drop(self, origin_el, destination_el)

将元素拖到目标元素。 用法：driver.drag_and_drop(el1, el2)

---

8. tap

tap(self, positions, duration=None)

在屏幕上模拟手指点击（最多五个手指）。 用法：driver.tap([(100, 20), (100, 60), (100, 100)], 500)

---

9. swipe

swipe(self, start_x, start_y, end_x, end_y, duration=None)

从一点滑动到另一点。 用法：driver.swipe(100, 100, 100, 400)

---

10. flick

flick(self, start_x, start_y, end_x, end_y)

从一点快速滑动到另一点。 用法：driver.flick(100, 100, 100, 400)

---

11. pinch

pinch(self, element=None, percent=200, steps=50)

在元素上执行双指捏操作。 用法：driver.pinch(element)

---

12. zoom

zoom(self, element=None, percent=200, steps=50)

在元素上执行放大操作。 用法：driver.zoom(element)

---

13. reset

reset(self)

重置当前应用。 用法：driver.reset()

---

14. hide_keyboard

hide_keyboard(self, key_name=None, key=None, strategy=None)

隐藏软件键盘。 用法：driver.hide_keyboard()

---

15. keyevent

keyevent(self, keycode, metastate=None)

发送键码事件（仅适用于 Android）。 用法：driver.keyevent('4')

---

16. press_keycode

press_keycode(self, keycode, metastate=None)

发送键码事件（仅适用于 Android）。 用法：driver.press_keycode('4')

---

17. long_press_keycode

long_press_keycode(self, keycode, metastate=None)

发送长按键码事件（仅适用于 Android）。 用法：driver.long_press_keycode(4)

---

18. current_activity

current_activity(self)

获取当前活动。 用法：print(driver.current_activity)

---

19. wait_activity

wait_activity(self, activity, timeout, interval=1)

等待指定活动出现或超时（仅适用于 Android）。 用法：driver.wait_activity('.activity.xxx', 5, 2)

---

20. background_app

background_app(self, seconds)

将应用置于后台运行。 用法：driver.background_app(5)

---

21. is_app_installed

is_app_installed(self, bundle_id)

检查应用是否已安装。 用法：driver.is_app_installed("com.xxxx")

---

22. install_app

install_app(self, app_path)

安装应用。 用法：driver.install_app(app_path)

---

23. remove_app

remove_app(self, app_id)

删除指定应用。 用法：driver.remove_app("com.xxx")

---

24. launch_app

launch_app(self)

启动指定应用。 用法：driver.launch_app()

---

25. close_app

close_app(self)

关闭当前运行的应用。 用法：driver.close_app()

---

26. start_activity

start_activity(self, app_package, app_activity, **opts)

启动指定活动或应用（仅适用于 Android）。 用法：driver.start_activity(app_package, app_activity)

---

27. lock

lock(self, seconds)

锁定设备（仅适用于 iOS）。 用法：driver.lock()

---

28. shake

shake(self)

摇晃设备。 用法：driver.shake()

---

29. open_notifications

open_notifications(self)

打开系统通知栏（仅适用于 Android，API Level 18 及以上）。 用法：driver.open_notifications()

---

30. network_connection

network_connection(self)

获取网络连接类型（仅适用于 Android）。 用法：driver.network_connection

---

31. set_network_connection

set_network_connection(self, connectionType)

设置网络连接类型（仅适用于 Android）。 用法：driver.set_network_connection(ConnectionType.WIFI_ONLY)

---

32. available_ime_engines

available_ime_engines(self)

获取可用的输入法引擎（仅适用于 Android）。 用法：print(driver.available_ime_engines)

---

33. is_ime_active

is_ime_active(self)

检查输入法是否激活（仅适用于 Android）。 用法：print(driver.is_ime_active())

---

34. activate_ime_engine

activate_ime_engine(self, engine)

激活指定输入法（仅适用于 Android）。 用法：driver.activate_ime_engine("com.android.inputmethod.latin/.LatinIME")

---

35. deactivate_ime_engine

deactivate_ime_engine(self)

关闭当前输入法（仅适用于 Android）。 用法：driver.deactivate_ime_engine()

---

36. active_ime_engine

active_ime_engine(self)

获取当前活跃输入法（仅适用于 Android）。 用法：driver.active_ime_engine

---

37. toggle_location_services

toggle_location_services(self)

切换位置服务状态（仅适用于 Android）。 用法：driver.toggle_location_services()

---

38. set_location

set_location(self, latitude, longitude, altitude)

设置设备经纬度（仅适用于 Android）。 用法：driver.set_location(纬度, 经度, 海拔)

---

39. tag_name

tag_name(self)

获取元素的 tagName 属性。 用法：element.tag_name()

---

40. text

text(self)

获取元素的文本内容。 用法：element.text

---

41. click

click(self)

点击元素。 用法：element.click()

---

42. submit

submit(self)

提交表单（暂无具体用法）。

---

43. clear

clear(self)

清除文本输入。 用法：element.clear()

---

44. get_attribute

get_attribute(self, name)

获取元素的属性或属性值。 用法：element.get_attribute("class")

---

45. is_selected

is_selected(self)

检查元素是否被选中。 用法：element.is_selected()

---

46. is_enabled

is_enabled(self)

检查元素是否启用。 用法：element.is_enabled()

---

47. find_element_by_id

find_element_by_id(self, id_)

通过 ID 查找子元素。 用法：driver.find_element_by_id("id")

---

48. find_elements_by_id

find_elements_by_id(self, id_)

通过 ID 查找所有子元素。 用法：driver.find_elements_by_id("id")

---

49. find_element_by_name

find_element_by_name(self, name)

通过元素名查找子元素。 用法：driver.find_element_by_name("name")

---

50. find_elements_by_name

find_elements_by_name(self, name)

通过元素名查找所有子元素。 用法：driver.find_elements_by_name("name")

---

51. find_element_by_link_text

find_element_by_link_text(self, link_text)

通过链接文本查找子元素。 用法：driver.find_element_by_link_text("text")

---

52. find_elements_by_link_text

find_elements_by_link_text(self, link_text)

通过链接文本查找所有子元素。 用法：driver.find_elements_by_link_text("text")

---

53. find_element_by_partial_link_text

find_element_by_partial_link_text(self, link_text)

通过部分链接文本查找子元素。 用法：driver.find_element_by_partial_link_text("text")

---

54. find_elements_by_partial_link_text

find_elements_by_partial_link_text(self, link_text)

通过部分链接文本查找所有子元素。 用法：driver.find_elements_by_partial_link_text("text")

---

55. find_element_by_tag_name

find_element_by_tag_name(self, name)

通过标签名称查找子元素。 用法：driver.find_element_by_tag_name("name")

---

56. find_elements_by_tag_name

find_elements_by_tag_name(self, name)

通过标签名称查找所有子元素。 用法：driver.find_elements_by_tag_name("name")

---

57. find_element_by_xpath

find_element_by_xpath(self, xpath)

通过 XPath 查找元素。 用法：driver.find_element_by_xpath("//input[@class='myelement']")

---

58. find_elements_by_xpath

find_elements_by_xpath(self, xpath)

通过 XPath 查找所有元素。 用法：driver.find_elements_by_xpath("//a")

---

59. find_element_by_class_name

find_element_by_class_name(self, name)

通过类名查找子元素。 用法：driver.find_element_by_class_name("android.widget.LinearLayout")

---

60. find_elements_by_class_name

find_elements_by_class_name(self, name)

通过类名查找所有子元素。 用法：driver.find_elements_by_class_name("android.widget.LinearLayout")

---

61. find_element_by_css_selector

find_element_by_css_selector(self, css_selector)

通过 CSS 选择器查找元素。 用法：driver.find_element_by_css_selector("a.nav#home")

---

62. send_keys

send_keys(self, *value)

在元素中模拟输入。 用法：form_textfield.send_keys("admin")

---

63. is_displayed

is_displayed(self)

检查元素是否可见。 用法：driver.element.is_displayed()

---

64. location_once_scrolled_into_view

location_once_scrolled_into_view(self)

获取元素滚动到视野中的位置。 用法：element.location_once_scrolled_into_view()

---

65. size

size(self)

获取元素的大小。 用法：driver.element.size

---

66. value_of_css_property

value_of_css_property(self, property_name)

获取 CSS 属性的值。 用法：driver.element.value_of_css_property("width")

---

67. location

location(self)

获取元素在可渲染 canvas 中的位置。 用法：driver.element.location.get('x')

---

68. rect

rect(self)

获取元素的大小和位置。 用法：driver.element.rect

---

69. screenshot_as_base64

screenshot_as_base64(self)

获取当前元素的截图（Base64 编码）。 用法：img_b64 = element.screenshot_as_base64

---

70. execute_script

execute_script(self, script, *args)

同步执行 JavaScript 窗口代码。 用法：driver.execute_script('document.title')

---

71. execute_async_script

execute_async_script(self, script, *args)

异步执行 JavaScript 窗口代码。 用法：driver.execute_async_script('document.title')

---

72. current_url

current_url(self)

获取当前页面的 URL。 用法：driver.current_url

---

73. page_source

page_source(self)

获取当前页面的源代码。 用法：driver.page_source

---

74. close

close(self)

关闭当前窗口。 用法：driver.close()

---

75. quit

quit(self)

退出驱动并关闭所有相关窗口。 用法：driver.quit()

---

76. get_screenshot_as_file

get_screenshot_as_file(self, filename)

获取当前窗口截图并保存为文件。 用法：driver.get_screenshot_as_file('c:/foo.png')

---

77. get_window_size

get_window_size(self, filename)

获取当前窗口的尺寸（宽和高）。 用法：driver.get_window_size()

---

以上是 Appium Python API 文档的完整参考，供开发人员使用。

转载地址：http://daqfk.baihongyu.com/