Selenium Py

8/6/2019 Selenium Py

1/40

"""Copyright 2006 ThoughtWorks, Inc.

Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License."""__docformat__ = "restructuredtext en"

import httplib

import urllibimport re

class selenium:"""Defines an object that runs Selenium commands.

Element Locators~~~~~~~~~~~~~~~~

Element Locators tell Selenium which HTML element a command refers to.The format of a locator is:

\ *locatorType*\ **=**\ \ *argument*

We support the following strategies for locating elements:

* \ **identifier**\ =\ *id*:Select the element with the specified @id attribute. If no match isfound, select the first element whose @name attribute is \ *id*.(This is normally the default; see below.)

* \ **id**\ =\ *id*:Select the element with the specified @id attribute.

* \ **name**\ =\ *name*:Select the first element with the specified @name attribute.

* username* name=username

The name may optionally be followed by one or more \ *element-filters*,separated from the name by whitespace. If the \ *filterType* is not specified,\ **value**\ is assumed.

* name=flavour value=chocolate

* \ **dom**\ =\ *javascriptExpression*:


2/40

Find an element by evaluating the specified string. This allows you totraverse the HTML Document Object

Model using JavaScript. Note that you must not return a value in this string; simply make it the last expression in the block.

* dom=document.forms['myForm'].myDropdown* dom=document.images[56]

* dom=function foo() { return document.links[1]; }; foo();

* \ **xpath**\ =\ *xpathExpression*:Locate an element using an XPath expression.

* xpath=//img[@alt='The image alt text']* xpath=//table[@id='table1']//tr[4]/td[2]* xpath=//a[contains(@href,'#id1')]* xpath=//a[contains(@href,'#id1')]/@class* xpath=(//table[@class='stylee'])//th[text()='theHeaderText']/../td* xpath=//input[@name='name2' and @value='yes']

* xpath=//\*[text()="right"]

* \ **link**\ =\ *textPattern*:Select the link (anchor) element which contains text matching thespecified \ *pattern*.

* link=The link text

* \ **css**\ =\ *cssSelectorSyntax*:Select the element using css selectors. Please refer to CSS2 selectors,

CSS3 selectors for more information. You can also check the TestCssLocators test

in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.

* css=a[href="#id3"]* css=span#firstChild + span

Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after).

* \ **ui**\ =\ *uiSpecifierString*:Locate an element by resolving the UI specifier string to another locato

r, and evaluating it. See the Selenium UI-Element Reference for more details.

* ui=loginPages::loginButton()* ui=settingsPages::toggle(label=Hide Email)* ui=forumPages::postBody(index=2)//a[2]

Without an explicit locator prefix, Selenium uses the following defaultstrategies:


3/40

* \ **dom**\ , for locators starting with "document."* \ **xpath**\ , for locators starting with "//"* \ **identifier**\ , otherwise

Element Filters~~~~~~~~~~~~~~~

Element filters can be used with a locator to refine a list of candidate ele

ments. They are currently used only in the 'name' element-locator.

Filters look much like locators, ie.

\ *filterType*\ **=**\ \ *argument*

Supported element-filters are:

\ **value=**\ \ *valuePattern*

Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.

\ **index=**\ \ *index*

Selects a single element based on its position in the list (offset from zero).

String-match Patterns~~~~~~~~~~~~~~~~~~~~~

Various Pattern syntaxes are available for matching string values:

* \ **glob:**\ \ *pattern*:Match a string against a "glob" (aka "wildmat") pattern. "Glob" is akind of limited regular-expression syntax typically used in command-lineshells. In a glob pattern, "\*" represents any sequence of characters, a

nd "?"represents any single character. Glob patterns match against the entirestring.

* \ **regexp:**\ \ *regexp*:Match a string using a regular-expression. The full power of JavaScriptregular-expressions is available.

* \ **regexpi:**\ \ *regexpi*:Match a string using a case-insensitive regular-expression.

* \ **exact:**\ \ *string*:

Match a string exactly, verbatim, without any of that fancy wildcardstuff.

If no pattern prefix is specified, Selenium assumes that it's a "glob"pattern.

For commands that return multiple values (such as verifySelectOptions),


4/40

the string being matched is a comma-separated list of the return values,where both commas and backslashes in the values are backslash-escaped.When providing a pattern, the optional matching syntax (i.e. glob,regexp, etc.) is specified once, as usual, at the beginning of thepattern.

"""

### This part is hard-coded in the XSLdef __init__(self, host, port, browserStartCommand, browserURL):

self.host = hostself.port = portself.browserStartCommand = browserStartCommandself.browserURL = browserURLself.sessionId = Noneself.extensionJs = ""

def setExtensionJs(self, extensionJs):

self.extensionJs = extensionJsdef start(self, browserConfigurationOptions=None):

start_args = [self.browserStartCommand, self.browserURL, self.extensionJs]

if browserConfigurationOptions:start_args.append(browserConfigurationOptions)

result = self.get_string("getNewBrowserSession", start_args)try:

self.sessionId = resultexcept ValueError:

raise Exception, result

def stop(self):self.do_command("testComplete", [])self.sessionId = None

def do_command(self, verb, args):conn = httplib.HTTPConnection(self.host, self.port)body = u'cmd=' + urllib.quote_plus(unicode(verb).encode('utf-8'))for i in range(len(args)):

body += '&' + unicode(i+1) + '=' + urllib.quote_plus(unicode(args[i]).encode('utf-8'))

if (None != self.sessionId):body += "&sessionId=" + unicode(self.sessionId)

headers = {"Content-Type": "application/x-www-form-urlencoded; charset=utf-8"}

conn.request("POST", "/selenium-server/driver/", body, headers)

response = conn.getresponse()#print response.status, response.reasondata = unicode(response.read(), "UTF-8")result = response.reason#print "Selenium Result: " + repr(data) + "\n\n"if (not data.startswith('OK')):

raise Exception, datareturn data

def get_string(self, verb, args):result = self.do_command(verb, args)return result[3:]


5/40

def get_string_array(self, verb, args):

csv = self.get_string(verb, args)token = ""tokens = []escape = Falsefor i in range(len(csv)):

letter = csv[i]if (escape):

token = token + letterescape = Falsecontinue

if (letter == '\\'):escape = True

elif (letter == ','):tokens.append(token)token = ""

else:token = token + letter

tokens.append(token)return tokens

def get_number(self, verb, args):# Is there something I need to do here?return self.get_string(verb, args)

def get_number_array(self, verb, args):

# Is there something I need to do here?return self.get_string_array(verb, args)

def get_boolean(self, verb, args):boolstr = self.get_string(verb, args)

