Package selenium :: Package webdriver :: Package remote :: Module webdriver :: Class WebDriver
[hide private]
[frames] | no frames]

Class WebDriver

source code

object --+
         |
        WebDriver
Known Subclasses:

Controls a browser by sending commands to a remote server. This server is expected to be running the WebDriver wire protocol as defined here: http://code.google.com/p/selenium/wiki/JsonWireProtocol

:Attributes:

Instance Methods [hide private]
 
__init__(self, command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None)
Create a new driver that will issue commands using the wire protocol.
source code
 
_unwrap_value(self, value) source code
 
_wrap_value(self, value) source code
 
add_cookie(self, cookie_dict)
Adds a cookie to your current session.
source code
 
back(self)
Goes one step backward in the browser history.
source code
 
close(self)
Closes the current window.
source code
 
create_web_element(self, element_id)
Creates a web element with the specified element_id.
source code
 
delete_all_cookies(self)
Delete all cookies in the scope of the session.
source code
 
delete_cookie(self, name)
Deletes a single cookie with the given name.
source code
 
execute(self, driver_command, params=None)
Sends a command to be executed by a command.CommandExecutor.
source code
 
execute_async_script(self, script, *args)
Asynchronously Executes JavaScript in the current window/frame.
source code
 
execute_script(self, script, *args)
Synchronously Executes JavaScript in the current window/frame.
source code
 
find_element(self, by='id', value=None)
'Private' method used by the find_element_by_* methods.
source code
 
find_element_by_class_name(self, name)
Finds an element by class name.
source code
 
find_element_by_css_selector(self, css_selector)
Finds an element by css selector.
source code
 
find_element_by_id(self, id_)
Finds an element by id.
source code
 
find_element_by_link_text(self, link_text)
Finds an element by link text.
source code
 
find_element_by_name(self, name)
Finds an element by name.
source code
 
find_element_by_partial_link_text(self, link_text)
Finds an element by a partial match of its link text.
source code
 
find_element_by_tag_name(self, name)
Finds an element by tag name.
source code
 
find_element_by_xpath(self, xpath)
Finds an element by xpath.
source code
 
find_elements(self, by='id', value=None)
'Private' method used by the find_elements_by_* methods.
source code
 
find_elements_by_class_name(self, name)
Finds elements by class name.
source code
 
find_elements_by_css_selector(self, css_selector)
Finds elements by css selector.
source code
 
find_elements_by_id(self, id_)
Finds multiple elements by id.
source code
 
find_elements_by_link_text(self, text)
Finds elements by link text.
source code
 
find_elements_by_name(self, name)
Finds elements by name.
source code
 
find_elements_by_partial_link_text(self, link_text)
Finds elements by a partial match of their link text.
source code
 
find_elements_by_tag_name(self, name)
Finds elements by tag name.
source code
 
find_elements_by_xpath(self, xpath)
Finds multiple elements by xpath.
source code
 
forward(self)
Goes one step forward in the browser history.
source code
 
get(self, url)
Loads a web page in the current browser session.
source code
 
get_cookie(self, name)
Get a single cookie by name.
source code
 
get_cookies(self)
Returns a set of dictionaries, corresponding to cookies visible in the current session.
source code
 
get_screenshot_as_base64(self)
Gets the screenshot of the current window as a base64 encoded string which is useful in embedded images in HTML.
source code
 
get_screenshot_as_file(self, filename)
Gets the screenshot of the current window.
source code
 
get_window_position(self, windowHandle='current')
Gets the x,y position of the current window.
source code
 
get_window_size(self, windowHandle='current')
Gets the width and height of the current window.
source code
 
implicitly_wait(self, time_to_wait)
Sets a sticky timeout to implicitly wait for an element to be found, or a command to complete.
source code
 
is_online(self)
Returns a boolean if the browser is online or offline
source code
 
maximize_window(self)
Maximizes the current window that webdriver is using
source code
 
quit(self)
Quits the driver and closes every associated window.
source code
 
refresh(self)
Refreshes the current page.
source code
 
set_page_load_timeout(self, time_to_wait)
Set the amount of time to wait for a page load to complete before throwing an error.
source code
 
set_script_timeout(self, time_to_wait)
Set the amount of time that the script should wait during an execute_async_script call before throwing an error.
source code
 
