Module selenium :: Class selenium |
[hide private]
[frames] | no frames]

## Class selenium
source code

    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 is
            found, 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*

                Find an element using JavaScript traversal of the HTML Document Object
                Model. DOM locators \ *must* begin with "document.".
                *    dom=document.forms['myForm'].myDropdown
                *    dom=document.images[56]

        *    \ **xpath**\ =\ *xpathExpression*
            Locate an element using an XPath expression.
            *    xpath=//img[@alt='The image alt text']
            *    xpath=//table[@id='table1']//tr[4]/td[2]

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

        Without an explicit locator prefix, Selenium uses the following default
        strategies:

        *    \ **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 elements.  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 a
            kind of limited regular-expression syntax typically used in command-line
            shells. In a glob pattern, "*" represents any sequence of characters, and "?"
            represents any single character. Glob patterns match against the entire
            string.
        *    \ **regexp:**\ \ *regexp*
            Match a string using a regular-expression. The full power of JavaScript
            regular-expressions is available.
        *    \ **exact:**\ \ *string*
            Match a string exactly, verbatim, without any of that fancy wildcard
            stuff.

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

Instance Methods | [hide private]
| __init__(self, host, port, browserStartCommand, browserURL)
| start(self)
| stop(self)
| do_command(self, verb, args)
| get_string(self, verb, args)
| get_string_array(self, verb, args)
| get_number(self, verb, args)
| get_number_array(self, verb, args)
| get_boolean(self, verb, args)
| get_boolean_array(self, verb, args)
| click(self, locator) Clicks on a link, button, checkbox or radio button.
| fire_event(self, locator, eventName) Explicitly simulate an event, to trigger the corresponding "onevent" handler.
| key_press(self, locator, keycode) Simulates a user pressing and releasing a key.
| key_down(self, locator, keycode) Simulates a user pressing a key (without releasing it yet).
| key_up(self, locator, keycode) Simulates a user releasing a key.
| mouse_over(self, locator) Simulates a user hovering a mouse over the specified element.
| mouse_down(self, locator) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
| type(self, locator, value) Sets the value of an input field, as though you typed it in.
| check(self, locator) Check a toggle-button (checkbox/radio)
| uncheck(self, locator) Uncheck a toggle-button (checkbox/radio)
| select(self, selectLocator, optionLocator) Select an option from a drop-down using an option locator.
| add_selection(self, locator, optionLocator) Add a selection to the set of selected options in a multi-select element using an option locator.
| remove_selection(self, locator, optionLocator) Remove a selection from the set of selected options in a multi-select element using an option locator.
| submit(self, formLocator) Submit the specified form.
| open(self, url) Opens an URL in the test frame.
| select_window(self, windowID) Selects a popup window; once a popup window has been selected, all commands go to that window.
| wait_for_pop_up(self, windowID, timeout) Waits for a popup window to appear and load up.
| choose_cancel_on_next_confirmation(self) By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK.
| answer_on_next_prompt(self, answer) Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
| go_back(self) Simulates the user clicking the "back" button on their browser.
| refresh(self) Simulates the user clicking the "Refresh" button on their browser.
| close(self) Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
| is_alert_present(self) Has an alert occurred?
| is_prompt_present(self) Has a prompt occurred?
| is_confirmation_present(self) Has confirm() been called?
| get_alert(self) Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
| get_confirmation(self) Retrieves the message of a JavaScript confirmation dialog generated during the previous action.
| get_prompt(self) Retrieves the message of a JavaScript question prompt dialog generated during the previous action.
| get_location(self) Gets the absolute URL of the current page.
| get_title(self) Gets the title of the current page.
| get_body_text(self) Gets the entire text of the page.
| get_value(self, locator) Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
| get_text(self, locator) Gets the text of an element.
| get_eval(self, script) Gets the result of evaluating the specified JavaScript snippet.
| is_checked(self, locator) Gets whether a toggle-button (checkbox/radio) is checked.
| get_table(self, tableCellAddress) Gets the text from a cell of a table.
| get_selected_labels(self, selectLocator) Gets all option labels (visible text) for selected options in the specified select or multi-select element.
| get_selected_label(self, selectLocator) Gets option label (visible text) for selected option in the specified select element.
| get_selected_values(self, selectLocator) Gets all option values (value attributes) for selected options in the specified select or multi-select element.
| get_selected_value(self, selectLocator) Gets option value (value attribute) for selected option in the specified select element.
| get_selected_indexes(self, selectLocator) Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
| get_selected_index(self, selectLocator) Gets option index (option number, starting at 0) for selected option in the specified select element.
| get_selected_ids(self, selectLocator) Gets all option element IDs for selected options in the specified select or multi-select element.
| get_selected_id(self, selectLocator) Gets option element ID for selected option in the specified select element.
| is_something_selected(self, selectLocator) Determines whether some option in a drop-down menu is selected.
| get_select_options(self, selectLocator) Gets all option labels in the specified select drop-down.
| get_attribute(self, attributeLocator) Gets the value of an element attribute.
| is_text_present(self, pattern) Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
| is_element_present(self, locator) Verifies that the specified element is somewhere on the page.
| is_visible(self, locator) Determines if the specified element is visible.
| is_editable(self, locator) Determines whether the specified input element is editable, ie hasn't been disabled.
| get_all_buttons(self) Returns the IDs of all buttons on the page.
| get_all_links(self) Returns the IDs of all links on the page.
| get_all_fields(self) Returns the IDs of all input fields on the page.
| get_html_source(self) Returns the entire HTML source between the opening and closing "html" tags.
| set_cursor_position(self, locator, position) Moves the text cursor to the specified position in the given input element or textarea.
| get_cursor_position(self, locator) Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
| set_context(self, context, logLevelThreshold) Writes a message to the status bar and adds a note to the browser-side log.
| get_expression(self, expression) Returns the specified expression.
| wait_for_condition(self, script, timeout) Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
| set_timeout(self, timeout) Specifies the amount of time that Selenium will wait for actions to complete.
| wait_for_page_to_load(self, timeout) Waits for a new page to load.