if ("true" == boolstr):return True

if ("false" == boolstr):return False

raise ValueError, "result is neither 'true' nor 'false': " + boolstr

def get_boolean_array(self, verb, args):boolarr = self.get_string_array(verb, args)for i in range(len(boolarr)):

if ("true" == boolstr):boolarr[i] = Truecontinue

if ("false" == boolstr):boolarr[i] = Falsecontinue

raise ValueError, "result is neither 'true' nor 'false': " + boolarr[i]

return boolarr

def click(self,locator):"""Clicks on a link, button, checkbox or radio button. If the click actioncauses a new page to load (like a link usually does), call

waitForPageToLoad.

'locator' is an element locator


6/40

"""self.do_command("click", [locator,])

def double_click(self,locator):"""Double clicks on a link, button, checkbox or radio button. If the double

click actioncauses a new page to load (like a link usually does), callwaitForPageToLoad.

'locator' is an element locator"""self.do_command("doubleClick", [locator,])

def context_menu(self,locator):"""Simulates opening the context menu for the specified element (as might h

appen if the user "right-clicked" on the element).'locator' is an element locator"""self.do_command("contextMenu", [locator,])

def click_at(self,locator,coordString):"""Clicks on a link, button, checkbox or radio button. If the click actioncauses a new page to load (like a link usually does), callwaitForPageToLoad.

'locator' is an element locator'coordString' is specifies the x,y position (i.e. - 10,20) of the mouse

event relative to the element returned by the locator."""self.do_command("clickAt", [locator,coordString,])

def double_click_at(self,locator,coordString):"""Doubleclicks on a link, button, checkbox or radio button. If the actioncauses a new page to load (like a link usually does), callwaitForPageToLoad.


event relative to the element returned by the locator."""self.do_command("doubleClickAt", [locator,coordString,])

def context_menu_at(self,locator,coordString):"""Simulates opening the context menu for the specified element (as might h

appen if the user "right-clicked" on the element).


event relative to the element returned by the locator.


7/40

"""self.do_command("contextMenuAt", [locator,coordString,])

def fire_event(self,locator,eventName):"""Explicitly simulate an event, to trigger the corresponding "on\ *event*"

handler.

'locator' is an element locator'eventName' is the event name, e.g. "focus" or "blur""""self.do_command("fireEvent", [locator,eventName,])

def focus(self,locator):"""Move the focus to the specified element; for example, if the element is

an input field, move the cursor to that field.

'locator' is an element locator"""self.do_command("focus", [locator,])

def key_press(self,locator,keySequence):"""Simulates a user pressing and releasing a key.

'locator' is an element locator'keySequence' is Either be a string("\" followed by the numeric keycode

of the key to be pressed, normally the ASCII value of that key), or a single c

haracter. For example: "w", "\119"."""self.do_command("keyPress", [locator,keySequence,])

def shift_key_down(self):"""Press the shift key and hold it down until doShiftUp() is called or a ne

w page is loaded.

"""self.do_command("shiftKeyDown", [])

def shift_key_up(self):"""Release the shift key.

"""self.do_command("shiftKeyUp", [])

def meta_key_down(self):"""Press the meta key and hold it down until doMetaUp() is called or a new

page is loaded.

"""


8/40

self.do_command("metaKeyDown", [])

def meta_key_up(self):"""Release the meta key.

"""self.do_command("metaKeyUp", [])

def alt_key_down(self):"""Press the alt key and hold it down until doAltUp() is called or a new pa

ge is loaded.

"""self.do_command("altKeyDown", [])

def alt_key_up(self):"""Release the alt key.

"""self.do_command("altKeyUp", [])

def control_key_down(self):"""Press the control key and hold it down until doControlUp() is called or

a new page is loaded.

"""self.do_command("controlKeyDown", [])

def control_key_up(self):"""Release the control key.

"""self.do_command("controlKeyUp", [])

def key_down(self,locator,keySequence):"""Simulates a user pressing a key (without releasing it yet).


of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

"""self.do_command("keyDown", [locator,keySequence,])

def key_up(self,locator,keySequence):"""Simulates a user releasing a key.


9/40


of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

"""self.do_command("keyUp", [locator,keySequence,])

def mouse_over(self,locator):"""Simulates a user hovering a mouse over the specified element.

'locator' is an element locator"""self.do_command("mouseOver", [locator,])

def mouse_out(self,locator):

"""Simulates a user moving the mouse pointer away from the specified element.

'locator' is an element locator"""self.do_command("mouseOut", [locator,])

def mouse_down(self,locator):"""Simulates a user pressing the left mouse button (without releasing it ye

t) on

the specified element.

'locator' is an element locator"""self.do_command("mouseDown", [locator,])

def mouse_down_right(self,locator):"""Simulates a user pressing the right mouse button (without releasing it y

et) onthe specified element.

'locator' is an element locator"""self.do_command("mouseDownRight", [locator,])

def mouse_down_at(self,locator,coordString):"""Simulates a user pressing the left mouse button (without releasing it ye

t) atthe specified location.


'coordString' is specifies the x,y position (i.e. - 10,20) of the mouseevent relative to the element returned by the locator.

"""


10/40

self.do_command("mouseDownAt", [locator,coordString,])

def mouse_down_right_at(self,locator,coordString):"""Simulates a user pressing the right mouse button (without releasing it y

et) at

the specified location.


event relative to the element returned by the locator."""self.do_command("mouseDownRightAt", [locator,coordString,])

def mouse_up(self,locator):"""Simulates the event that occurs when the user releases the mouse button

(i.e., stopsholding the button down) on the specified element.

'locator' is an element locator"""self.do_command("mouseUp", [locator,])

def mouse_up_right(self,locator):"""Simulates the event that occurs when the user releases the right mouse b

utton (i.e., stopsholding the button down) on the specified element.

'locator' is an element locator"""self.do_command("mouseUpRight", [locator,])

def mouse_up_at(self,locator,coordString):"""Simulates the event that occurs when the user releases the mouse button

(i.e., stopsholding the button down) at the specified location.


event relative to the element returned by the locator."""self.do_command("mouseUpAt", [locator,coordString,])

def mouse_up_right_at(self,locator,coordString):"""Simulates the event that occurs when the user releases the right mouse b

utton (i.e., stopsholding the button down) at the specified location.


event relative to the element returned by the locator.


11/40

"""self.do_command("mouseUpRightAt", [locator,coordString,])

def mouse_move(self,locator):"""Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.

'locator' is an element locator"""self.do_command("mouseMove", [locator,])