set_window_position(self, x, y, windowHandle='current')
Sets the x,y position of the current window.
source code
 
set_window_size(self, width, height, windowHandle='current')
Sets the width and height of the current window.
source code
 
start_client(self)
Called before starting a new session.
source code
 
start_session(self, desired_capabilities, browser_profile=None)
Creates a new session with the desired capabilities.
source code
 
stop_client(self)
Called after executing a quit command.
source code
 
switch_to_active_element(self)
Returns the element with focus, or BODY if nothing has focus.
source code
 
switch_to_alert(self)
Switches focus to an alert on the page.
source code
 
switch_to_default_content(self)
Switch focus to the default frame.
source code
 
switch_to_frame(self, frame_reference)
Switches focus to the specified frame, by index, name, or webelement.
source code
 
switch_to_window(self, window_name)
Switches focus to the specified window.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]
  application_cache
Returns a ApplicationCache Object to interact with the browser app cache
  current_url
Gets the URL of the current page.
  current_window_handle
Returns the handle of the current window.
  desired_capabilities
returns the drivers current desired capabilities being used
  name
Returns the name of the underlying browser for this instance.
  orientation
Gets the current orientation of the device
  page_source
Gets the source of the current page.
  title
Returns the title of the current page.
  window_handles
Returns the handles of all windows within the current session.

Inherited from object: __class__

Method Details [hide private]

__init__(self, command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None)
(Constructor)

source code 

Create a new driver that will issue commands using the wire protocol.

:Args:

  • command_executor - Either a command.CommandExecutor object or a string that specifies the URL of a remote server to send commands to.
  • desired_capabilities - Dictionary holding predefined values for starting a browser
  • browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only used if Firefox is requested.
Overrides: object.__init__

add_cookie(self, cookie_dict)

source code 

Adds a cookie to your current session.

:Args:
 - cookie_dict: A dictionary object, with required keys - "name" and "value";
    optional keys - "path", "domain", "secure", "expiry"

Usage:
    driver.add_cookie({'name' : 'foo', 'value' : 'bar'})
    driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/'})
    driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/', 'secure':True})

back(self)

source code 

Goes one step backward in the browser history.

:Usage:
    driver.back()

close(self)

source code 

Closes the current window.

:Usage:
    driver.close()

delete_all_cookies(self)

source code 

Delete all cookies in the scope of the session.

:Usage:
    driver.delete_all_cookies()

delete_cookie(self, name)

source code 

Deletes a single cookie with the given name.

:Usage:
    driver.delete_cookie('my_cookie')

execute(self, driver_command, params=None)

source code 

Sends a command to be executed by a command.CommandExecutor.

:Args:
 - driver_command: The name of the command to execute as a string.
 - params: A dictionary of named parameters to send with the command.

:Returns:
  The command's JSON response loaded into a dictionary object.

execute_async_script(self, script, *args)

source code 

Asynchronously Executes JavaScript in the current window/frame.

:Args:
 - script: The JavaScript to execute.
 - \*args: Any applicable arguments for your JavaScript.

:Usage:
    driver.execute_async_script('document.title')

execute_script(self, script, *args)

source code 

Synchronously Executes JavaScript in the current window/frame.

:Args:
 - script: The JavaScript to execute.
 - \*args: Any applicable arguments for your JavaScript.

:Usage:
    driver.execute_script('document.title')

find_element(self, by='id', value=None)

source code 

'Private' method used by the find_element_by_* methods.

:Usage:
    Use the corresponding find_element_by_* instead of this.

find_element_by_class_name(self, name)

source code 

Finds an element by class name.

:Args:
 - name: The class name of the element to find.

:Usage:
    driver.find_element_by_class_name('foo')

find_element_by_css_selector(self, css_selector)

source code 

Finds an element by css selector.

:Args:
 - css_selector: The css selector to use when finding elements.

:Usage:
    driver.find_element_by_css_selector('#foo')

find_element_by_id(self, id_)

source code 
Finds an element by id.

:Args:
 - id\_ - The id of the element to be found.

:Usage:
    driver.find_element_by_id('foo')

find_element_by_link_text(self, link_text)

source code 

Finds an element by link text.

:Args:
 - link_text: The text of the element to be found.

:Usage:
    driver.find_element_by_link_text('Sign In')