Method Details | [hide private]

### __init__(self, host, port, browserStartCommand, browserURL) (Constructor) | source code

### start(self) | source code

### stop(self) | source code

### do_command(self, verb, args) | source code

### get_string(self, verb, args) | source code

### get_string_array(self, verb, args) | source code

### get_number(self, verb, args) | source code

### get_number_array(self, verb, args) | source code

### get_boolean(self, verb, args) | source code

### get_boolean_array(self, verb, args) | source code

### click(self, locator) | source code
Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad. 'locator' is an element locator

### fire_event(self, locator, eventName) | source code
Explicitly simulate an event, to trigger the corresponding "onevent" handler. 'locator' is an element locator 'eventName' is the event name, e.g. "focus" or "blur"

### key_press(self, locator, keycode) | source code
    Simulates a user pressing and releasing a key.

    'locator' is an element locator
    'keycode' is the numeric keycode of the key to be pressed, normally the
                ASCII value of that key.

### key_down(self, locator, keycode) | source code
    Simulates a user pressing a key (without releasing it yet).

    'locator' is an element locator
    'keycode' is the numeric keycode of the key to be pressed, normally the
                ASCII value of that key.

### key_up(self, locator, keycode) | source code
    Simulates a user releasing a key.

    'locator' is an element locator
    'keycode' is the numeric keycode of the key to be released, normally the
                ASCII value of that key.

### mouse_over(self, locator) | source code
Simulates a user hovering a mouse over the specified element. 'locator' is an element locator

### mouse_down(self, locator) | source code
Simulates a user pressing the mouse button (without releasing it yet) on the specified element. 'locator' is an element locator

### type(self, locator, value) | source code
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 these 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

### check(self, locator) | source code
Check a toggle-button (checkbox/radio) 'locator' is an element locator

### uncheck(self, locator) | source code
Uncheck a toggle-button (checkbox/radio) 'locator' is an element locator

### select(self, selectLocator, optionLocator) | source code
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 asserting that the selected option satisfies a specification). There are several forms of Select Option Locator. label=labelPattern matches options based on their labels, i.e. the visible text. (This is 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)

### add_selection(self, locator, optionLocator) | source code
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 'optionLocator' is an option locator (a label by default)

### remove_selection(self, locator, optionLocator) | source code
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)

### submit(self, formLocator) | source code
Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms. 'formLocator' is an element locator for the form you want to submit

### open(self, url) | source code
Opens an URL in the test frame. This accepts both relative and absolute URLs. 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 HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain. 'url' is the URL to open; may be relative or absolute

### select_window(self, windowID) | source code
Selects a popup window; once a popup window has been selected, all commands go to that window. To select the main window again, use "null" as the target. 'windowID' is the JavaScript window ID of the window to select

### wait_for_pop_up(self, windowID, timeout) | source code
Waits for a popup window to appear and load up. 'windowID' is the JavaScript window ID of the window that will appear 'timeout' is a timeout in milliseconds, after which the action will return with an error

### choose_cancel_on_next_confirmation(self) | source code
By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK. After running this command, the next call to confirm() will return false, as if the user had clicked Cancel.

### answer_on_next_prompt(self, answer) | source code
Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. 'answer' is the answer to give in response to the prompt pop-up

### go_back(self) | source code
Simulates the user clicking the "back" button on their browser.

### refresh(self) | source code
Simulates the user clicking the "Refresh" button on their browser.

### close(self) | source code
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.

### is_alert_present(self) | source code
Has an alert occurred? This function never throws an exception

### is_prompt_present(self) | source code
Has a prompt occurred? This function never throws an exception

### is_confirmation_present(self) | source code
Has confirm() been called? This function never throws an exception

### get_alert(self) | source code
Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts. Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert dialog. NOTE: Selenium does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

### get_confirmation(self) | source code
Retrieves the message of a JavaScript confirmation dialog generated during 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 the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog. NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.

### get_prompt(self) | source code
Retrieves the message of a JavaScript question prompt dialog generated during the previous action. Successful handling of the prompt requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript prompts will NOT pop up a visible dialog. NOTE: Selenium does NOT support JavaScript prompts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