def mouse_move_at(self,locator,coordString):"""Simulates a user pressing the mouse button (without releasing it yet) onthe specified element.

'locator' is an element locator'coordString' is specifies the x,y position (i.e. - 10,20) of the mouseevent relative to the element returned by the locator.

"""self.do_command("mouseMoveAt", [locator,coordString,])

def type(self,locator,value):"""Sets the value of an input field, as though you typed it in.

Can also be used to set the value of combo boxes, check boxes, etc. In t

hese cases,value should be the value of the option selected, not the visible text.

'locator' is an element locator'value' is the value to type"""self.do_command("type", [locator,value,])

def type_keys(self,locator,value):"""Simulates keystroke events on the specified element, as though you typed

the value key-by-key.

This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string;

this is useful for dynamic UI widgets (like auto-completing combo boxes)that require explicit key events.

Unlike the simple "type" command, which forces the specified value intothe page directly, this command

may or may not have any visible effect, even in cases where typing keyswould normally have a visible effect.

For example, if you use "typeKeys" on a form element, you may or may notsee the results of what you typed in

the field.


12/40

In some cases, you may need to use the simple "type" command to set the

value of the field and then the "typeKeys" command tosend the keystroke events corresponding to what you just typed.


'value' is the value to type"""self.do_command("typeKeys", [locator,value,])

def set_speed(self,value):"""Set execution speed (i.e., set the millisecond length of a delay which w

ill follow each selenium operation). By default, there is no such delay, i.e.,the delay is 0 milliseconds.

'value' is the number of milliseconds to pause after operation

"""self.do_command("setSpeed", [value,])

def get_speed(self):"""Get execution speed (i.e., get the millisecond length of the delay follo

wing each selenium operation). By default, there is no such delay, i.e.,the delay is 0 milliseconds.

See also setSpeed.

"""

return self.get_string("getSpeed", [])

def get_log(self):"""Get RC logs associated with current session.

"""return self.get_string("getLog", [])

def check(self,locator):"""Check a toggle-button (checkbox/radio)

'locator' is an element locator"""self.do_command("check", [locator,])

def uncheck(self,locator):"""Uncheck a toggle-button (checkbox/radio)

'locator' is an element locator"""

self.do_command("uncheck", [locator,])


13/40

def select(self,selectLocator,optionLocator):"""Select an option from a drop-down using an option locator.

Option locators provide different ways of specifying options of an HTML

Select element (e.g. for selecting a specific option, or for assertingthat the selected option satisfies a specification). There are severalforms of Select Option Locator.

* \ **label**\ =\ *labelPattern*:matches options based on their labels, i.e. the visible text. (Thisis the default.)

* label=regexp:^[Oo]ther

* \ **value**\ =\ *valuePattern*:matches options based on their values.

* value=other

* \ **id**\ =\ *id*:

matches options based on their ids.

* id=option1

* \ **index**\ =\ *index*:matches an option based on its index (offset from zero).

* index=2

If no option locator prefix is provided, the default behaviour is to match on \ **label**\ .

'selectLocator' is an element locator identifying a drop-down menu'optionLocator' is an option locator (a label by default)"""self.do_command("select", [selectLocator,optionLocator,])

def add_selection(self,locator,optionLocator):"""Add a selection to the set of selected options in a multi-select element

using an option locator.

@see #doSelect for details of option locators

'locator' is an element locator identifying a multi-select box


14/40

'optionLocator' is an option locator (a label by default)"""self.do_command("addSelection", [locator,optionLocator,])

def remove_selection(self,locator,optionLocator):"""

Remove a selection from the set of selected options in a multi-select element using an option locator.

@see #doSelect for details of option locators

'locator' is an element locator identifying a multi-select box'optionLocator' is an option locator (a label by default)"""self.do_command("removeSelection", [locator,optionLocator,])

def remove_all_selections(self,locator):

"""Unselects all of the selected options in a multi-select element.

'locator' is an element locator identifying a multi-select box"""self.do_command("removeAllSelections", [locator,])

def submit(self,formLocator):"""Submit the specified form. This is particularly useful for forms withoutsubmit buttons, e.g. single-input "Search" forms.

'formLocator' is an element locator for the form you want to submit"""self.do_command("submit", [formLocator,])

def open(self,url,ignoreResponseCode=False):"""Opens an URL in the test frame. This accepts both relative and absoluteURLs.

The "open" command waits for the page to load before proceeding,ie. the "AndWait" suffix is implicit.

\ *Note*: The URL must be on the same domain as the runner HTMLdue to security restrictions in the browser (Same Origin Policy). If youneed to open an URL on another domain, use the Selenium Server to start

anew browser session on that domain.

'url' is the URL to open; may be relative or absolute'ignoreResponseCode' if set to true: doesnt send ajax HEAD/GET request;

if set to false: sends ajax HEAD/GET request to the url and reports error code if any as response to open.

"""self.do_command("open", [url,ignoreResponseCode])

def open_window(self,url,windowID):"""


15/40

Opens a popup window (if a window with that ID isn't already open).After opening the window, you'll need to select it using the selectWindo

wcommand.

This command can also be a useful workaround for bug SEL-339. In some c

ases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).

In those cases, you can force Selenium to notice the open window's nameby using the Selenium openWindow command, using

an empty (blank) url, like this: openWindow("", "myFunnyWindow").

'url' is the URL to open, which can be blank'windowID' is the JavaScript window ID of the window to select"""self.do_command("openWindow", [url,windowID,])

def select_window(self,windowID):"""Selects a popup window using a window locator; once a popup window has b

een selected, allcommands go to that window. To select the main window again, use nullas the target.

Window locators provide different ways of specifying the window object:by title, by internal JavaScript "name," or by JavaScript variable.

* \ **title**\ =\ *My Special Window*:Finds the window using the text that appears in the title bar. Be c

areful;two windows can share the same title. If that happens, this locator

willjust pick one.

* \ **name**\ =\ *myWindow*:

Finds the window using its internal JavaScript "name" property. This is the second

parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag)

(which Selenium intercepts).

* \ **var**\ =\ *variableName*:Some pop-up windows are unnamed (anonymous), but are associated with

a JavaScript variable name in the currentapplication window, e.g. "window.foo = window.open(url);". In those

cases, you can open the window using"var=foo".

If no window locator prefix is provided, we'll try to guess what you mean like this:


16/40

1.) if windowID is null, (or the string "null") then it is assumed the u

ser is referring to the original window instantiated by the browser).

2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed

that this variable contains the return value from a call to the JavaScri

pt window.open() method.

3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".

4.) If \ *that* fails, we'll try looping over all of the known windows to try to find the appropriate "title".

Since "title" is not necessarily unique, this may have unexpected behavior.

If you're having trouble figuring out the name of a window that you wantto manipulate, look at the Selenium log messages

which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messageslike the following for each window as it is opened:

``debug: window.open call intercepted; window ID (which you can use with

selectWindow()) is "myNewWindow"``

In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).

(This is bug SEL-339.) In those cases, you can force Selenium to noticethe open window's name by using the Selenium openWindow command, using

an empty (blank) url, like this: openWindow("", "myFunnyWindow").

'windowID' is the JavaScript window ID of the window to select"""self.do_command("selectWindow", [windowID,])