find_element_by_name(self, name)

source code 

Finds an element by name.

:Args:
 - name: The name of the element to find.

:Usage:
    driver.find_element_by_name('foo')

find_element_by_partial_link_text(self, link_text)

source code 

Finds an element by a partial match of its link text.

:Args:
 - link_text: The text of the element to partially match on.

:Usage:
    driver.find_element_by_partial_link_text('Sign')

find_element_by_tag_name(self, name)

source code 

Finds an element by tag name.

:Args:
 - name: The tag name of the element to find.

:Usage:
    driver.find_element_by_tag_name('foo')

find_element_by_xpath(self, xpath)

source code 

Finds an element by xpath.

:Args:
 - xpath - The xpath locator of the element to find.

:Usage:
    driver.find_element_by_xpath('//div/td[1]')

find_elements(self, by='id', value=None)

source code 

'Private' method used by the find_elements_by_* methods.

:Usage:
    Use the corresponding find_elements_by_* instead of this.

find_elements_by_class_name(self, name)

source code 

Finds elements by class name.

:Args:
 - name: The class name of the elements to find.

:Usage:
    driver.find_elements_by_class_name('foo')

find_elements_by_css_selector(self, css_selector)

source code 

Finds elements by css selector.

:Args:
 - css_selector: The css selector to use when finding elements.

:Usage:
    driver.find_element_by_css_selector('#foo')

find_elements_by_id(self, id_)

source code 

Finds multiple elements by id.

:Args:
 - id\_ - The id of the elements to be found.

:Usage:
    driver.find_element_by_id('foo')

find_elements_by_link_text(self, text)

source code 

Finds elements by link text.

:Args:
 - link_text: The text of the elements to be found.

:Usage:
    driver.find_elements_by_link_text('Sign In')

find_elements_by_name(self, name)

source code 

Finds elements by name.

:Args:
 - name: The name of the elements to find.

:Usage:
    driver.find_elements_by_name('foo')

find_elements_by_partial_link_text(self, link_text)

source code 

Finds elements by a partial match of their link text.

:Args:
 - link_text: The text of the element to partial match on.

:Usage:
    driver.find_element_by_partial_link_text('Sign')

find_elements_by_tag_name(self, name)

source code 

Finds elements by tag name.

:Args:
 - name: The tag name the use when finding elements.

:Usage:
    driver.find_elements_by_tag_name('foo')

find_elements_by_xpath(self, xpath)

source code 

Finds multiple elements by xpath.

:Args:
 - xpath - The xpath locator of the elements to be found.

:Usage:
    driver.find_elements_by_xpath("//div[contains(@class, 'foo')]")

forward(self)

source code 

Goes one step forward in the browser history.

:Usage:
    driver.forward()

get_cookie(self, name)

source code 

Get a single cookie by name. Returns the cookie if found, None if not.

:Usage:
    driver.get_cookie('my_cookie')

get_cookies(self)

source code 

Returns a set of dictionaries, corresponding to cookies visible in the current session.

:Usage:
    driver.get_cookies()

get_screenshot_as_base64(self)

source code 

Gets the screenshot of the current window as a base64 encoded string
   which is useful in embedded images in HTML.

:Usage:
    driver.get_screenshot_as_base64()

get_screenshot_as_file(self, filename)

source code 

Gets the screenshot of the current window. Returns False if there is
   any IOError, else returns True. Use full paths in your filename.

:Args:
 - filename: The full path you wish to save your screenshot to.

:Usage:
    driver.get_screenshot_as_file('/Screenshots/foo.png')

get_window_position(self, windowHandle='current')

source code 

Gets the x,y position of the current window.

:Usage:
    driver.get_window_position()

get_window_size(self, windowHandle='current')

source code 

Gets the width and height of the current window.

:Usage:
    driver.get_window_size()

implicitly_wait(self, time_to_wait)

source code 

Sets a sticky timeout to implicitly wait for an element to be found,
   or a command to complete. This method only needs to be called one
   time per session. To set the timeout for calls to
   execute_async_script, see set_script_timeout.

:Args:
 - time_to_wait: Amount of time to wait (in seconds)

:Usage:
    driver.implicitly_wait(30)

quit(self)

source code 

Quits the driver and closes every associated window.

