Skip to content

Facebook WebDriverAgent Python Client Library (not official)

License

Notifications You must be signed in to change notification settings

ryzn0518/facebook-wda

 
 

Repository files navigation

python-wda

Build Status PyPI PyPI

Facebook WebDriverAgent Python Client Library (not official)

Most functions finished.

Implemented apis describe in https://github.com/facebook/WebDriverAgent/wiki/Queries

This library has been used in project atx https://github.com/codeskyblue/AutomatorX

Installation

  1. You need to start WebDriverAgent by yourself

    Follow the instructions in https://github.com/facebook/WebDriverAgent

    It is better to start with Xcode to prevent CodeSign issues.

    But it is also ok to start WDA with command line.

    xcodebuild -project WebDriverAgent.xcodeproj -scheme WebDriverAgentRunner -destination 'platform=iOS Simulator,name=iPhone 6' test
    
  2. Install python wda client

    pip install --pre facebook-wda
    

TCP connection over USB (optional)

You can use wifi network, it is very convinient, but not very stable enough.

I found a tools named iproxy which can forward device port to localhost, it's source code is here https://github.com/libimobiledevice/libusbmuxd

The usage is very simple iproxy <local port> <remote port> [udid]

How to use

Create a client

import wda

# Enable debug will see http Request and Response
# wda.DEBUG = True
c = wda.Client('http://localhost:8100')

A wda.WDAError will be raised if communite with WDA went wrong.

Other APIs

# Show status
print c.status()

# Press home button
c.home()

Take screenshot

c.screenshot('screen.png')

Open app

with c.session('com.apple.Health') as s:
	print s.orientation

Same as

s = c.session('com.apple.Health')
print s.orientation
s.close()

Session operations

Note: if element not found in 90s, RuntimeError will be raised

# One of <PORTRAIT | LANDSCAPE>
print s.orientation # expect PORTRAIT

# Get width and height
print s.window_size()
# Expect json output
# For example: {u'height': 736, u'width': 414}

# Simulate touch
s.tap(200, 200)

# Simulate swipe
s.swipe(x1, y1, x2, y2, 0.5) # 0.5s

# Find elements
print s(text="Dashboard").exists

# Find second element, index from 0
print s(text="Dashboard")[1]

# Tap selected element
s(text="Dashboard", className='Button').tap()

# Tap and hold
s(text="Dashboard").tap_hold(2.0) # tapAndHold for 2.0s

# Set text
s(text="Name").set_text("Hello")

# Clear text
s(text="Name").clear_text()

# Scroll to visible
s(text="Name").scroll()

# alert
print s.alert.text
s.alert.accept()
s.alert.dismiss()

# s.close() # kill app, no need to call in with

Properties

e = s(text='Dashboard')
e.count # same as len(e)

# bool props
e.exists
e.accessible
e.displayed
e.enabled

# return namedtuple
e.bounds # ex: Rect(x=144, y=28, width=88.0, height=27.0)
e.bounds.x # expect 144

# other
e.text # ex: Dashboard
e.class_name # ex: XCUIElementTypeStaticText

TODO

longTap not done pinch(not found in WDA)

TouchID

  • Match Touch ID
  • Do not match Touch ID

iOS Build-in Apps

苹果自带应用

Name Bundle ID
iMovie com.apple.iMovie
Apple Store com.apple.AppStore
Weather com.apple.weather
相机Camera com.apple.camera
iBooks com.apple.iBooks
Health com.apple.Health
Settings com.apple.Preferences
Watch com.apple.Bridge
Game Center com.apple.gamecenter
Wallet com.apple.Passbook
电话 com.apple.mobilephone
备忘录 com.apple.mobilenotes
指南针 com.apple.compass
浏览器 com.apple.mobilesafari
日历 com.apple.mobilecal
信息 com.apple.MobileSMS
时钟 com.apple.mobiletimer
照片 com.apple.mobileslideshow
提醒事项 com.apple.reminders
Desktop com.apple.springboard (Start this will cause your iPhone reboot)

第三方应用

Name Bundle ID
腾讯QQ com.tencent.mqq
微信 com.tencent.xin
部落冲突 com.supercell.magic
钉钉 com.laiwang.DingTalk
Skype com.skype.tomskype
Chrome com.google.chrome.ios

Reference

Source code

Articles

Contributors

DESIGN

DESIGN

LICENSE

MIT

About

Facebook WebDriverAgent Python Client Library (not official)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.2%
  • Shell 0.8%