def select_pop_up(self,windowID):"""Simplifies the process of selecting a popup window (and does not offerfunctionality beyond what ``selectWindow()`` already provides).

* If ``windowID`` is either not specified, or specified as

"null", the first non-top window is selected. The top window is theone

that would be selected by ``selectWindow()`` without providing a``windowID`` . This should not be used when more than one popupwindow is in play.

* Otherwise, the window will be looked up considering``windowID`` as the following in order: 1) the "name" of thewindow, as specified to ``window.open()``; 2) a javascriptvariable which is a reference to a window; and 3) the title of thewindow. This is the same ordered lookup performed by``selectWindow`` .

'windowID' is an identifier for the popup window, which can take on anumber of different meanings


17/40

"""self.do_command("selectPopUp", [windowID,])

def deselect_pop_up(self):"""Selects the main window. Functionally equivalent to using

``selectWindow()`` and specifying no value for``windowID``.

"""self.do_command("deselectPopUp", [])

def select_frame(self,locator):"""Selects a frame within the current window. (You may invoke this commandmultiple times to select nested frames.) To select the parent frame, us

e

"relative=parent" as a locator; to select the top frame, use "relative=top".You can also select a frame by its 0-based index number; select the firs

t frame with"index=0", or the third frame with "index=2".

You may also use a DOM expression to identify the frame you want directly,

like this: ``dom=frames["main"].frames["subframe"]``

'locator' is an element locator identifying a frame or iframe

"""self.do_command("selectFrame", [locator,])

def get_whether_this_frame_match_frame_expression(self,currentFrameString,target):

"""Determine whether current/locator identify the frame containing this run

ning code.

This is useful in proxy injection mode, where this code runs in everybrowser frame and window, and sometimes the selenium server needs to ide

ntifythe "current" frame. In this case, when the test calls selectFrame, thi

sroutine is called for each frame to figure out which one has been select

ed.The selected frame will return true, while all others will return false.

'currentFrameString' is starting frame'target' is new frame (which might be relative to the current one)"""return self.get_boolean("getWhetherThisFrameMatchFrameExpression", [curr

entFrameString,target,])


18/40

def get_whether_this_window_match_window_expression(self,currentWindowString,target):

"""Determine whether currentWindowString plus target identify the window co

ntaining this running code.

This is useful in proxy injection mode, where this code runs in everybrowser frame and window, and sometimes the selenium server needs to ide

ntifythe "current" window. In this case, when the test calls selectWindow, t

hisroutine is called for each window to figure out which one has been selec

ted.The selected window will return true, while all others will return false

.

'currentWindowString' is starting window

'target' is new window (which might be relative to the current one, e.g., "_parent")"""return self.get_boolean("getWhetherThisWindowMatchWindowExpression", [cu

rrentWindowString,target,])

def wait_for_pop_up(self,windowID,timeout):"""Waits for a popup window to appear and load up.

'windowID' is the JavaScript window "name" of the window that will appea

r (not the text of the title bar) If unspecified, or specified a

s "null", this command will wait for the first non-top window toappear (don't rely on this if you are working with multiple popups simultaneously).

'timeout' is a timeout in milliseconds, after which the action will return with an error. If this value is not specified, the default Selenium timeout will be used. See the setTimeout() command.

"""self.do_command("waitForPopUp", [windowID,timeout,])

def choose_cancel_on_next_confirmation(self):"""

By default, Selenium's overridden window.confirm() function willreturn true, as if the user had manually clicked OK; after runningthis command, the next call to confirm() will return false, as ifthe user had clicked Cancel. Selenium will then resume using thedefault behavior for future confirmations, automatically returningtrue (OK) unless/until you explicitly call this command for eachconfirmation.

Take note - every time a confirmation comes up, you must

consume it with a corresponding getConfirmation, or elsethe next selenium operation will fail.


19/40

"""self.do_command("chooseCancelOnNextConfirmation", [])

def choose_ok_on_next_confirmation(self):

"""

Undo the effect of calling chooseCancelOnNextConfirmation. Notethat Selenium's overridden window.confirm() function will normally autom

aticallyreturn true, as if the user had manually clicked OK, so you shouldn'tneed to use this command unless for some reason you need to changeyour mind prior to the next confirmation. After any confirmation, Selen

ium will resume using thedefault behavior for future confirmations, automatically returningtrue (OK) unless/until you explicitly call chooseCancelOnNextConfirmatio

n for eachconfirmation.

Take note - every time a confirmation comes up, you mustconsume it with a corresponding getConfirmation, or elsethe next selenium operation will fail.

"""self.do_command("chooseOkOnNextConfirmation", [])

def answer_on_next_prompt(self,answer):"""Instructs Selenium to return the specified answer string in response tothe next JavaScript prompt [window.prompt()].

'answer' is the answer to give in response to the prompt pop-up"""self.do_command("answerOnNextPrompt", [answer,])

def go_back(self):"""Simulates the user clicking the "back" button on their browser.

"""self.do_command("goBack", [])

def refresh(self):"""Simulates the user clicking the "Refresh" button on their browser.

"""

self.do_command("refresh", [])


20/40

def close(self):"""Simulates the user clicking the "close" button in the titlebar of a popu

pwindow or tab.

"""

self.do_command("close", [])

def is_alert_present(self):"""Has an alert occurred?

This function never throws an exception

"""return self.get_boolean("isAlertPresent", [])

def is_prompt_present(self):"""Has a prompt occurred?


"""return self.get_boolean("isPromptPresent", [])

def is_confirmation_present(self):"""Has confirm() been called?


"""return self.get_boolean("isConfirmationPresent", [])

def get_alert(self):"""Retrieves the message of a JavaScript alert generated during the previou

s action, or fail if there were no alerts.

Getting an alert has the same effect as manually clicking OK. If analert is generated but you do not consume it with getAlert, the next Sel


21/40

enium actionwill fail.

Under Selenium, JavaScript alerts will NOT pop up a visible alertdialog.

Selenium does NOT support JavaScript alerts that are generated in a

page's onload() event handler. In this case a visible dialog WILL begenerated and Selenium will hang until someone manually clicks OK.

"""return self.get_string("getAlert", [])