:Usage:
    driver.quit()

refresh(self)

source code 

Refreshes the current page.

:Usage:
    driver.refresh()

set_page_load_timeout(self, time_to_wait)

source code 

Set the amount of time to wait for a page load to complete 
   before throwing an error.

:Args:
 - time_to_wait: The amount of time to wait

:Usage:
    driver.set_page_load_timeout(30)

set_script_timeout(self, time_to_wait)

source code 

Set the amount of time that the script should wait during an
   execute_async_script call before throwing an error.

:Args:
 - time_to_wait: The amount of time to wait

:Usage:
    driver.set_script_timeout(30)

set_window_position(self, x, y, windowHandle='current')

source code 

Sets the x,y position of the current window. (window.moveTo)

:Args:
 - x: the x-coordinate in pixels to set the window position
 - y: the y-coordinate in pixels to set the window position

:Usage:
    driver.set_window_position(0,0)

set_window_size(self, width, height, windowHandle='current')

source code 

Sets the width and height of the current window. (window.resizeTo)

:Args:
 - width: the width in pixels to set the window to
 - height: the height in pixels to set the window to

:Usage:
    driver.set_window_size(800,600)

start_client(self)

source code 

Called before starting a new session. This method may be overridden to define custom startup behavior.

start_session(self, desired_capabilities, browser_profile=None)

source code 

Creates a new session with the desired capabilities.

:Args:

  • browser_name - The name of the browser to request.
  • version - Which browser version to request.
  • platform - Which platform to request the browser on.
  • javascript_enabled - Whether the new session should support JavaScript.
  • browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only used if Firefox is requested.

stop_client(self)

source code 

Called after executing a quit command. This method may be overridden to define custom shutdown behavior.

switch_to_active_element(self)

source code 

Returns the element with focus, or BODY if nothing has focus.

:Usage:
    driver.switch_to_active_element()

switch_to_alert(self)

source code 

Switches focus to an alert on the page.

:Usage:
    driver.switch_to_alert()

switch_to_default_content(self)

source code 

Switch focus to the default frame.

:Usage:
    driver.switch_to_default_content()

switch_to_frame(self, frame_reference)

source code 

Switches focus to the specified frame, by index, name, or webelement.

:Args:
 - frame_reference: The name of the window to switch to, an integer representing the index,
                    or a webelement that is an (i)frame to switch to.

:Usage:
    driver.switch_to_frame('frame_name')
    driver.switch_to_frame(1)
    driver.switch_to_frame(driver.find_elements_by_tag_name("iframe")[0])

switch_to_window(self, window_name)

source code 

Switches focus to the specified window.

:Args:
 - window_name: The name or window handle of the window to switch to.

:Usage:
    driver.switch_to_window('main')


Property Details [hide private]

application_cache

Returns a ApplicationCache Object to interact with the browser app cache

Get Method:
unreachable.application_cache(self) - Returns a ApplicationCache Object to interact with the browser app cache

current_url


Gets the URL of the current page.

:Usage:
    driver.current_url

Get Method:
unreachable.current_url(self) - Gets the URL of the current page.

current_window_handle


Returns the handle of the current window.

:Usage:
    driver.current_window_handle

Get Method:
unreachable.current_window_handle(self) - Returns the handle of the current window.

desired_capabilities

returns the drivers current desired capabilities being used

Get Method:
unreachable.desired_capabilities(self) - returns the drivers current desired capabilities being used

name

Returns the name of the underlying browser for this instance.

:Usage:

  • driver.name
Get Method:
unreachable.name(self) - Returns the name of the underlying browser for this instance.

orientation


Gets the current orientation of the device

:Usage:
    orientation = driver.orientation

Get Method:
unreachable.orientation(self) - Gets the current orientation of the device
Set Method:
unreachable.orientation(self, value) - Sets the current orientation of the device

page_source


Gets the source of the current page.

:Usage:
    driver.page_source

Get Method:
unreachable.page_source(self) - Gets the source of the current page.

title

Returns the title of the current page.

:Usage:
    driver.title

Get Method:
unreachable.title(self) - Returns the title of the current page.

window_handles


Returns the handles of all windows within the current session.

:Usage:
    driver.window_handles

Get Method:
unreachable.window_handles(self) - Returns the handles of all windows within the current session.