### get_location(self) | source code
Gets the absolute URL of the current page.

### get_title(self) | source code
Gets the title of the current page.

### get_body_text(self) | source code
Gets the entire text of the page.

### get_value(self, locator) | source code
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 on whether the element is checked or not. 'locator' is an element locator

### get_text(self, locator) | source code
Gets the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user. 'locator' is an element locator

### get_eval(self, script) | source code
Gets the result of evaluating the specified JavaScript snippet. The snippet may have 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, and `window` will refer to the top-level runner test window, not the window of your application. If you need a reference to the window of your application, you can refer to `this.browserbot.getCurrentWindow()` and if you need to use a locator to refer to a single element in your application page, you can use `this.page().findElement("foo")` where "foo" is your locator. 'script' is the JavaScript snippet to run

### is_checked(self, locator) | source code
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

### get_table(self, tableCellAddress) | source code
Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. 'tableCellAddress' is a cell address, e.g. "foo.1.4"

### get_selected_labels(self, selectLocator) | source code
Gets all option labels (visible text) for selected options in the specified select or multi-select element. 'selectLocator' is an element locator identifying a drop-down menu

### get_selected_label(self, selectLocator) | source code
Gets option label (visible text) for selected option in the specified select element. 'selectLocator' is an element locator identifying a drop-down menu

### get_selected_values(self, selectLocator) | source code
Gets all option values (value attributes) for selected options in the specified select or multi-select element. 'selectLocator' is an element locator identifying a drop-down menu

### get_selected_value(self, selectLocator) | source code
Gets option value (value attribute) for selected option in the specified select element. 'selectLocator' is an element locator identifying a drop-down menu

### get_selected_indexes(self, selectLocator) | source code
Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. 'selectLocator' is an element locator identifying a drop-down menu

### get_selected_index(self, selectLocator) | source code
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

### get_selected_ids(self, selectLocator) | source code
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

### get_selected_id(self, selectLocator) | source code
Gets option element ID for selected option in the specified select element. 'selectLocator' is an element locator identifying a drop-down menu

### is_something_selected(self, selectLocator) | source code
Determines whether some option in a drop-down menu is selected. 'selectLocator' is an element locator identifying a drop-down menu

### get_select_options(self, selectLocator) | source code
Gets all option labels in the specified select drop-down. 'selectLocator' is an element locator identifying a drop-down menu

### get_attribute(self, attributeLocator) | source code
Gets the value of an element attribute. 'attributeLocator' is an element locator followed by an

### is_text_present(self, pattern) | source code
Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. 'pattern' is a pattern to match with the text of the page

### is_element_present(self, locator) | source code
Verifies that the specified element is somewhere on the page. 'locator' is an element locator

### is_visible(self, locator) | source code
Determines if the specified element is visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. This method will fail if the element is not present. 'locator' is an element locator

### is_editable(self, locator) | source code
Determines whether the specified input element is editable, ie hasn't been disabled. This method will fail if the specified element isn't an input element. 'locator' is an element locator

### get_all_buttons(self) | source code
Returns the IDs of all buttons on the page. If a given button has no ID, it will appear as "" in this array.

### get_all_links(self) | source code
Returns the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array.

### get_all_fields(self) | source code
Returns the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array.

### get_html_source(self) | source code
Returns the entire HTML source between the opening and closing "html" tags.

### set_cursor_position(self, locator, position) | source code
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 or textarea. 'locator' is an element locator pointing to an input element or textarea 'position' is the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.

### get_cursor_position(self, locator) | source code
Retrieves the text cursor position in the given input element or textarea; 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 the cursor 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 or textarea, or there is no cursor in the element. 'locator' is an element locator pointing to an input element or textarea

### set_context(self, context, logLevelThreshold) | source code
Writes a message to the status bar and adds a note to the browser-side log. If logLevelThreshold is specified, set the threshold for logging to that level (debug, info, warn, error). (Note that the browser-side logs will not be sent back to the server, and are invisible to the Client Driver.) 'context' is the message to be sent to the browser 'logLevelThreshold' is one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

### get_expression(self, expression) | source code
Returns the specified expression. This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. 'expression' is the value to return

### wait_for_condition(self, script, timeout) | source code
Runs the specified JavaScript snippet repeatedly until it evaluates to "true". The snippet may have multiple lines, but only the result of the last line will be considered. Note that, by default, the snippet will be run in the runner's test window, not in the window of your application. To get the window of your application, you can use the JavaScript snippet `selenium.browserbot.getCurrentWindow()`, and then run your JavaScript in there 'script' is the JavaScript snippet to run 'timeout' is a timeout in milliseconds, after which this command will return with an error

### set_timeout(self, timeout) | source code
Specifies the amount of time that Selenium will wait for actions to complete. 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

### wait_for_page_to_load(self, timeout) | source code
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 "newPageLoaded" flag when it first notices a page load. Running any other Selenium command after turns the flag to false. Hence, if you want to wait for a page to load, you must wait 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