def get_confirmation(self):"""Retrieves the message of a JavaScript confirmation dialog generated duri

ng

the previous action.

By default, the confirm function will return true, having the same effect

as manually clicking OK. This can be changed by prior execution of thechooseCancelOnNextConfirmation command.

If an confirmation is generated but you do not consume it with getConfirmation,

the next Selenium action will fail.

NOTE: under Selenium, JavaScript confirmations will NOT pop up a visibledialog.

NOTE: Selenium does NOT support JavaScript confirmations that aregenerated in a page's onload() event handler. In this case a visibledialog WILL be generated and Selenium will hang until you manually clickOK.

"""return self.get_string("getConfirmation", [])

def get_prompt(self):"""Retrieves the message of a JavaScript question prompt dialog generated d

uringthe previous action.

Successful handling of the prompt requires prior execution of the


22/40

answerOnNextPrompt command. If a prompt is generated but youdo not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, JavaScript prompts will NOT pop up a visibledialog.

NOTE: Selenium does NOT support JavaScript prompts that are generated in

apage's onload() event handler. In this case a visible dialog WILL begenerated and Selenium will hang until someone manually clicks OK.

"""return self.get_string("getPrompt", [])

def get_location(self):"""Gets the absolute URL of the current page.

"""return self.get_string("getLocation", [])

def get_title(self):"""Gets the title of the current page.

"""return self.get_string("getTitle", [])

def get_body_text(self):"""Gets the entire text of the page.

"""return self.get_string("getBodyText", [])

def get_value(self,locator):"""Gets the (whitespace-trimmed) value of an input field (or anything else

with a value parameter).For checkbox/radio elements, the value will be "on" or "off" depending o

nwhether the element is checked or not.

'locator' is an element locator"""return self.get_string("getValue", [locator,])

def get_text(self,locator):"""Gets the text of an element. This works for any element that containstext. This command uses either the textContent (Mozilla-like browsers) o

rthe innerText (IE-like browsers) of the element, which is the renderedtext shown to the user.


23/40

'locator' is an element locator"""return self.get_string("getText", [locator,])

def highlight(self,locator):

"""Briefly changes the backgroundColor of the specified element yellow. Us

eful for debugging.

'locator' is an element locator"""self.do_command("highlight", [locator,])

def get_eval(self,script):"""Gets the result of evaluating the specified JavaScript snippet. The sni

ppet mayhave multiple lines, but only the result of the last line will be returned.

Note that, by default, the snippet will run in the context of the "selenium"

object itself, so ``this`` will refer to the Selenium object. Use ``window`` to

refer to the window of your application, e.g. ``window.document.getElementById('foo')``

If you need to use

a locator to refer to a single element in your application page, you canuse ``this.browserbot.findElement("id=foo")`` where "id=foo" is your loc

ator.

'script' is the JavaScript snippet to run"""return self.get_string("getEval", [script,])

def is_checked(self,locator):"""Gets whether a toggle-button (checkbox/radio) is checked. Fails if the

specified element doesn't exist or isn't a toggle-button.

'locator' is an element locator pointing to a checkbox or radio button"""return self.get_boolean("isChecked", [locator,])

def get_table(self,tableCellAddress):"""Gets the text from a cell of a table. The cellAddress syntaxtableLocator.row.column, where row and column start at 0.

'tableCellAddress' is a cell address, e.g. "foo.1.4""""return self.get_string("getTable", [tableCellAddress,])


24/40

def get_selected_labels(self,selectLocator):"""Gets all option labels (visible text) for selected options in the specif

ied select or multi-select element.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string_array("getSelectedLabels", [selectLocator,])

def get_selected_label(self,selectLocator):"""Gets option label (visible text) for selected option in the specified se

lect element.

'selectLocator' is an element locator identifying a drop-down menu"""

return self.get_string("getSelectedLabel", [selectLocator,])

def get_selected_values(self,selectLocator):"""Gets all option values (value attributes) for selected options in the sp

ecified select or multi-select element.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string_array("getSelectedValues", [selectLocator,])

def get_selected_value(self,selectLocator):"""Gets option value (value attribute) for selected option in the specified

select element.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string("getSelectedValue", [selectLocator,])

def get_selected_indexes(self,selectLocator):"""Gets all option indexes (option number, starting at 0) for selected opti

ons in the specified select or multi-select element.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string_array("getSelectedIndexes", [selectLocator,])

def get_selected_index(self,selectLocator):"""Gets option index (option number, starting at 0) for selected option in

the specified select element.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string("getSelectedIndex", [selectLocator,])


25/40

def get_selected_ids(self,selectLocator):"""Gets all option element IDs for selected options in the specified select

or multi-select element.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string_array("getSelectedIds", [selectLocator,])

def get_selected_id(self,selectLocator):"""Gets option element ID for selected option in the specified select eleme

nt.

'selectLocator' is an element locator identifying a drop-down menu"""

return self.get_string("getSelectedId", [selectLocator,])

def is_something_selected(self,selectLocator):"""Determines whether some option in a drop-down menu is selected.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_boolean("isSomethingSelected", [selectLocator,])

def get_select_options(self,selectLocator):

"""Gets all option labels in the specified select drop-down.

'selectLocator' is an element locator identifying a drop-down menu"""return self.get_string_array("getSelectOptions", [selectLocator,])

def get_attribute(self,attributeLocator):"""Gets the value of an element attribute. The value of the attribute maydiffer across browsers (this is the case for the "style" attribute, forexample).

'attributeLocator' is an element locator followed by an @ sign and then

the name of the attribute, e.g. "foo@bar""""return self.get_string("getAttribute", [attributeLocator,])

def is_text_present(self,pattern):"""Verifies that the specified text pattern appears somewhere on the render

ed page shown to the user.

'pattern' is a pattern to match with the text of the page"""return self.get_boolean("isTextPresent", [pattern,])


26/40

def is_element_present(self,locator):"""Verifies that the specified element is somewhere on the page.


"""return self.get_boolean("isElementPresent", [locator,])

def is_visible(self,locator):"""Determines if the specified element is visible. Anelement can be rendered invisible by setting the CSS "visibility"property to "hidden", or the "display" property to "none", either for th

eelement itself or one if its ancestors. This method will fail ifthe element is not present.

'locator' is an element locator"""return self.get_boolean("isVisible", [locator,])

def is_editable(self,locator):"""Determines whether the specified input element is editable, ie hasn't be

