webkitpy.xcode.simulator.Simulator Class Reference

Inheritance diagram for webkitpy.xcode.simulator.Simulator:

Classes
class	DeviceState

Public Member Functions
def	__init__ (self, host=None)
def	refresh (self)
def	device_type (self, name=None, identifier=None)
def	runtime (self, version=None, identifier=None, is_internal_runtime=None)
def	find_device_by_udid (self, udid)
def	current_device (self)
def	device (self, name=None, runtime=None, should_ignore_unavailable_devices=False)
def	available_runtimes (self)
def	devices (self)
def	latest_available_runtime (self)
def	lookup_or_create_device (self, name, device_type, runtime)
def	__repr__ (self)
def	__str__ (self)

Static Public Member Functions
def	create_device (number, device_type, runtime)
def	remove_device (number)
def	device_number (number)
def	device_state_description (state)
def	wait_until_device_is_booted (udid, timeout_seconds=60 *5)
def	wait_until_device_is_in_state (udid, wait_until_state, timeout_seconds=60 *5)
def	device_state (udid)
def	device_directory (udid)
def	delete_device (udid)
def	reset_device (udid)

Public Attributes
	runtimes
	device_types

Static Public Attributes
	device_type_re
	runtime_re
	unavailable_version_re
	version_re
	devices_re
	managed_devices
	Device
	NAME_FOR_STATE

Detailed Description

Represents the iOS Simulator infrastructure under the currently select Xcode.app bundle.

Constructor & Destructor Documentation

__init__()

def webkitpy.xcode.simulator.Simulator.__init__	(		self,
			host = None
	)

Member Function Documentation

__repr__()

def webkitpy.xcode.simulator.Simulator.__repr__

(

self

)

__str__()

def webkitpy.xcode.simulator.Simulator.__str__

(

self

)

available_runtimes()

def webkitpy.xcode.simulator.Simulator.available_runtimes

(

self

)

:return: An iterator of all available runtimes.
:rtype: iter

create_device()

def webkitpy.xcode.simulator.Simulator.create_device (   number,   device_type,   runtime  )

static

current_device()

def webkitpy.xcode.simulator.Simulator.current_device

(

self

)

delete_device()

def webkitpy.xcode.simulator.Simulator.delete_device (   udid )

static

device()

def webkitpy.xcode.simulator.Simulator.device	(		self,
			name = None,
			runtime = None,
			should_ignore_unavailable_devices = False
	)

:param name: The name of the desired device.
:type name: str
:param runtime: The runtime of the desired device.
:type runtime: Runtime
:return: A device with the specified name and/or runtime, or None if one doesn't exist as such
:rtype: Device or None

device_directory()

def webkitpy.xcode.simulator.Simulator.device_directory (   udid )

static

device_number()

def webkitpy.xcode.simulator.Simulator.device_number (   number )

static

device_state()

def webkitpy.xcode.simulator.Simulator.device_state (   udid )

static

device_state_description()

def webkitpy.xcode.simulator.Simulator.device_state_description (   state )

static

device_type()

def webkitpy.xcode.simulator.Simulator.device_type	(		self,
			name = None,
			identifier = None
	)

:param name: The short name of the device type.
:type name: str
:param identifier: The CoreSimulator identifier of the desired device type.
:type identifier: str
:return: A device type with the specified name and/or identifier, or None if one doesn't exist as such.
:rtype: DeviceType

devices()

def webkitpy.xcode.simulator.Simulator.devices

(

self

)

:return: An iterator of all devices from all runtimes.
:rtype: iter

find_device_by_udid()

def webkitpy.xcode.simulator.Simulator.find_device_by_udid	(		self,
			udid
	)

:param udid: The UDID of the device to find.
:type udid: str
:return: The `Device` with the specified UDID.
:rtype: Device

latest_available_runtime()

def webkitpy.xcode.simulator.Simulator.latest_available_runtime

(

self

)

:return: Returns a Runtime object with the highest version.
:rtype: Runtime or None

lookup_or_create_device()

def webkitpy.xcode.simulator.Simulator.lookup_or_create_device	(		self,
			name,
			device_type,
			runtime
	)

Returns an available iOS Simulator device for testing.

This function will create a new simulator device with the specified name,
device type and runtime if one does not already exist.

:param name: The name of the simulator device to lookup or create.
:type name: str
:param device_type: The CoreSimulator device type.
:type device_type: DeviceType
:param runtime: The CoreSimulator runtime.
:type runtime: Runtime
:return: A dictionary describing the device.
:rtype: Device

refresh()

def webkitpy.xcode.simulator.Simulator.refresh

(

self

)

Refresh runtime and device type information from ``simctl list``.

remove_device()

def webkitpy.xcode.simulator.Simulator.remove_device (   number )

static

reset_device()

def webkitpy.xcode.simulator.Simulator.reset_device (   udid )

static

runtime()

def webkitpy.xcode.simulator.Simulator.runtime	(		self,
			version = None,
			identifier = None,
			is_internal_runtime = None
	)

:param version: The iOS version of the desired runtime.
:type version: tuple
:param identifier: The CoreSimulator identifier of the desired runtime.
:type identifier: str
:return: A runtime with the specified version and/or identifier, or None if one doesn't exist as such.
:rtype: Runtime or None

wait_until_device_is_booted()

def webkitpy.xcode.simulator.Simulator.wait_until_device_is_booted (   udid,   timeout_seconds = 60 * 5  )

static

wait_until_device_is_in_state()

def webkitpy.xcode.simulator.Simulator.wait_until_device_is_in_state (   udid,   wait_until_state,   timeout_seconds = 60 * 5  )

static

Member Data Documentation

Device

webkitpy.xcode.simulator.Simulator.Device

static

device_type_re

webkitpy.xcode.simulator.Simulator.device_type_re

static

device_types

webkitpy.xcode.simulator.Simulator.device_types

devices_re

webkitpy.xcode.simulator.Simulator.devices_re

static

managed_devices

webkitpy.xcode.simulator.Simulator.managed_devices

static

NAME_FOR_STATE

webkitpy.xcode.simulator.Simulator.NAME_FOR_STATE

static

runtime_re

webkitpy.xcode.simulator.Simulator.runtime_re

static

runtimes

webkitpy.xcode.simulator.Simulator.runtimes

unavailable_version_re

webkitpy.xcode.simulator.Simulator.unavailable_version_re

static

version_re

webkitpy.xcode.simulator.Simulator.version_re

static

---

The documentation for this class was generated from the following file:

• Tools/Scripts/webkitpy/xcode/simulator.py