移动测试Appium之API手册
本文对Appium Python Client中webdriver.py代码进行分析说明。
笔者使用python3.6版本,安装在C:\Python36目录下,在C:\Python36\Lib\site-packages\appium\webdriver\webdriver.py找到本文要分析的目标模块文件。
我们先看一下webdriver.py中源码概要情况,如图:
从上图来看,整个模块分为两大块:
由此我们可以清楚的得出以下几个结论:
下面我们把上述的API以一个表格的方式进行说明,以便后续大家在使用appium进行自动化测试时使用,这些API是必须熟练掌握的。
def __init__(self,
command_executor='http://127.0.0.1:4444/wd/hub',
desired_capabilities=None,
browser_profile=None, proxy=None, keep_alive=False):
# 调用父类的__init__进行初始化
super(WebDriver, self).__init__(command_executor,
desired_capabilities,
browser_profile,
proxy,
keep_alive)
# 初始化command_executor
if self.command_executor is not None:
self._addCommands()
# 初始化错误处理器
self.error_handler = MobileErrorHandler()
# 切换至默认上下文
self._switch_to = MobileSwitchTo(self)
# 初始化默认定位方式
# add new method to the `find_by_*` pantheon
By.IOS_UIAUTOMATION = MobileBy.IOS_UIAUTOMATION
By.IOS_PREDICATE = MobileBy.IOS_PREDICATE
By.IOS_CLASS_CHAIN = MobileBy.IOS_CLASS_CHAIN
By.ANDROID_UIAUTOMATOR = MobileBy.ANDROID_UIAUTOMATOR
By.ACCESSIBILITY_ID = MobileBy.ACCESSIBILITY_ID
在webdirver类中,主要定义了以下函数,本文只将常用的函数进行说明,其他的请自行查阅代码:
函数:contexts 参数:无 描述:返回当前会话所有的上下文 用法:driver.contexts
函数:current_context 参数:无 描述:返回当前会话中当前的上下文 用法:driver.current_context
函数:context 参数:无 描述:返回当前会话中当前的上下文 用法:driver.context
函数:find_element_by_ios_uiautomation 参数:uia_string 描述:通过元素名称查找一个ios元素 用法:driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')
函数:find_elements_by_ios_uiautomation 参数:uia_string 描述:通过元素名查找N个ios元素 用法:driver.find_elements_by_ios_uiautomation('.elements()[1].cells()[2]')
函数:find_element_by_ios_predicate 参数:predicate_string 描述:通过一个谓词查找一个ios元素 用法:driver.find_element_by_ios_predicate('label == "myLabel"')
函数:find_elements_by_ios_predicate 参数:predicate_string 描述:通过一个谓词查找N个ios元素 用法:driver.find_elements_by_ios_predicate('label == "myLabel"')
函数:find_element_by_ios_class_chain 参数:class_chain_string 描述:通过class chain字符串查找一个ios元素 用法:driver.find_element_by_ios_class_chain
函数:find_elements_by_ios_class_chain 参数:class_chain_string 描述:通过class chain字符串查找N个ios元素 用法:driver.find_elements_by_ios_class_chain('XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]')
函数:find_element_by_android_uiautomator 参数:uia_string 描述:通过元素名称查找一个android元素 用法:driver.find_element_by_android_uiautomator('.elements()[1].cells()[2]')
函数:find_elements_by_android_uiautomator 参数:uia_string 描述:通过元素名称查找N个android元素 用法:driver.find_elements_by_android_uiautomator('.elements()[1].cells()[2]')
函数:find_element_by_accessibility_id 参数:id 描述:通过元素accessibility id查找一个元素 用法:driver.find_element_by_accessibility_id()
函数:find_elements_by_accessibility_id 参数:id 描述:通过元素accessibility id查找N个元素 用法:driver.find_elements_by_accessibility_id()
函数:create_web_element 参数:element_id 描述:使用指定的element id创建一个web元素
函数:scroll 参数:origin_el, destination_el 描述:从一个元素位置滚动到另一个元素位置 用法:driver.scroll(el1, el2)
函数:drag_and_drop 参数:origin_el, destination_el 描述:将一个元素从一个位置拖曳到另外一个位置 用法:driver.drag_and_drop(origin_el, destination_el)
函数:tap 参数:positions, duration 描述:点击屏幕指定位置,并在该位置停留duration指定的时长 用法:driver.tap([(100, 20), (100, 60), (100, 100)], 500)
函数:swipe 参数:start_x, start_y, end_x, end_y, duration=None 描述:从一个位置到另外一个位置滑动屏幕 用法:driver.swipe(100, 100, 100, 400)
函数:flick 参数:start_x, start_y, end_x, end_y 描述:从一个位置到另外一个位置快速滑动 用法:driver.flick(100, 100, 100, 400)
函数:pinch 参数:element=None, percent=200, steps=50 描述:捏 用法:driver.pinch(element)
函数:zoom 参数:element=None, percent=200, steps=50 描述:缩放屏幕 用法:driver.zoom(element)
函数:app_strings 参数:language=None, string_file=None 描述:获取应用字符串
函数:reset 参数:无 描述:重置设备当前的app 用法:driver.reset()
函数:hide_keyboard 参数:key_name=None, key=None, strategy=None 描述:隐藏键盘
函数:current_activity 参数:无 描述:获取设备当前app的activity 用法:driver.current_activity
函数:current_package 参数:无 描述:获取设备当前运行app的package 用法:driver.current_package
函数:set_value 参数:element, value 描述:给指定元素设置值 用法:driver.set_value(element, value)
函数:pull_file 参数:path 描述:从设备拉取文件 用法:driver.pull_file(path)
函数:push_file 参数:path, base64data 描述:以Base64编码方式向设备推送文件 用法:driver.push_file(path, base64data)
函数:background_app 参数:seconds 描述:将指定的app放在后端运行一段时间 用法:driver.background_app(seconds)
函数:is_app_installed 参数:bundle_id 描述:根据bundle id判断app是否已经安装 用法:driver.is_app_installed(bundle_id)
函数:install_app 参数:app_path 描述:安装app到设备 用法:driver.install_app(app_path)
函数:remove_app 参数:app_id 描述:卸载指定的app 用法:driver.remove_app(app_id)
函数:launch_app 参数:无 描述:启动desired capabilities指定的app 用法:driver.launch_app
函数:close_app 参数:无 描述:停止desired capabilities指定的app 用法:driver.close_app()
函数:start_activity 参数:app_package, app_activity, **opts 描述:启动指定参数的app, android专用
函数:lock 参数:seconds 描述:锁屏一段时间,ios专用 用法:driver.lock(5)
函数:shake 参数:无 描述:摇动设备 用法:driver.shake()
函数:open_notifications 参数:无 描述:打开通知,android专用,要求API level 18及以上 用法:driver.open_notifications()
函数:get_settings 参数:无 描述:获取当前appium服务端的设置 用法:driver.get_settings
函数:update_settings 参数:settings 描述:重设当前会话的设置,请参见 https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/settings.md
函数:device_time 参数:无 描述:返回设备的日期时间 用法: driver.device_time