en disabled.This method will fail if the specified element isn't an input element.


"""return self.get_boolean("isEditable", [locator,])

def get_all_buttons(self):"""Returns the IDs of all buttons on the page.

If a given button has no ID, it will appear as "" in this array.

"""return self.get_string_array("getAllButtons", [])

def get_all_links(self):"""Returns the IDs of all links on the page.

If a given link has no ID, it will appear as "" in this array.

"""

return self.get_string_array("getAllLinks", [])


27/40

def get_all_fields(self):"""Returns the IDs of all input fields on the page.

If a given field has no ID, it will appear as "" in this array.

"""return self.get_string_array("getAllFields", [])

def get_attribute_from_all_windows(self,attributeName):"""Returns every instance of some attribute from all known windows.

'attributeName' is name of an attribute on the windows"""return self.get_string_array("getAttributeFromAllWindows", [attributeNam

e,])

def dragdrop(self,locator,movementsString):"""deprecated - use dragAndDrop instead

'locator' is an element locator'movementsString' is offset in pixels from the current location to which

the element should be moved, e.g., "+70,-300""""self.do_command("dragdrop", [locator,movementsString,])

def set_mouse_speed(self,pixels):"""Configure the number of pixels between "mousemove" events during dragAnd

Drop commands (default=10).

Setting this value to 0 means that we'll send a "mousemove" event to every single pixel

in between the start location and the end location; that can be very slow, and may

cause some browsers to force the JavaScript to timeout.

If the mouse speed is greater than the distance between the two draggedobjects, we'll

just send one "mousemove" at the start location and then one final one at the end location.

'pixels' is the number of pixels between "mousemove" events"""self.do_command("setMouseSpeed", [pixels,])

def get_mouse_speed(self):"""

Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).


28/40

"""return self.get_number("getMouseSpeed", [])

def drag_and_drop(self,locator,movementsString):"""Drags an element a certain distance and then drops it

'locator' is an element locator'movementsString' is offset in pixels from the current location to which

the element should be moved, e.g., "+70,-300""""self.do_command("dragAndDrop", [locator,movementsString,])

def drag_and_drop_to_object(self,locatorOfObjectToBeDragged,locatorOfDragDestinationObject):

"""Drags an element and drops it on another element

'locatorOfObjectToBeDragged' is an element to be dragged'locatorOfDragDestinationObject' is an element whose location (i.e., who

se center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped

"""self.do_command("dragAndDropToObject", [locatorOfObjectToBeDragged,locat

orOfDragDestinationObject,])

def window_focus(self):"""Gives focus to the currently selected window

"""self.do_command("windowFocus", [])

def window_maximize(self):"""Resize currently selected window to take up the entire screen

"""self.do_command("windowMaximize", [])

def get_all_window_ids(self):"""Returns the IDs of all windows that the browser knows about.

"""return self.get_string_array("getAllWindowIds", [])

def get_all_window_names(self):"""Returns the names of all windows that the browser knows about.

"""return self.get_string_array("getAllWindowNames", [])


29/40

def get_all_window_titles(self):"""Returns the titles of all windows that the browser knows about.

"""return self.get_string_array("getAllWindowTitles", [])

def get_html_source(self):"""Returns the entire HTML source between the opening andclosing "html" tags.

"""return self.get_string("getHtmlSource", [])

def set_cursor_position(self,locator,position):

"""Moves the text cursor to the specified position in the given input element or textarea.

This method will fail if the specified element isn't an input element ortextarea.

'locator' is an element locator pointing to an input element or textarea'position' is the numerical position of the cursor in the field; positio

n should be 0 to move the position to the beginning of the field. You can alsoset the cursor to -1 to move it to the end of the field.

"""self.do_command("setCursorPosition", [locator,position,])

def get_element_index(self,locator):"""Get the relative index of an element to its parent (starting from 0). Th

e comment node and empty text nodewill be ignored.

'locator' is an element locator pointing to an element"""return self.get_number("getElementIndex", [locator,])

def is_ordered(self,locator1,locator2):"""Check if these two elements have same parent and are ordered siblings in

the DOM. Two same elements willnot be considered ordered.

'locator1' is an element locator pointing to the first element'locator2' is an element locator pointing to the second element"""return self.get_boolean("isOrdered", [locator1,locator2,])

def get_element_position_left(self,locator):

"""Retrieves the horizontal position of an element


30/40

'locator' is an element locator pointing to an element OR an element itself

"""return self.get_number("getElementPositionLeft", [locator,])

def get_element_position_top(self,locator):

"""Retrieves the vertical position of an element

'locator' is an element locator pointing to an element OR an element its

elf"""return self.get_number("getElementPositionTop", [locator,])

def get_element_width(self,locator):"""Retrieves the width of an element

'locator' is an element locator pointing to an element"""return self.get_number("getElementWidth", [locator,])

def get_element_height(self,locator):"""Retrieves the height of an element

'locator' is an element locator pointing to an element"""return self.get_number("getElementHeight", [locator,])

def get_cursor_position(self,locator):"""Retrieves the text cursor position in the given input element or textare

a; beware, this may not work perfectly on all browsers.

Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to

return the position of the last location of the cursor, even though thecursor is now gone from the page. This is filed as SEL-243.

This method will fail if the specified element isn't an input element ortextarea, or there is no cursor in the element.

'locator' is an element locator pointing to an input element or textarea"""return self.get_number("getCursorPosition", [locator,])

def get_expression(self,expression):"""Returns the specified expression.

This is useful because of JavaScript preprocessing.It is used to generate commands like assertExpression and waitForExpress


31/40

ion.

'expression' is the value to return"""return self.get_string("getExpression", [expression,])

def get_xpath_count(self,xpath):"""Returns the number of nodes that match the specified xpath, eg. "//table

" would givethe number of tables.

'xpath' is the xpath expression to evaluate. do NOT wrap this expression

in a 'count()' function; we will do that for you."""return self.get_number("getXpathCount", [xpath,])

def assign_id(self,locator,identifier):"""Temporarily sets the "id" attribute of the specified element, so you can

locate it in the futureusing its ID rather than a slow/complicated XPath. This ID will disappe

ar once the page isreloaded.

'locator' is an element locator pointing to an element'identifier' is a string to be used as the ID of the specified element"""self.do_command("assignId", [locator,identifier,])

def allow_native_xpath(self,allow):"""Specifies whether Selenium should use the native in-browser implementati

onof XPath (if any native version is available); if you pass "false" tothis function, we will always use our pure-JavaScript xpath library.Using the pure-JS xpath library can improve the consistency of xpathelement locators between different browser vendors, but the pure-JSversion is much slower than the native implementations.

'allow' is boolean, true means we'll prefer to use native XPath; false m

eans we'll only use JS XPath"""self.do_command("allowNativeXpath", [allow,])

def ignore_attributes_without_value(self,ignore):"""Specifies whether Selenium will ignore xpath attributes that have novalue, i.e. are the empty string, when using the non-native xpathevaluation engine. You'd want to do this for performance reasons in IE.However, this could break certain xpaths, for example an xpath that look

s

for an attribute whose value is NOT the empty string.

The hope is that such xpaths are relatively rare, but the user should


32/40

have the option of using them. Note that this only influences xpathevaluation when using the ajaxslt engine (i.e. not "javascript-xpath").

'ignore' is boolean, true means we'll ignore attributes without value

at the expense of xpath "correctness"; false meanswe'll sacrifice speed for correctness.

"""

self.do_command("ignoreAttributesWithoutValue", [ignore,])

def wait_for_condition(self,script,timeout):"""Runs the specified JavaScript snippet repeatedly until it evaluates to "

true".The snippet may have multiple lines, but only the result of the last lin

ewill be considered.

Note that, by default, the snippet will be run in the runner's test window, not in the windowof your application. To get the window of your application, you can usethe JavaScript snippet ``selenium.browserbot.getCurrentWindow()``, and t

henrun your JavaScript in there

'script' is the JavaScript snippet to run'timeout' is a timeout in milliseconds, after which this command will re

turn with an error"""self.do_command("waitForCondition", [script,timeout,])

def set_timeout(self,timeout):"""Specifies the amount of time that Selenium will wait for actions to comp

lete.

Actions that require waiting include "open" and the "waitFor\*" actions.

The default timeout is 30 seconds.

'timeout' is a timeout in milliseconds, after which the action will return with an error

"""self.do_command("setTimeout", [timeout,])

def wait_for_page_to_load(self,timeout):"""Waits for a new page to load.

You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc.

(which are only available in the JS API).

Selenium constantly keeps track of new pages loading, and sets a "newPag


33/40

eLoaded"flag when it first notices a page load. Running any other Selenium comm

and afterturns the flag to false. Hence, if you want to wait for a page to load,

you mustwait immediately after a Selenium command that caused a page-load.

'timeout' is a timeout in milliseconds, after which this command will return with an error

"""self.do_command("waitForPageToLoad", [timeout,])

def wait_for_frame_to_load(self,frameAddress,timeout):"""Waits for a new frame to load.

Selenium constantly keeps track of new pages and frames loading,and sets a "newPageLoaded" flag when it first notices a page load.

See waitForPageToLoad for more information.

'frameAddress' is FrameAddress from the server side'timeout' is a timeout in milliseconds, after which this command will re

turn with an error"""self.do_command("waitForFrameToLoad", [frameAddress,timeout,])

def get_cookie(self):"""Return all cookies of the current page under test.

"""return self.get_string("getCookie", [])

def get_cookie_by_name(self,name):"""Returns the value of the cookie with the specified name, or throws an er

ror if the cookie is not present.

'name' is the name of the cookie"""return self.get_string("getCookieByName", [name,])

def is_cookie_present(self,name):"""Returns true if a cookie with the specified name is present, or false ot

herwise.

'name' is the name of the cookie"""

return self.get_boolean("isCookiePresent", [name,])


34/40

def create_cookie(self,nameValuePair,optionsString):"""Create a new cookie whose path and domain are same with those of current

pageunder test, unless you specified a path for this cookie explicitly.

'nameValuePair' is name and value of the cookie in a format "name=value"

'optionsString' is options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail.

"""self.do_command("createCookie", [nameValuePair,optionsString,])

def delete_cookie(self,name,optionsString):"""Delete a named cookie with specified path and domain. Be careful; to de

lete a cookie, youneed to delete it using the exact same path and domain that were used tocreate the cookie.

If the path is wrong, or the domain is wrong, the cookie simply won't bedeleted. Also

note that specifying a domain that isn't a subset of the current domainwill usually fail.

Since there's no way to discover at runtime the original path and domainof a given cookie,

we've added an option called 'recurse' to try all sub-domains of the current domain with

all paths that are a subset of the current path. Beware; this option ca

n be slow. Inbig-O notation, it operates in O(n\*m) time, where n is the number of do

ts in the domainname and m is the number of slashes in the path.

'name' is the name of the cookie to be deleted'optionsString' is options for the cookie. Currently supported options i

nclude 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.

"""self.do_command("deleteCookie", [name,optionsString,])

def delete_all_visible_cookies(self):"""Calls deleteCookie with recurse=true on all cookies visible to the curre

nt page.As noted on the documentation for deleteCookie, recurse=true can be much

slowerthan simply deleting the cookies using a known domain/path.

"""self.do_command("deleteAllVisibleCookies", [])

def set_browser_log_level(self,logLevel):


35/40

"""Sets the threshold for browser-side logging messages; log messages benea

th this threshold will be discarded.Valid logLevel strings are: "debug", "info", "warn", "error" or "off".To see the browser logs, you need toeither show the log window in GUI mode, or enable browser-side logging i

n Selenium RC.

'logLevel' is one of the following: "debug", "info", "warn", "error" or

"off""""self.do_command("setBrowserLogLevel", [logLevel,])

def run_script(self,script):"""Creates a new "script" tag in the body of the current test window, andadds the specified text into the body of the command. Scripts run inthis way can often be debugged more easily than scripts executed using

Selenium's "getEval" command. Beware that JS exceptions thrown in thesescripttags aren't managed by Selenium, so you should probably wrap your scriptin try/catch blocks if there is any chance that the script will throwan exception.

'script' is the JavaScript snippet to run"""self.do_command("runScript", [script,])

def add_location_strategy(self,strategyName,functionDefinition):"""

Defines a new function for Selenium to locate elements on the page.For example,if you define the strategy "foo", and someone runs click("foo=blah"), we

'llrun your function, passing you the string "blah", and click on the eleme

ntthat your functionreturns, or throw an "Element not found" error if your function returns

null.

We'll pass three arguments to your function:

* locator: the string the user passed in* inWindow: the currently selected window* inDocument: the currently selected document

The function must return null if the element can't be found.

'strategyName' is the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.

'functionDefinition' is a string defining the body of a function in JavaScript. For example: ``return inDocument.getElementById(locator);``

"""self.do_command("addLocationStrategy", [strategyName,functionDefinition,

])


36/40

def capture_entire_page_screenshot(self,filename,kwargs):"""Saves the entire contents of the current window canvas to a PNG file.Contrast this with the captureScreenshot command, which captures thecontents of the OS viewport (i.e. whatever is currently being displayedon the monitor), and is implemented in the RC only. Currently this onlyworks in Firefox when running in chrome mode, and in IE non-HTA using

the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostlyborrowed from the Screengrab! Firefox extension. Please seehttp://www.screengrab.org and http://snapsie.sourceforge.net/ fordetails.

'filename' is the path to the file to persist the screenshot as. No

filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.

'kwargs' is a kwargs string that modifies the way the screenshotis captured. Example: "background=#CCFFDD" . Currentl

y valid options:

* backgroundthe background CSS for the HTML document. This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causesthe calculation of the canvas dimension to fail and a blackbackground is exposed (possibly obscuring black text).

"""self.do_command("captureEntirePageScreenshot", [filename,kwargs,])

def rollup(self,rollupName,kwargs):

"""Executes a command rollup, which is a series of commands with a uniquename, and optionally arguments that control the generation of the set ofcommands. If any one of the rolled-up commands fails, the rollup isconsidered to have failed. Rollups may also contain nested rollups.

'rollupName' is the name of the rollup command'kwargs' is keyword arguments string that influences how therollup expands into commands"""self.do_command("rollup", [rollupName,kwargs,])

def add_script(self,scriptContent,scriptTagId):"""Loads script content into a new script tag in the Selenium document. Thi

sdiffers from the runScript command in that runScript adds the script tagto the document of the AUT, not the Selenium document. The followingentities in the script content are replaced by the characters theyrepresent:

&

The corresponding remove command is removeScript.


37/40

'scriptContent' is the Javascript content of the script to add'scriptTagId' is (optional) the id of the new script tag. If

specified, and an element with this id alreadyexists, this operation will fail.

"""self.do_command("addScript", [scriptContent,scriptTagId,])

def remove_script(self,scriptTagId):"""Removes a script tag from the Selenium document identified by the givenid. Does nothing if the referenced tag doesn't exist.

'scriptTagId' is the id of the script element to remove."""self.do_command("removeScript", [scriptTagId,])

def use_xpath_library(self,libraryName):

"""Allows choice of one of the available libraries.

'libraryName' is name of the desired library Only the following three can be chosen:

* "ajaxslt" - Google's library* "javascript-xpath" - Cybozu Labs' faster library* "default" - The default library. Currently the default library is "

ajaxslt" .

If libraryName isn't one of these three, then no change will be made."""self.do_command("useXpathLibrary", [libraryName,])

def set_context(self,context):"""Writes a message to the status bar and adds a note to the browser-sidelog.

'context' is the message to be sent to the browser"""self.do_command("setContext", [context,])

def attach_file(self,fieldLocator,fileLocator):"""Sets a file input (upload) field to the file listed in fileLocator

'fieldLocator' is an element locator'fileLocator' is a URL pointing to the specified file. Before the file

can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("\*chrome") only.

"""self.do_command("attachFile", [fieldLocator,fileLocator,])

def capture_screenshot(self,filename):


38/40

"""Captures a PNG screenshot to the specified file.

'filename' is the absolute path to the file to be written, e.g. "c:\blah

\screenshot.png""""self.do_command("captureScreenshot", [filename,])

def capture_screenshot_to_string(self):"""Capture a PNG screenshot. It then returns the file as a base 64 encoded

string.

"""return self.get_string("captureScreenshotToString", [])

def captureNetworkTraffic(self, type):

"""Returns the network traffic seen by the browser, including headers, AJAXrequests, status codes, and timings. When this function is called, the trafficlog is cleared, so the returned content is only the traffic seen since the lastcall.

'type' is The type of data to return the network traffic as. Valid values are: json, xml, or plain.

"""return self.get_string("captureNetworkTraffic", [type,])

def addCustomRequestHeader(self, key, value):"""

Tells the Selenium server to add the specificed key and value as a custom outgoing request header. This only works if the browser is configured to use the built in Selenium proxy.

'key' the header name.'value' the header value."""return self.do_command("addCustomRequestHeader", [key,value,])

def capture_entire_page_screenshot_to_string(self,kwargs):"""Downloads a screenshot of the browser current window canvas to abased 64 encoded PNG file. The \ *entire* windows canvas is captured,including parts rendered outside of the current view port.

Currently this only works in Mozilla and when running in chrome mode.

'kwargs' is A kwargs string that modifies the way the screenshot is capt

ured. Example: "background=#CCFFDD". This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).

"""return self.get_string("captureEntirePageScreenshotToString", [kwargs,])

def shut_down_selenium_server(self):"""


39/40

Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send

commands to the server; you can't remotely start the server once it hasbeen stopped. Normally

you should prefer to run the "stop" command, which terminates the current browser session, rather than

shutting down the entire server.

"""self.do_command("shutDownSeleniumServer", [])

def retrieve_last_remote_control_logs(self):"""Retrieve the last messages logged on a specific remote control. Useful f

or error reports, especiallywhen running multiple remote controls in a distributed environment. The

maximum number of log messagesthat can be retrieve is configured on remote control startup.

"""return self.get_string("retrieveLastRemoteControlLogs", [])

def key_down_native(self,keycode):"""Simulates a user pressing a key (without releasing it yet) by sending a

native operating system keystroke.This function uses the java.awt.Robot class to send a keystroke; this mo

re accurately simulates typinga key on the keyboard. It does not honor settings from the shiftKeyDown

, controlKeyDown, altKeyDown and

metaKeyDown commands, and does not target any particular HTML element.To send a keystroke to a particular

element, focus on the element first before running this command.

'keycode' is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

"""self.do_command("keyDownNative", [keycode,])

def key_up_native(self,keycode):"""Simulates a user releasing a key by sending a native operating system ke

ystroke.This function uses the java.awt.Robot class to send a keystroke; this mo


, controlKeyDown, altKeyDown andmetaKeyDown commands, and does not target any particular HTML element.

To send a keystroke to a particularelement, focus on the element first before running this command.

'keycode' is an integer keycode number corresponding to a java.awt.event

.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes

!"""self.do_command("keyUpNative", [keycode,])


40/40

def key_press_native(self,keycode):"""Simulates a user pressing and releasing a key by sending a native operat

ing system keystroke.This function uses the java.awt.Robot class to send a keystroke; this mo


, controlKeyDown, altKeyDown andmetaKeyDown commands, and does not target any particular HTML element.

To send a keystroke to a particularelement, focus on the element first before running this command.

'keycode' is an integer keycode number corresponding to a java.awt.event

.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

"""self.do_command("keyPressNative", [keycode,])

Documents

Selenium Py