Selenium Python Readthedocs Io en Latest
Selenium Python Readthedocs Io en Latest
Release 2
Baiju Muthukadan
1 Installation 3
1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Installing Python bindings for Selenium . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Instructions for Windows users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4 Installing from Git sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.5 Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.6 Downloading Selenium server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Getting Started 7
2.1 Simple Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 Example Explained . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.3 Using Selenium to write tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4 Walkthrough of the example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.5 Using Selenium with remote WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3 Navigating 13
3.1 Interacting with the page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2 Filling in forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.3 Drag and drop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.4 Moving between windows and frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.5 Popup dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.6 Navigation: history and location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.7 Cookies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4 Locating Elements 17
4.1 Locating by Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.2 Locating by Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.3 Locating by XPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.4 Locating Hyperlinks by Link Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.5 Locating Elements by Tag Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.6 Locating Elements by Class Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.7 Locating Elements by CSS Selectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5 Waits 23
5.1 Explicit Waits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
5.2 Implicit Waits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
i
6 Page Objects 27
6.1 Test case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.2 Page object classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
6.3 Page elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.4 Locators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7 WebDriver API 31
7.1 Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
7.2 Action Chains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
7.3 Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
7.4 Special Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
7.5 Locate elements By . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
7.6 Desired Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
7.7 Touch Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
7.8 Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
7.9 Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
7.10 Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
7.11 Application Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
7.12 Firefox WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
7.13 Firefox WebDriver Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
7.14 Firefox WebDriver Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7.15 Firefox WebDriver Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.16 Firefox WebDriver Extension Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.17 Chrome WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7.18 Chrome WebDriver Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
7.19 Chrome WebDriver Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.20 Remote WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
7.21 Remote WebDriver WebElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
7.22 Remote WebDriver Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.23 Remote WebDriver Error Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
7.24 Remote WebDriver Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
7.25 Remote WebDriver Remote Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
7.26 Remote WebDriver Utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
7.27 Internet Explorer WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
7.28 Android WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
7.29 Opera WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
7.30 PhantomJS WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
7.31 PhantomJS WebDriver Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
7.32 Safari WebDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
7.33 Safari WebDriver Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
7.34 Select Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
7.35 Wait Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
7.36 Color Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.37 Event Firing WebDriver Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
7.38 Abstract Event Listener Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
7.39 Expected conditions Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
ii
8.7 How to take screenshot of the current window ? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Index 103
iii
iv
Selenium Python Bindings, Release 2
Note: This is not an official documentation. If you would like to contribute to this documentation, you can fork this
project in GitHub and send pull requests. You can also send your feedback to my email: baiju.m.mail AT gmail DOT
com. So far 50+ community members have contributed to this project (See the closed pull requests). I encourage con-
tributors to add more sections and make it an awesome documentation! If you know any translation of this document,
please send a PR to update the below list.
Translations:
• Chinese
• Japanese
Contents 1
Selenium Python Bindings, Release 2
2 Contents
CHAPTER 1
Installation
1.1 Introduction
Selenium Python bindings provides a simple API to write functional/acceptance tests using Selenium WebDriver.
Through Selenium Python API you can access all functionalities of Selenium WebDriver in an intuitive way.
Selenium Python bindings provide a convenient API to access Selenium WebDrivers like Firefox, Ie, Chrome, Remote
etc. The current supported Python versions are 3.5 and above.
This documentation explains Selenium 2 WebDriver API. Selenium 1 / Selenium RC API is not covered here.
Use pip to install the selenium package. Python 3 has pip available in the standard library. Using pip, you can install
selenium like this:
You may consider using virtualenv to create isolated Python environments. Python 3 has venv which is almost the
same as virtualenv.
You can also download Python bindings for Selenium from the PyPI page for selenium package. and install manually.
3
Selenium Python Bindings, Release 2
Now you can run your test scripts using Python. For example, if you have created a Selenium based script and saved
it inside C:\my_selenium_script.py, you can run it like this:
C:\Python39\python.exe C:\my_selenium_script.py
To build Selenium Python from the source code, clone the official repository. It contains the source code for all official
Selenium flavors, like Python, Java, Ruby and others. The Python code resides in the /py directory. To build, you
will also need the Bazel build system.
Note: Currently, as Selenium gets near to the 4.0.0 release, it requires Bazel 3.2.0 (Install instructions), even though
3.3.0 is already available.
To build a Wheel from the sources, run the following command from the repository root:
bazel //py:selenium-wheel
This command will prepare the source code with some preprocessed JS files needed by some webdriver modules and
build the .whl package inside the ./bazel-bin/py/ directory. Afterwards, you can use pip to install it.
1.5 Drivers
Selenium requires a driver to interface with the chosen browser. Firefox, for example, requires geckodriver, which
needs to be installed before the below examples can be run. Make sure it’s in your PATH, e. g., place it in /usr/bin or
/usr/local/bin.
Failure to observe this step will give you an error selenium.common.exceptions.WebDriverException: Message: ‘geck-
odriver’ executable needs to be in PATH.
Other supported browsers will have their own drivers available. Links to some of the more popular browser drivers
follow.
Chrome: https://sites.google.com/a/chromium.org/chromedriver/downloads
Edge: https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/
Firefox: https://github.com/mozilla/geckodriver/releases
Safari: https://webkit.org/blog/6900/webdriver-support-in-safari-10/
For more information about driver installation, please refer the official documentation.
Note: The Selenium server is only required if you want to use the remote WebDriver. See the Using Selenium
with remote WebDriver section for more details. If you are a beginner learning Selenium, you can skip this section
4 Chapter 1. Installation
Selenium Python Bindings, Release 2
Selenium server is a Java program. Java Runtime Environment (JRE) 1.6 or newer version is recommended to run
Selenium server.
You can download Selenium server 2.x from the download page of selenium website. The file name should be some-
thing like this: selenium-server-standalone-2.x.x.jar. You can always download the latest 2.x version
of Selenium server.
If Java Runtime Environment (JRE) is not installed in your system, you can download the JRE from the Oracle website.
If you are using a GNU/Linux system and have root access in your system, you can also use your operating system
instructions to install JRE.
If java command is available in the PATH (environment variable), you can start the Selenium server using this com-
mand:
Replace 2.x.x with the actual version of Selenium server you downloaded from the site.
If JRE is installed as a non-root user and/or if it is not available in the PATH (environment variable), you can type
the relative or absolute path to the java command. Similarly, you can provide a relative or absolute path to Selenium
server jar file. Then, the command will look something like this:
6 Chapter 1. Installation
CHAPTER 2
Getting Started
If you have installed Selenium Python bindings, you can start using it from Python like this.
driver = webdriver.Firefox()
driver.get("http://www.python.org")
assert "Python" in driver.title
elem = driver.find_element_by_name("q")
elem.clear()
elem.send_keys("pycon")
elem.send_keys(Keys.RETURN)
assert "No results found." not in driver.page_source
driver.close()
The above script can be saved into a file (eg:- python_org_search.py), then it can be run like this:
python python_org_search.py
The python which you are running should have the selenium module installed.
The selenium.webdriver module provides all the WebDriver implementations. Currently supported WebDriver imple-
mentations are Firefox, Chrome, IE and Remote. The Keys class provide keys in the keyboard like RETURN, F1, ALT
etc.
7
Selenium Python Bindings, Release 2
The driver.get method will navigate to a page given by the URL. WebDriver will wait until the page has fully loaded
(that is, the “onload” event has fired) before returning control to your test or script. Be aware that if your page uses a
lot of AJAX on load then WebDriver may not know when it has completely loaded:
driver.get("http://www.python.org")
The next line is an assertion to confirm that title has “Python” word in it:
assert "Python" in driver.title
WebDriver offers a number of ways to find elements using one of the find_element_by_* methods. For example, the
input text element can be located by its name attribute using find_element_by_name method. A detailed explanation
of finding elements is available in the Locating Elements chapter:
elem = driver.find_element_by_name("q")
Next, we are sending keys, this is similar to entering keys using your keyboard. Special keys can be sent using Keys
class imported from selenium.webdriver.common.keys. To be safe, we’ll first clear any pre-populated text in the input
field (e.g. “Search”) so it doesn’t affect our search results:
elem.clear()
elem.send_keys("pycon")
elem.send_keys(Keys.RETURN)
After submission of the page, you should get the result if there is any. To ensure that some results are found, make an
assertion:
assert "No results found." not in driver.page_source
Finally, the browser window is closed. You can also call quit method instead of close. The quit will exit entire browser
whereas close will close one tab, but if just one tab was open, by default most browser will exit entirely.:
driver.close()
Selenium is mostly used for writing test cases. The selenium package itself doesn’t provide a testing tool/framework.
You can write test cases using Python’s unittest module. The other options for a tool/framework are pytest and nose.
In this chapter, we use unittest as the framework of choice. Here is the modified example which uses unittest module.
This is a test for python.org search functionality:
import unittest
from selenium import webdriver
from selenium.webdriver.common.keys import Keys
class PythonOrgSearch(unittest.TestCase):
def setUp(self):
self.driver = webdriver.Firefox()
def tearDown(self):
self.driver.close()
if __name__ == "__main__":
unittest.main()
You can run the above test case from a shell like this:
python test_python_org_search.py
.
----------------------------------------------------------------------
Ran 1 test in 15.566s
OK
The above result shows that the test has been successfully completed.
Note: To run the above test in IPython or Jupyter, you should pass a couple of arguments to the main function as
shown below:
unittest.main(argv=['first-arg-is-ignored'], exit=False)
Initially, all the basic modules required are imported. The unittest module is a built-in Python based on Java’s JUnit.
This module provides the framework for organizing the test cases. The selenium.webdriver module provides all the
WebDriver implementations. Currently supported WebDriver implementations are Firefox, Chrome, IE and Remote.
The Keys class provides keys in the keyboard like RETURN, F1, ALT etc.
import unittest
from selenium import webdriver
from selenium.webdriver.common.keys import Keys
The test case class is inherited from unittest.TestCase. Inheriting from TestCase class is the way to tell unittest module
that this is a test case:
class PythonOrgSearch(unittest.TestCase):
The setUp is part of initialization, this method will get called before every test function which you are going to write
in this test case class. Here you are creating the instance of Firefox WebDriver.
def setUp(self):
self.driver = webdriver.Firefox()
This is the test case method. The test case method should always start with characters test. The first line inside this
method create a local reference to the driver object created in setUp method.
def test_search_in_python_org(self):
driver = self.driver
The driver.get method will navigate to a page given by the URL. WebDriver will wait until the page has fully loaded
(that is, the “onload” event has fired) before returning control to your test or script. Be aware that if your page uses a
lot of AJAX on load then WebDriver may not know when it has completely loaded:
driver.get("http://www.python.org")
The next line is an assertion to confirm that title has “Python” word in it:
self.assertIn("Python", driver.title)
WebDriver offers a number of ways to find elements using one of the find_element_by_* methods. For example, the
input text element can be located by its name attribute using find_element_by_name method. Detailed explanation of
finding elements is available in the Locating Elements chapter:
elem = driver.find_element_by_name("q")
Next, we are sending keys, this is similar to entering keys using your keyboard. Special keys can be send using Keys
class imported from selenium.webdriver.common.keys:
elem.send_keys("pycon")
elem.send_keys(Keys.RETURN)
After submission of the page, you should get the result as per search if there is any. To ensure that some results are
found, make an assertion:
assert "No results found." not in driver.page_source
The tearDown method will get called after every test method. This is a place to do all cleanup actions. In the current
method, the browser window is closed. You can also call quit method instead of close. The quit will exit the entire
browser, whereas close will close a tab, but if it is the only tab opened, by default most browser will exit entirely.:
def tearDown(self):
self.driver.close()
Final lines are some boiler plate code to run the test suite:
if __name__ == "__main__":
unittest.main()
To use the remote WebDriver, you should have Selenium server running. To run the server, use this command:
java -jar selenium-server-standalone-2.x.x.jar
While running the Selenium server, you could see a message looking like this:
15:43:07.541 INFO - RemoteWebDriver instances should connect to: http://127.0.0.
˓→1:4444/wd/hub
The above line says that you can use this URL for connecting to remote WebDriver. Here are some examples:
driver = webdriver.Remote(
command_executor='http://127.0.0.1:4444/wd/hub',
desired_capabilities=DesiredCapabilities.CHROME)
driver = webdriver.Remote(
command_executor='http://127.0.0.1:4444/wd/hub',
desired_capabilities=DesiredCapabilities.OPERA)
driver = webdriver.Remote(
command_executor='http://127.0.0.1:4444/wd/hub',
desired_capabilities=DesiredCapabilities.HTMLUNITWITHJS)
The desired capabilities is a dictionary, so instead of using the default dictionaries, you can specify the values explic-
itly:
driver = webdriver.Remote(
command_executor='http://127.0.0.1:4444/wd/hub',
desired_capabilities={'browserName': 'htmlunit',
'version': '2',
'javascriptEnabled': True})
Navigating
The first thing you’ll want to do with WebDriver is navigate to a link. The normal way to do this is by calling get
method:
driver.get("http://www.google.com")
WebDriver will wait until the page has fully loaded (that is, the onload event has fired) before returning control to
your test or script. Be aware that if your page uses a lot of AJAX on load then WebDriver may not know when it has
completely loaded. If you need to ensure such pages are fully loaded then you can use waits.
Just being able to go to places isn’t terribly useful. What we’d really like to do is to interact with the pages, or, more
specifically, the HTML elements within a page. First of all, we need to find one. WebDriver offers a number of ways
to find elements. For example, given an element defined as:
element = driver.find_element_by_id("passwd-id")
element = driver.find_element_by_name("passwd")
element = driver.find_element_by_xpath("//input[@id='passwd-id']")
element = driver.find_element_by_css_selector("input#passwd-id")
You can also look for a link by its text, but be careful! The text must be an exact match! You should also be careful
when using XPATH in WebDriver. If there’s more than one element that matches the query, then only the first will be
returned. If nothing can be found, a NoSuchElementException will be raised.
WebDriver has an “Object-based” API; we represent all types of elements using the same interface. This means
that although you may see a lot of possible methods you could invoke when you hit your IDE’s auto-complete key
combination, not all of them will make sense or be valid. Don’t worry! WebDriver will attempt to do the Right Thing,
13
Selenium Python Bindings, Release 2
and if you call a method that makes no sense (“setSelected()” on a “meta” tag, for example) an exception will be
raised.
So, you’ve got an element. What can you do with it? First of all, you may want to enter some text into a text field:
element.send_keys("some text")
You can simulate pressing the arrow keys by using the “Keys” class:
It is possible to call send_keys on any element, which makes it possible to test keyboard shortcuts such as those used
on GMail. A side-effect of this is that typing something into a text field won’t automatically clear it. Instead, what
you type will be appended to what’s already there. You can easily clear the contents of a text field or textarea with the
clear method:
element.clear()
We’ve already seen how to enter text into a textarea or text field, but what about the other elements? You can “toggle”
the state of the drop down, and you can use “setSelected” to set something like an OPTION tag selected. Dealing with
SELECT tags isn’t too bad:
element = driver.find_element_by_xpath("//select[@name='name']")
all_options = element.find_elements_by_tag_name("option")
for option in all_options:
print("Value is: %s" % option.get_attribute("value"))
option.click()
This will find the first “SELECT” element on the page, and cycle through each of its OPTIONs in turn, printing out
their values, and selecting each in turn.
As you can see, this isn’t the most efficient way of dealing with SELECT elements. WebDriver’s support classes
include one called a “Select”, which provides useful methods for interacting with these:
WebDriver also provides features for deselecting all the selected options:
select = Select(driver.find_element_by_id('id'))
select.deselect_all()
This will deselect all OPTIONs from that particular SELECT on the page.
Suppose in a test, we need the list of all default selected options, Select class provides a property method that returns
a list:
select = Select(driver.find_element_by_xpath("//select[@name='name']"))
all_selected_options = select.all_selected_options
14 Chapter 3. Navigating
Selenium Python Bindings, Release 2
options = select.options
Once you’ve finished filling out the form, you probably want to submit it. One way to do this would be to find the
“submit” button and click it:
Alternatively, WebDriver has the convenience method “submit” on every element. If you call this on an element within
a form, WebDriver will walk up the DOM until it finds the enclosing form and then calls submit on that. If the element
isn’t in a form, then the NoSuchElementException will be raised:
element.submit()
You can use drag and drop, either moving an element by a certain amount, or on to another element:
element = driver.find_element_by_name("source")
target = driver.find_element_by_name("target")
It’s rare for a modern web application not to have any frames or to be constrained to a single window. WebDriver
supports moving between named windows using the “switch_to_window” method:
driver.switch_to_window("windowName")
All calls to driver will now be interpreted as being directed to the particular window. But how do you know the
window’s name? Take a look at the javascript or link that opened it:
Alternatively, you can pass a “window handle” to the “switch_to_window()” method. Knowing this, it’s possible to
iterate over every open window like so:
You can also swing from frame to frame (or into iframes):
driver.switch_to_frame("frameName")
It’s possible to access subframes by separating the path with a dot, and you can specify the frame by its index too.
That is:
driver.switch_to_frame("frameName.0.child")
would go to the frame named “child” of the first subframe of the frame called “frameName”. All frames are evaluated
as if from *top*.
Once we are done with working on frames, we will have to come back to the parent frame which can be done using:
driver.switch_to_default_content()
Selenium WebDriver has built-in support for handling popup dialog boxes. After you’ve triggered action that would
open a popup, you can access the alert with the following:
alert = driver.switch_to.alert
This will return the currently open alert object. With this object, you can now accept, dismiss, read its contents or even
type into a prompt. This interface works equally well on alerts, confirms, prompts. Refer to the API documentation
for more information.
driver.get("http://www.example.com")
driver.forward()
driver.back()
Please be aware that this functionality depends entirely on the underlying driver. It’s just possible that something
unexpected may happen when you call these methods if you’re used to the behavior of one browser over another.
3.7 Cookies
Before moving to the next section of the tutorial, you may be interested in understanding how to use cookies. First of
all, you need to be on the domain that the cookie will be valid for:
# Now set the cookie. This one's valid for the entire domain
cookie = {‘name’ : ‘foo’, ‘value’ : ‘bar’}
driver.add_cookie(cookie)
# And now output all the available cookies for the current URL
driver.get_cookies()
16 Chapter 3. Navigating
CHAPTER 4
Locating Elements
There are various strategies to locate elements in a page. You can use the most appropriate one for your case. Selenium
provides the following methods to locate elements in a page:
• find_element_by_id
• find_element_by_name
• find_element_by_xpath
• find_element_by_link_text
• find_element_by_partial_link_text
• find_element_by_tag_name
• find_element_by_class_name
• find_element_by_css_selector
To find multiple elements (these methods will return a list):
• find_elements_by_name
• find_elements_by_xpath
• find_elements_by_link_text
• find_elements_by_partial_link_text
• find_elements_by_tag_name
• find_elements_by_class_name
• find_elements_by_css_selector
Apart from the public methods given above, there are two private methods which might be useful for locating page
elements:
• find_element
• find_elements
17
Selenium Python Bindings, Release 2
Example usage:
ID = "id"
XPATH = "xpath"
LINK_TEXT = "link text"
PARTIAL_LINK_TEXT = "partial link text"
NAME = "name"
TAG_NAME = "tag name"
CLASS_NAME = "class name"
CSS_SELECTOR = "css selector"
4.1 Locating by Id
Use this when you know the id attribute of an element. With this strategy, the first element with a matching id attribute
will be returned. If no element has a matching id attribute, a NoSuchElementException will be raised.
For instance, consider this page source:
<html>
<body>
<form id="loginForm">
<input name="username" type="text" />
<input name="password" type="password" />
<input name="continue" type="submit" value="Login" />
</form>
</body>
</html>
login_form = driver.find_element_by_id('loginForm')
Use this when you know the name attribute of an element. With this strategy, the first element with a matching name
attribute will be returned. If no element has a matching name attribute, a NoSuchElementException will be
raised.
For instance, consider this page source:
<html>
<body>
<form id="loginForm">
<input name="username" type="text" />
<input name="password" type="password" />
<input name="continue" type="submit" value="Login" />
(continues on next page)
username = driver.find_element_by_name('username')
password = driver.find_element_by_name('password')
This will give the “Login” button as it occurs before the “Clear” button:
continue = driver.find_element_by_name('continue')
XPath is the language used for locating nodes in an XML document. As HTML can be an implementation of XML
(XHTML), Selenium users can leverage this powerful language to target elements in their web applications. XPath
supports the simple methods of locating by id or name attributes and extends them by opening up all sorts of new
possibilities such as locating the third checkbox on the page.
One of the main reasons for using XPath is when you don’t have a suitable id or name attribute for the element you
wish to locate. You can use XPath to either locate the element in absolute terms (not advised), or relative to an element
that does have an id or name attribute. XPath locators can also be used to specify elements via attributes other than id
and name.
Absolute XPaths contain the location of all elements from the root (html) and as a result are likely to fail with only
the slightest adjustment to the application. By finding a nearby element with an id or name attribute (ideally a parent
element) you can locate your target element based on the relationship. This is much less likely to change and can make
your tests more robust.
For instance, consider this page source:
<html>
<body>
<form id="loginForm">
<input name="username" type="text" />
<input name="password" type="password" />
<input name="continue" type="submit" value="Login" />
<input name="continue" type="button" value="Clear" />
</form>
</body>
</html>
login_form = driver.find_element_by_xpath("/html/body/form[1]")
login_form = driver.find_element_by_xpath("//form[1]")
login_form = driver.find_element_by_xpath("//form[@id='loginForm']")
1. Absolute path (would break if the HTML was changed only slightly)
2. First form element in the HTML
3. The form element with attribute id set to loginForm
username = driver.find_element_by_xpath("//form[input/@name='username']")
username = driver.find_element_by_xpath("//form[@id='loginForm']/input[1]")
username = driver.find_element_by_xpath("//input[@name='username']")
1. First form element with an input child element with name set to username
2. First input child element of the form element with attribute id set to loginForm
3. First input element with attribute name set to username
The “Clear” button element can be located like this:
clear_button = driver.find_element_by_xpath("//input[@name='continue'][@type='button']
˓→")
clear_button = driver.find_element_by_xpath("//form[@id='loginForm']/input[4]")
1. Input with attribute name set to continue and attribute type set to button
2. Fourth input child element of the form element with attribute id set to loginForm
These examples cover some basics, but in order to learn more, the following references are recommended:
• W3Schools XPath Tutorial
• W3C XPath Recommendation
• XPath Tutorial - with interactive examples.
Here is a couple of very useful Add-ons that can assist in discovering the XPath of an element:
• xPath Finder - Plugin to get the elements xPath.
• XPath Helper - for Google Chrome
Use this when you know the link text used within an anchor tag. With this strategy, the first element with
the link text matching the provided value will be returned. If no element has a matching link text attribute, a
NoSuchElementException will be raised.
For instance, consider this page source:
<html>
<body>
<p>Are you sure you want to do this?</p>
<a href="continue.html">Continue</a>
<a href="cancel.html">Cancel</a>
</body>
</html>
continue_link = driver.find_element_by_link_text('Continue')
continue_link = driver.find_element_by_partial_link_text('Conti')
Use this when you want to locate an element by tag name. With this strategy, the first element with the given tag name
will be returned. If no element has a matching tag name, a NoSuchElementException will be raised.
For instance, consider this page source:
<html>
<body>
<h1>Welcome</h1>
<p>Site content goes here.</p>
</body>
</html>
heading1 = driver.find_element_by_tag_name('h1')
Use this when you want to locate an element by class name. With this strategy, the first element with the matching class
name attribute will be returned. If no element has a matching class name attribute, a NoSuchElementException
will be raised.
For instance, consider this page source:
<html>
<body>
<p class="content">Site content goes here.</p>
</body>
</html>
content = driver.find_element_by_class_name('content')
Use this when you want to locate an element using CSS selector syntax. With this strategy, the first ele-
ment matching the given CSS selector will be returned. If no element matches the provided CSS selector, a
NoSuchElementException will be raised.
For instance, consider this page source:
<html>
<body>
<p class="content">Site content goes here.</p>
</body>
</html>
content = driver.find_element_by_css_selector('p.content')
Waits
These days, most of the web apps are using AJAX techniques. When a page is loaded by the browser, the elements
within that page may load at different time intervals. This makes locating elements difficult: if an element is not yet
present in the DOM, a locate function will raise an ElementNotVisibleException exception. Using waits, we can solve
this issue. Waiting provides some slack between actions performed - mostly locating an element or any other operation
with the element.
Selenium Webdriver provides two types of waits - implicit & explicit. An explicit wait makes WebDriver wait for a
certain condition to occur before proceeding further with execution. An implicit wait makes WebDriver poll the DOM
for a certain amount of time when trying to locate an element.
An explicit wait is a code you define to wait for a certain condition to occur before proceeding further in the code.
The extreme case of this is time.sleep(), which sets the condition to an exact time period to wait. There are some
convenience methods provided that help you write code that will wait only as long as required. WebDriverWait in
combination with ExpectedCondition is one way this can be accomplished.
driver = webdriver.Firefox()
driver.get("http://somedomain/url_that_delays_loading")
try:
element = WebDriverWait(driver, 10).until(
EC.presence_of_element_located((By.ID, "myDynamicElement"))
)
finally:
driver.quit()
23
Selenium Python Bindings, Release 2
In the code above, Selenium will wait for a maximum of 10 seconds for an element matching the given criteria to
be found. If no element is found in that time, a TimeoutException is thrown. By default, WebDriverWait calls the
ExpectedCondition every 500 milliseconds until it returns success. ExpectedCondition will return true (Boolean) in
case of success or not null if it fails to locate an element.
Expected Conditions
There are some common conditions that are frequently of use when automating web browsers. Listed below are
the names of each. Selenium Python binding provides some convenience methods so you don’t have to code an
expected_condition class yourself or create your own utility package for them.
• title_is
• title_contains
• presence_of_element_located
• visibility_of_element_located
• visibility_of
• presence_of_all_elements_located
• text_to_be_present_in_element
• text_to_be_present_in_element_value
• frame_to_be_available_and_switch_to_it
• invisibility_of_element_located
• element_to_be_clickable
• staleness_of
• element_to_be_selected
• element_located_to_be_selected
• element_selection_state_to_be
• element_located_selection_state_to_be
• alert_is_present
The expected_conditions module contains a set of predefined conditions to use with WebDriverWait.
Custom Wait Conditions
You can also create custom wait conditions when none of the previous convenience methods fit your requirements.
A custom wait condition can be created using a class with __call__ method which returns False when the condition
doesn’t match.
class element_has_css_class(object):
"""An expectation for checking that an element has a particular css class.
24 Chapter 5. Waits
Selenium Python Bindings, Release 2
An implicit wait tells WebDriver to poll the DOM for a certain amount of time when trying to find any element (or
elements) not immediately available. The default setting is 0 (zero). Once set, the implicit wait is set for the life of the
WebDriver object.
driver = webdriver.Firefox()
driver.implicitly_wait(10) # seconds
driver.get("http://somedomain/url_that_delays_loading")
myDynamicElement = driver.find_element_by_id("myDynamicElement")
26 Chapter 5. Waits
CHAPTER 6
Page Objects
This chapter is a tutorial introduction to the Page Objects design pattern. A page object represents an area where the
test interacts within the web application user interface.
Benefits of using page object pattern:
• Easy to read test cases
• Creating reusable code that can share across multiple test cases
• Reducing the amount of duplicated code
• If the user interface changes, the fix needs changes in only one place
Here is a test case that searches for a word on the python.org website and ensures some results. The following section
will introduce the page module where the page objects will be defined.
import unittest
from selenium import webdriver
import page
class PythonOrgSearch(unittest.TestCase):
"""A sample test class to show how page object works"""
def setUp(self):
self.driver = webdriver.Firefox()
self.driver.get("http://www.python.org")
def test_search_in_python_org(self):
"""Tests python.org search feature. Searches for the word "pycon" then
verified that some results show up. Note that it does not look for
any particular text in search results page. This test verifies that
the results were not empty."""
(continues on next page)
27
Selenium Python Bindings, Release 2
#Load the main page. In this case the home page of Python.org.
main_page = page.MainPage(self.driver)
#Checks if the word "Python" is in title
assert main_page.is_title_matches(), "python.org title doesn't match."
#Sets the text of search textbox to "pycon"
main_page.search_text_element = "pycon"
main_page.click_go_button()
search_results_page = page.SearchResultsPage(self.driver)
#Verifies that the results page is not empty
assert search_results_page.is_results_found(), "No results found."
def tearDown(self):
self.driver.close()
if __name__ == "__main__":
unittest.main()
The page object pattern intends to create an object for each part of a web page. This technique helps build a separation
between the test code and the actual code that interacts with the web page.
The page.py will look like this:
class SearchTextElement(BasePageElement):
"""This class gets the search text from the specified locator"""
class BasePage(object):
"""Base class to initialize the base page that will be called from all
pages"""
class MainPage(BasePage):
"""Home page action methods come here. I.e. Python.org"""
def is_title_matches(self):
"""Verifies that the hardcoded text "Python" appears in page title"""
element = self.driver.find_element(*MainPageLocators.GO_BUTTON)
element.click()
class SearchResultsPage(BasePage):
"""Search results page action methods come here"""
def is_results_found(self):
# Probably should search for this text in the specific page
# element, but as for now it works fine
return "No results found." not in self.driver.page_source
class BasePageElement(object):
"""Base page class that is initialized on every page object class."""
driver = obj.driver
WebDriverWait(driver, 100).until(
lambda driver: driver.find_element_by_name(self.locator))
driver.find_element_by_name(self.locator).clear()
driver.find_element_by_name(self.locator).send_keys(value)
driver = obj.driver
WebDriverWait(driver, 100).until(
lambda driver: driver.find_element_by_name(self.locator))
element = driver.find_element_by_name(self.locator)
return element.get_attribute("value")
6.4 Locators
One of the practices is to separate the locator strings from the place where they are getting used. In this example,
locators of the same page belong to the same class.
The locators.py will look like this:
from selenium.webdriver.common.by import By
class SearchResultsPageLocators(object):
"""A class for search results locators. All search results locators should
come here"""
pass
WebDriver API
Note: This is not an official documentation. Official API documentation is available here.
webdriver.Firefox
webdriver.FirefoxProfile
webdriver.Chrome
webdriver.ChromeOptions
webdriver.Ie
webdriver.Opera
webdriver.PhantomJS
webdriver.Remote
webdriver.DesiredCapabilities
webdriver.ActionChains
webdriver.TouchActions
webdriver.Proxy
The exception classes can be imported like this (Replace the TheNameOfTheExceptionClass with the actual
class name given below):
31
Selenium Python Bindings, Release 2
driver.current_url
driver.close()
7.1 Exceptions
exception selenium.common.exceptions.ElementNotVisibleException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.InvalidElementStateException
Thrown when an element is present on the DOM, but it is not visible, and so is not able to be interacted with.
Most commonly encountered when trying to click or read text of an element that is hidden from view.
exception selenium.common.exceptions.ErrorInResponseException(response, msg)
Bases: selenium.common.exceptions.WebDriverException
Thrown when an error has occurred on the server side.
This may happen when communicating with the firefox extension or the remote driver server.
__init__(response, msg)
Initialize self. See help(type(self)) for accurate signature.
exception selenium.common.exceptions.ImeActivationFailedException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when activating an IME engine has failed.
exception selenium.common.exceptions.ImeNotAvailableException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when IME support is not available. This exception is thrown for every IME-related method call if IME
support is not available on the machine.
exception selenium.common.exceptions.InsecureCertificateException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Navigation caused the user agent to hit a certificate warning, which is usually the result of an expired or invalid
TLS certificate.
exception selenium.common.exceptions.InvalidArgumentException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
The arguments passed to a command are either invalid or malformed.
exception selenium.common.exceptions.InvalidCookieDomainException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when attempting to add a cookie under a different domain than the current URL.
7.1. Exceptions 33
Selenium Python Bindings, Release 2
exception selenium.common.exceptions.InvalidCoordinatesException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
The coordinates provided to an interactions operation are invalid.
exception selenium.common.exceptions.InvalidElementStateException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when a command could not be completed because the element is in an invalid state.
This can be caused by attempting to clear an element that isn’t both editable and resettable.
exception selenium.common.exceptions.InvalidSelectorException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.NoSuchElementException
Thrown when the selector which is used to find an element does not return a WebElement. Currently this only
happens when the selector is an xpath expression and it is either syntactically invalid (i.e. it is not a xpath
expression) or the expression does not select WebElements (e.g. “count(//input)”).
exception selenium.common.exceptions.InvalidSessionIdException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Occurs if the given session id is not in the list of active sessions, meaning the session either does not exist or
that it’s not active.
exception selenium.common.exceptions.InvalidSwitchToTargetException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when frame or window target to be switched doesn’t exist.
exception selenium.common.exceptions.JavascriptException(msg=None,
screen=None, stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
An error occurred while executing JavaScript supplied by the user.
exception selenium.common.exceptions.MoveTargetOutOfBoundsException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when the target provided to the ActionsChains move() method is invalid, i.e. out of document.
exception selenium.common.exceptions.NoAlertPresentException(msg=None,
screen=None,
stacktrace=None)
Bases: selenium.common.exceptions.WebDriverException
print driver.window_handles
exception selenium.common.exceptions.RemoteDriverServerException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
7.1. Exceptions 35
Selenium Python Bindings, Release 2
exception selenium.common.exceptions.ScreenshotException(msg=None,
screen=None, stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
A screen capture was made impossible.
exception selenium.common.exceptions.SessionNotCreatedException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
A new session could not be created.
exception selenium.common.exceptions.StaleElementReferenceException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when a reference to an element is now “stale”.
Stale means the element no longer appears on the DOM of the page.
Possible causes of StaleElementReferenceException include, but not limited to:
• You are no longer on the same page, or the page may have refreshed since the element was located.
• The element may have been removed and re-added to the screen, since it was located. Such as an
element being relocated. This can happen typically with a javascript framework when values are
updated and the node is rebuilt.
• Element may have been inside an iframe or another context which was refreshed.
exception selenium.common.exceptions.TimeoutException(msg=None, screen=None,
stacktrace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when a command does not complete in enough time.
exception selenium.common.exceptions.UnableToSetCookieException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when a driver fails to set a cookie.
exception selenium.common.exceptions.UnexpectedAlertPresentException(msg=None,
screen=None,
stack-
trace=None,
alert_text=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when an unexpected alert is appeared.
Usually raised when when an expected modal is blocking webdriver form executing any more commands.
__init__(msg=None, screen=None, stacktrace=None, alert_text=None)
Initialize self. See help(type(self)) for accurate signature.
exception selenium.common.exceptions.UnexpectedTagNameException(msg=None,
screen=None,
stack-
trace=None)
Bases: selenium.common.exceptions.WebDriverException
Thrown when a support class did not get an expected web element.
exception selenium.common.exceptions.UnknownMethodException(msg=None,
screen=None,
stacktrace=None)
Bases: selenium.common.exceptions.WebDriverException
The requested command matched a known URL but did not match an method for that URL.
exception selenium.common.exceptions.WebDriverException(msg=None, screen=None,
stacktrace=None)
Bases: Exception
Base webdriver exception.
__init__(msg=None, screen=None, stacktrace=None)
Initialize self. See help(type(self)) for accurate signature.
menu = driver.find_element_by_css_selector(".nav")
hidden_submenu = driver.find_element_by_css_selector(".nav #submenu1")
ActionChains(driver).move_to_element(menu).click(hidden_submenu).perform()
menu = driver.find_element_by_css_selector(".nav")
hidden_submenu = driver.find_element_by_css_selector(".nav #submenu1")
actions = ActionChains(driver)
actions.move_to_element(menu)
actions.click(hidden_submenu)
actions.perform()
Either way, the actions are performed in the order they are called, one after another.
__init__(driver)
Creates a new ActionChains.
Args
• driver: The WebDriver instance which performs user actions.
click(on_element=None)
Clicks an element.
Args
• on_element: The element to click. If None, clicks on current mouse position.
click_and_hold(on_element=None)
Holds down the left mouse button on an element.
Args
• on_element: The element to mouse down. If None, clicks on current mouse position.
context_click(on_element=None)
Performs a context-click (right click) on an element.
Args
• on_element: The element to context-click. If None, clicks on current mouse position.
double_click(on_element=None)
Double-clicks an element.
Args
• on_element: The element to double-click. If None, clicks on current mouse position.
drag_and_drop(source, target)
Holds down the left mouse button on the source element, then moves to the target element and releases
the mouse button.
Args
• source: The element to mouse down.
• target: The element to mouse up.
Args
• source: The element to mouse down.
• xoffset: X offset to move to.
• yoffset: Y offset to move to.
key_down(value, element=None)
Sends a key press only, without releasing it. Should only be used with modifier keys (Control, Alt and
Shift).
Args
• value: The modifier key to send. Values are defined in Keys class.
• element: The element to send keys. If None, sends a key to current focused element.
ActionChains(driver).key_down(Keys.CONTROL).send_keys('c').key_up(Keys.
˓→CONTROL).perform()
key_up(value, element=None)
Releases a modifier key.
Args
• value: The modifier key to send. Values are defined in Keys class.
• element: The element to send keys. If None, sends a key to current focused element.
Example, pressing ctrl+c:
ActionChains(driver).key_down(Keys.CONTROL).send_keys('c').key_up(Keys.
˓→CONTROL).perform()
move_by_offset(xoffset, yoffset)
Moving the mouse to an offset from current mouse position.
Args
• xoffset: X offset to move to, as a positive or negative integer.
• yoffset: Y offset to move to, as a positive or negative integer.
move_to_element(to_element)
Moving the mouse to the middle of an element.
Args
• to_element: The WebElement to move to.
move_to_element_with_offset(to_element, xoffset, yoffset)
Move the mouse by an offset of the specified element. Offsets are relative to the top-left corner of the
element.
Args
• to_element: The WebElement to move to.
• xoffset: X offset to move to.
• yoffset: Y offset to move to.
pause(seconds)
Pause all inputs for the specified duration in seconds
perform()
Performs all stored actions.
release(on_element=None)
Releasing a held mouse button on an element.
Args
• on_element: The element to mouse up. If None, releases on current mouse position.
reset_actions()
Clears actions that are already stored locally and on the remote end
send_keys(*keys_to_send)
Sends keys to current focused element.
Args
• keys_to_send: The keys to send. Modifier keys constants can be found in the ‘Keys’ class.
send_keys_to_element(element, *keys_to_send)
Sends keys to an element.
Args
• element: The element to send keys.
• keys_to_send: The keys to send. Modifier keys constants can be found in the ‘Keys’ class.
7.3 Alerts
Alert(driver).accept()
Alert(driver).dismiss()
text
Gets the text of the Alert.
F6 = '\ue036'
F7 = '\ue037'
F8 = '\ue038'
F9 = '\ue039'
HELP = '\ue002'
HOME = '\ue011'
INSERT = '\ue016'
LEFT = '\ue012'
LEFT_ALT = '\ue00a'
LEFT_CONTROL = '\ue009'
LEFT_SHIFT = '\ue008'
META = '\ue03d'
MULTIPLY = '\ue024'
NULL = '\ue000'
NUMPAD0 = '\ue01a'
NUMPAD1 = '\ue01b'
NUMPAD2 = '\ue01c'
NUMPAD3 = '\ue01d'
NUMPAD4 = '\ue01e'
NUMPAD5 = '\ue01f'
NUMPAD6 = '\ue020'
NUMPAD7 = '\ue021'
NUMPAD8 = '\ue022'
NUMPAD9 = '\ue023'
PAGE_DOWN = '\ue00f'
PAGE_UP = '\ue00e'
PAUSE = '\ue00b'
RETURN = '\ue006'
RIGHT = '\ue014'
SEMICOLON = '\ue018'
SEPARATOR = '\ue026'
SHIFT = '\ue008'
SPACE = '\ue00d'
SUBTRACT = '\ue027'
TAB = '\ue004'
UP = '\ue013'
These are the attributes which can be used to locate elements. See the Locating Elements chapter for example usages.
The By implementation.
class selenium.webdriver.common.by.By
Bases: object
Set of supported locator strategies.
CLASS_NAME = 'class name'
CSS_SELECTOR = 'css selector'
ID = 'id'
LINK_TEXT = 'link text'
NAME = 'name'
PARTIAL_LINK_TEXT = 'partial link text'
TAG_NAME = 'tag name'
XPATH = 'xpath'
See the Using Selenium with remote WebDriver section for example usages of desired capabilities.
The Desired Capabilities implementation.
class selenium.webdriver.common.desired_capabilities.DesiredCapabilities
Bases: object
Set of default supported desired capabilities.
Use this as a starting point for creating a desired capabilities object for requesting remote webdrivers for con-
necting to selenium server or selenium grid.
Usage Example:
selenium_grid_url = "http://198.0.0.1:4444/wd/hub"
Note: Always use ‘.copy()’ on the DesiredCapabilities object to avoid the side effects of altering the Global
class instance.
ANDROID = {'browserName': 'android', 'platform': 'ANDROID', 'version': ''}
CHROME = {'browserName': 'chrome', 'platform': 'ANY', 'version': ''}
7.8 Proxy
socks_username
Returns socks proxy username setting.
sslProxy = ''
ssl_proxy
Returns https proxy setting.
class selenium.webdriver.common.proxy.ProxyType
Bases: object
Set of possible types of proxy.
Each proxy type has 2 properties: ‘ff_value’ is value of Firefox profile preference, ‘string’ is id of proxy type.
classmethod load(value)
AUTODETECT = {'ff_value': 4, 'string': 'AUTODETECT'}
DIRECT = {'ff_value': 0, 'string': 'DIRECT'}
MANUAL = {'ff_value': 1, 'string': 'MANUAL'}
PAC = {'ff_value': 2, 'string': 'PAC'}
RESERVED_1 = {'ff_value': 3, 'string': 'RESERVED1'}
SYSTEM = {'ff_value': 5, 'string': 'SYSTEM'}
UNSPECIFIED = {'ff_value': 6, 'string': 'UNSPECIFIED'}
class selenium.webdriver.common.proxy.ProxyTypeFactory
Bases: object
Factory for proxy types.
static make(ff_value, string)
7.9 Utilities
7.9. Utilities 47
Selenium Python Bindings, Release 2
Args
• port - The port to connect.
selenium.webdriver.common.utils.is_url_connectable(port)
Tries to connect to the HTTP server at /status path and specified port to see if it responds successfully.
Args
• port - The port to connect.
selenium.webdriver.common.utils.join_host_port(host, port)
Joins a hostname and port together.
This is a minimal implementation intended to cope with IPv6 literals. For example, _join_host_port(‘::1’, 80)
== ‘[::1]:80’.
Args
• host - A hostname.
• port - An integer port.
selenium.webdriver.common.utils.keys_to_typing(value)
Processes the values that will be typed in the element.
7.10 Service
class selenium.webdriver.common.html5.application_cache.ApplicationCache(driver)
Bases: object
__init__(driver)
Creates a new Aplication Cache.
Args
• driver: The WebDriver instance which performs user actions.
CHECKING = 2
DOWNLOADING = 3
IDLE = 1
OBSOLETE = 5
UNCACHED = 0
UPDATE_READY = 4
status
Returns a current status of application cache.
class selenium.webdriver.firefox.webdriver.WebDriver(firefox_profile=None,
firefox_binary=None,
timeout=30, capabili-
ties=None, proxy=None, exe-
cutable_path=’geckodriver’,
options=None, ser-
vice_log_path=’geckodriver.log’,
firefox_options=None,
service_args=None, de-
sired_capabilities=None,
log_path=None,
keep_alive=True)
Bases: selenium.webdriver.remote.webdriver.WebDriver
__init__(firefox_profile=None, firefox_binary=None, timeout=30, capabilities=None, proxy=None,
executable_path=’geckodriver’, options=None, service_log_path=’geckodriver.log’, fire-
fox_options=None, service_args=None, desired_capabilities=None, log_path=None,
keep_alive=True)
Starts a new local session of Firefox.
Based on the combination and specificity of the various keyword arguments, a capabilities dictionary will
be constructed that is passed to the remote end.
The keyword arguments given to this constructor are helpers to more easily allow Firefox WebDriver
sessions to be customised with different options. They are mapped on to a capabilities dictionary that is
passed on to the remote end.
As some of the options, such as firefox_profile and options.profile are mutually exclusive, precedence is
given from how specific the setting is. capabilities is the least specific keyword argument, followed by
options, followed by firefox_binary and firefox_profile.
In practice this means that if firefox_profile and options.profile are both set, the selected profile instance will
always come from the most specific variable. In this case that would be firefox_profile. This will result in
options.profile to be ignored because it is considered a less specific setting than the top-level firefox_profile
keyword argument. Similarily, if you had specified a capabilities[“moz:firefoxOptions”][“profile”]
Base64 string, this would rank below options.profile.
Parameters
• firefox_profile – Instance of FirefoxProfile object or a string. If undefined,
a fresh profile will be created in a temporary location on the system.
• firefox_binary – Instance of FirefoxBinary or full path to the Firefox binary.
If undefined, the system default Firefox installation will be used.
• timeout – Time to wait for Firefox to launch when using the extension connection.
• capabilities – Dictionary of desired capabilities.
• proxy – The proxy settings to us when communicating with Firefox via the extension
connection.
• executable_path – Full path to override which geckodriver binary to use for Firefox
47.0.1 and greater, which defaults to picking up the binary from the system path.
• options – Instance of options.Options.
• service_log_path – Where to log information from the driver.
• firefox_options – Deprecated argument for options
• service_args – List of args to pass to the driver service
• desired_capabilities – alias of capabilities. In future versions of this library, this
will replace ‘capabilities’. This will make the signature consistent with RemoteWebDriver.
• log_path – Deprecated argument for service_log_path
• keep_alive – Whether to configure remote_connection.RemoteConnection to use
HTTP keep-alive.
context(context)
Sets the context that Selenium commands are running in using a with statement. The state of the context
on the server is saved before entering the block, and restored upon exiting it.
Parameters context – Context, may be one of the class properties CONTEXT_CHROME or
CONTEXT_CONTENT.
Usage example:
with selenium.context(selenium.CONTEXT_CHROME):
# chrome scope
... do stuff ...
install_addon(path, temporary=None)
Installs Firefox addon.
Returns identifier of installed addon. This identifier can later be used to uninstall addon.
Parameters path – Absolute path to the addon that will be installed.
Usage driver.install_addon(‘/path/to/firebug.xpi’)
quit()
Quits the driver and close every associated window.
set_context(context)
uninstall_addon(identifier)
Uninstalls Firefox addon using its identifier.
Usage driver.uninstall_addon(‘[email protected]’)
CONTEXT_CHROME = 'chrome'
CONTEXT_CONTENT = 'content'
NATIVE_EVENTS_ALLOWED = True
firefox_profile
preferences
Returns a dict of preferences.
profile
Returns the Firefox profile to use.
proxy
returns Proxy if set otherwise None.
exception selenium.webdriver.firefox.firefox_profile.AddonFormatError
Bases: Exception
Exception for not well-formed add-on manifest files
class selenium.webdriver.firefox.firefox_profile.FirefoxProfile(profile_directory=None)
Bases: object
__init__(profile_directory=None)
Initialises a new instance of a Firefox Profile
Args
• profile_directory: Directory of profile that you want to use. If a directory is passed in it
will be cloned and the cloned directory will be used by the driver when instantiated. This
defaults to None and will create a new directory when object is created.
add_extension(extension=’webdriver.xpi’)
set_preference(key, value)
sets the preference that we want in the profile.
set_proxy(proxy)
update_preferences()
ANONYMOUS_PROFILE_NAME = 'WEBDRIVER_ANONYMOUS_PROFILE'
DEFAULT_PREFERENCES = None
accept_untrusted_certs
assume_untrusted_cert_issuer
encoded
A zipped, base64 encoded string of profile directory for use with remote WebDriver JSON wire protocol
native_events_enabled
path
Gets the profile directory that is currently being used
port
Gets the port that WebDriver is working on
class selenium.webdriver.firefox.firefox_binary.FirefoxBinary(firefox_path=None,
log_file=None)
Bases: object
__init__(firefox_path=None, log_file=None)
Creates a new instance of Firefox binary.
Args
• firefox_path - Path to the Firefox executable. By default, it will be detected from the
standard locations.
• log_file - A file object to redirect the firefox process output to. It can be sys.stdout.
Please note that with parallel run the output won’t be synchronous. By default, it will
be redirected to /dev/null.
add_command_line_options(*args)
kill()
Kill the browser.
This is useful when the browser is stuck.
launch_browser(profile, timeout=30)
Launches the browser for the given profile name. It is assumed the profile already exists.
which(fname)
Returns the fully qualified path by searching Path of the given name
NO_FOCUS_LIBRARY_NAME = 'x_ignore_nofocus.so'
exception selenium.webdriver.firefox.extension_connection.ExtensionConnectionError
Bases: Exception
An internal error occurred int the extension.
Might be caused by bad input or bugs in webdriver
class selenium.webdriver.firefox.extension_connection.ExtensionConnection(host,
fire-
fox_profile,
fire-
fox_binary=None,
time-
out=30)
Bases: selenium.webdriver.remote.remote_connection.RemoteConnection
__init__(host, firefox_profile, firefox_binary=None, timeout=30)
Initialize self. See help(type(self)) for accurate signature.
connect()
Connects to the extension and retrieves the session id.
classmethod connect_and_quit()
Connects to an running browser and quit immediately.
classmethod is_connectable()
Trys to connect to the extension but do not retrieve context.
quit(sessionId=None)
class selenium.webdriver.chrome.webdriver.WebDriver(executable_path=’chromedriver’,
port=0, options=None,
service_args=None, de-
sired_capabilities=None,
service_log_path=None,
chrome_options=None,
keep_alive=True)
Bases: selenium.webdriver.remote.webdriver.WebDriver
Controls the ChromeDriver and allows you to drive the browser.
You will need to download the ChromeDriver executable from http://chromedriver.storage.googleapis.com/
index.html
__init__(executable_path=’chromedriver’, port=0, options=None, service_args=None,
desired_capabilities=None, service_log_path=None, chrome_options=None,
keep_alive=True)
Creates a new instance of the chrome driver.
Starts the service and then creates new instance of chrome driver.
Args
• executable_path - path to the executable. If the default is used it assumes the executable is
in the $PATH
• port - port you would like the service to run, if left as 0, a free port will be found.
• options - this takes an instance of ChromeOptions
• service_args - List of args to pass to the driver service
• desired_capabilities - Dictionary object with non-browser specific capabilities only, such
as “proxy” or “loggingPref”.
• service_log_path - Where to log information from the driver.
• chrome_options - Deprecated argument for options
• keep_alive - Whether to configure ChromeRemoteConnection to use HTTP keep-alive.
create_options()
execute_cdp_cmd(cmd, cmd_args)
Execute Chrome Devtools Protocol command and get returned result
The command and command args should follow chrome devtools protocol domains/commands, refer to
link https://chromedevtools.github.io/devtools-protocol/
Args
• cmd: A str, command name
• cmd_args: A dict, command args. empty dict {} if there is no command args
Usage driver.execute_cdp_cmd(‘Network.getResponseBody’, {‘requestId’: requestId})
Returns A dict, empty dict {} if there is no result to return. For example to getResponseBody:
{‘base64Encoded’: False, ‘body’: ‘response body string’}
get_network_conditions()
Gets Chrome network emulation settings.
Returns A dict. For example:
{‘latency’: 4, ‘download_throughput’: 2, ‘upload_throughput’: 2, ‘offline’: False}
launch_app(id)
Launches Chrome app specified by id.
quit()
Closes the browser and shuts down the ChromeDriver executable that is started when starting the
ChromeDriver
set_network_conditions(**network_conditions)
Sets Chrome network emulation settings.
Args
• network_conditions: A dict with conditions specification.
Usage
driver.set_network_conditions( offline=False, latency=5, # additional latency (ms) down-
load_throughput=500 * 1024, # maximal throughput upload_throughput=500 * 1024) #
maximal throughput
Note: ‘throughput’ can be used to set both (for download and upload).
class selenium.webdriver.chrome.options.Options
Bases: object
__init__()
Initialize self. See help(type(self)) for accurate signature.
add_argument(argument)
Adds an argument to the list
Args
• Sets the arguments
add_encoded_extension(extension)
Adds Base64 encoded string with extension data to a list that will be used to extract it to the ChromeDriver
Args
• extension: Base64 encoded string with extension data
add_experimental_option(name, value)
Adds an experimental option which is passed to chrome.
Args: name: The experimental option name. value: The option value.
add_extension(extension)
Adds the path to the extension to a list that will be used to extract it to the ChromeDriver
Args
back()
Goes one step backward in the browser history.
Usage driver.back()
close()
Closes the current window.
Usage driver.close()
create_web_element(element_id)
Creates a web element with the specified element_id.
delete_all_cookies()
Delete all cookies in the scope of the session.
Usage driver.delete_all_cookies()
delete_cookie(name)
Deletes a single cookie with the given name.
Usage driver.delete_cookie(‘my_cookie’)
execute(driver_command, params=None)
Sends a command to be executed by a command.CommandExecutor.
Args
• driver_command: The name of the command to execute as a string.
• params: A dictionary of named parameters to send with the command.
Returns The command’s JSON response loaded into a dictionary object.
execute_async_script(script, *args)
Asynchronously Executes JavaScript in the current window/frame.
Args
• script: The JavaScript to execute.
• *args: Any applicable arguments for your JavaScript.
Usage script = “var callback = arguments[arguments.length - 1];
” “window.setTimeout(function(){ callback(‘timeout’) }, 3000);”
driver.execute_async_script(script)
execute_script(script, *args)
Synchronously Executes JavaScript in the current window/frame.
Args
• script: The JavaScript to execute.
• *args: Any applicable arguments for your JavaScript.
Usage driver.execute_script(‘return document.title;’)
file_detector_context(file_detector_class, *args, **kwargs)
Overrides the current file detector (if necessary) in limited context. Ensures the original file detector is set
afterwards.
Example:
Args
• file_detector_class - Class of the desired file detector. If the class is different from
the current file_detector, then the class is instantiated with args and kwargs and used as
a file detector during the duration of the context manager.
• args - Optional arguments that get passed to the file detector class during
instantiation.
• kwargs - Keyword arguments, passed the same way as args.
find_element(by=’id’, value=None)
Find an element given a By strategy and locator. Prefer the find_element_by_* methods when possible.
Usage element = driver.find_element(By.ID, ‘foo’)
Return type WebElement
find_element_by_class_name(name)
Finds an element by class name.
Args
• name: The class name of the element to find.
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
Usage element = driver.find_element_by_class_name(‘foo’)
find_element_by_css_selector(css_selector)
Finds an element by css selector.
Args
• css_selector - CSS selector string, ex: ‘a.nav#home’
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
Usage element = driver.find_element_by_css_selector(‘#foo’)
find_element_by_id(id_)
Finds an element by id.
Args
• id_ - The id of the element to be found.
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
find_element_by_xpath(xpath)
Finds an element by xpath.
Args
• xpath - The xpath locator of the element to find.
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
Usage element = driver.find_element_by_xpath(‘//div/td[1]’)
find_elements(by=’id’, value=None)
Find elements given a By strategy and locator. Prefer the find_elements_by_* methods when possible.
Usage elements = driver.find_elements(By.CLASS_NAME, ‘foo’)
Return type list of WebElement
find_elements_by_class_name(name)
Finds elements by class name.
Args
• name: The class name of the elements to find.
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = driver.find_elements_by_class_name(‘foo’)
find_elements_by_css_selector(css_selector)
Finds elements by css selector.
Args
• css_selector - CSS selector string, ex: ‘a.nav#home’
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = driver.find_elements_by_css_selector(‘.foo’)
find_elements_by_id(id_)
Finds multiple elements by id.
Args
• id_ - The id of the elements to be found.
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = driver.find_elements_by_id(‘foo’)
find_elements_by_link_text(text)
Finds elements by link text.
Args
• link_text: The text of the elements to be found.
Returns
• list of webelement - a list with elements if any was found. an empty list if not
Usage elements = driver.find_elements_by_link_text(‘Sign In’)
find_elements_by_name(name)
Finds elements by name.
Args
• name: The name of the elements to find.
Returns
• list of webelement - a list with elements if any was found. an empty list if not
Usage elements = driver.find_elements_by_name(‘foo’)
find_elements_by_partial_link_text(link_text)
Finds elements by a partial match of their link text.
Args
• link_text: The text of the element to partial match on.
Returns
• list of webelement - a list with elements if any was found. an empty list if not
Usage elements = driver.find_elements_by_partial_link_text(‘Sign’)
find_elements_by_tag_name(name)
Finds elements by tag name.
Args
• name - name of html tag (eg: h1, a, span)
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = driver.find_elements_by_tag_name(‘h1’)
find_elements_by_xpath(xpath)
Finds multiple elements by xpath.
Args
• xpath - The xpath locator of the elements to be found.
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = driver.find_elements_by_xpath(“//div[contains(@class, ‘foo’)]”)
forward()
Goes one step forward in the browser history.
Usage driver.forward()
fullscreen_window()
Invokes the window manager-specific ‘full screen’ operation
get(url)
Loads a web page in the current browser session.
get_cookie(name)
Get a single cookie by name. Returns the cookie if found, None if not.
Usage driver.get_cookie(‘my_cookie’)
get_cookies()
Returns a set of dictionaries, corresponding to cookies visible in the current session.
Usage driver.get_cookies()
get_log(log_type)
Gets the log for a given log type
Args
• log_type: type of log that which will be returned
Usage driver.get_log(‘browser’) driver.get_log(‘driver’) driver.get_log(‘client’)
driver.get_log(‘server’)
get_screenshot_as_base64()
Gets the screenshot of the current window as a base64 encoded string which is useful in embedded
images in HTML.
Usage driver.get_screenshot_as_base64()
get_screenshot_as_file(filename)
Saves a screenshot of the current window to a PNG image file. Returns False if there is any IOError,
else returns True. Use full paths in your filename.
Args
• filename: The full path you wish to save your screenshot to. This should end with a .png
extension.
Usage driver.get_screenshot_as_file(‘/Screenshots/foo.png’)
get_screenshot_as_png()
Gets the screenshot of the current window as a binary data.
Usage driver.get_screenshot_as_png()
get_window_position(windowHandle=’current’)
Gets the x,y position of the current window.
Usage driver.get_window_position()
get_window_rect()
Gets the x, y coordinates of the window as well as height and width of the current window.
Usage driver.get_window_rect()
get_window_size(windowHandle=’current’)
Gets the width and height of the current window.
Usage driver.get_window_size()
implicitly_wait(time_to_wait)
Sets a sticky timeout to implicitly wait for an element to be found, or a command to complete. This
method only needs to be called one time per session. To set the timeout for calls to exe-
cute_async_script, see set_script_timeout.
Args
• time_to_wait: Amount of time to wait (in seconds)
Usage driver.implicitly_wait(30)
maximize_window()
Maximizes the current window that webdriver is using
minimize_window()
Invokes the window manager-specific ‘minimize’ operation
quit()
Quits the driver and closes every associated window.
Usage driver.quit()
refresh()
Refreshes the current page.
Usage driver.refresh()
save_screenshot(filename)
Saves a screenshot of the current window to a PNG image file. Returns False if there is any IOError,
else returns True. Use full paths in your filename.
Args
• filename: The full path you wish to save your screenshot to. This should end with a .png
extension.
Usage driver.save_screenshot(‘/Screenshots/foo.png’)
set_page_load_timeout(time_to_wait)
Set the amount of time to wait for a page load to complete before throwing an error.
Args
• time_to_wait: The amount of time to wait
Usage driver.set_page_load_timeout(30)
set_script_timeout(time_to_wait)
Set the amount of time that the script should wait during an execute_async_script call before throw-
ing an error.
Args
• time_to_wait: The amount of time to wait (in seconds)
Usage driver.set_script_timeout(30)
set_window_position(x, y, windowHandle=’current’)
Sets the x,y position of the current window. (window.moveTo)
Args
• x: the x-coordinate in pixels to set the window position
• y: the y-coordinate in pixels to set the window position
Usage driver.set_window_position(0,0)
set_window_rect(x=None, y=None, width=None, height=None)
Sets the x, y coordinates of the window as well as height and width of the current window.
Usage driver.set_window_rect(x=10, y=10) driver.set_window_rect(width=100, height=200)
driver.set_window_rect(x=10, y=10, width=100, height=200)
set_window_size(width, height, windowHandle=’current’)
Sets the width and height of the current window. (window.resizeTo)
Args
• width: the width in pixels to set the window to
• height: the height in pixels to set the window to
Usage driver.set_window_size(800,600)
start_client()
Called before starting a new session. This method may be overridden to define custom startup behavior.
start_session(capabilities, browser_profile=None)
Creates a new session with the desired capabilities.
Args
• browser_name - The name of the browser to request.
• version - Which browser version to request.
• platform - Which platform to request the browser on.
• javascript_enabled - Whether the new session should support JavaScript.
• browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only
used if Firefox is requested.
stop_client()
Called after executing a quit command. This method may be overridden to define custom shutdown be-
havior.
switch_to_active_element()
Deprecated use driver.switch_to.active_element
switch_to_alert()
Deprecated use driver.switch_to.alert
switch_to_default_content()
Deprecated use driver.switch_to.default_content
switch_to_frame(frame_reference)
Deprecated use driver.switch_to.frame
switch_to_window(window_name)
Deprecated use driver.switch_to.window
application_cache
Returns a ApplicationCache Object to interact with the browser app cache
current_url
Gets the URL of the current page.
Usage driver.current_url
current_window_handle
Returns the handle of the current window.
Usage driver.current_window_handle
desired_capabilities
returns the drivers current desired capabilities being used
file_detector
log_types
Gets a list of the available log types
Usage driver.log_types
mobile
name
Returns the name of the underlying browser for this instance.
Usage name = driver.name
orientation
Gets the current orientation of the device
Usage orientation = driver.orientation
page_source
Gets the source of the current page.
Usage driver.page_source
switch_to
Returns
• SwitchTo: an object containing all options to switch focus into
Usage element = driver.switch_to.active_element alert = driver.switch_to.alert
driver.switch_to.default_content() driver.switch_to.frame(‘frame_name’)
driver.switch_to.frame(1) driver.switch_to.frame(driver.find_elements_by_tag_name(“iframe”)[0])
driver.switch_to.parent_frame() driver.switch_to.window(‘main’)
title
Returns the title of the current page.
Usage title = driver.title
window_handles
Returns the handles of all windows within the current session.
Usage driver.window_handles
All method calls will do a freshness check to ensure that the element reference is still valid. This es-
sentially determines whether or not the element is still attached to the DOM. If this test fails, then an
StaleElementReferenceException is thrown, and all future calls to this instance will fail.
__init__(parent, id_, w3c=False)
Initialize self. See help(type(self)) for accurate signature.
clear()
Clears the text if it’s a text entry element.
click()
Clicks the element.
find_element(by=’id’, value=None)
Find an element given a By strategy and locator. Prefer the find_element_by_* methods when possible.
Usage element = element.find_element(By.ID, ‘foo’)
Return type WebElement
find_element_by_class_name(name)
Finds element within this element’s children by class name.
Args
• name: The class name of the element to find.
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
Usage element = element.find_element_by_class_name(‘foo’)
find_element_by_css_selector(css_selector)
Finds element within this element’s children by CSS selector.
Args
• css_selector - CSS selector string, ex: ‘a.nav#home’
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
Usage element = element.find_element_by_css_selector(‘#foo’)
find_element_by_id(id_)
Finds element within this element’s children by ID.
Args
• id_ - ID of child element to locate.
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
find_element_by_xpath(xpath)
Finds element by xpath.
Args
• xpath - xpath of element to locate. “//input[@class=’myelement’]”
Note: The base path will be relative to this element’s location.
This will select the first link under this element.
myelement.find_element_by_xpath(".//a")
myelement.find_element_by_xpath("//a")
Returns
• WebElement - the element if it was found
Raises
• NoSuchElementException - if the element wasn’t found
Usage element = element.find_element_by_xpath(‘//div/td[1]’)
find_elements(by=’id’, value=None)
Find elements given a By strategy and locator. Prefer the find_elements_by_* methods when possible.
Usage element = element.find_elements(By.CLASS_NAME, ‘foo’)
Return type list of WebElement
find_elements_by_class_name(name)
Finds a list of elements within this element’s children by class name.
Args
• name: The class name of the elements to find.
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = element.find_elements_by_class_name(‘foo’)
find_elements_by_css_selector(css_selector)
Finds a list of elements within this element’s children by CSS selector.
Args
• css_selector - CSS selector string, ex: ‘a.nav#home’
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = element.find_elements_by_css_selector(‘.foo’)
find_elements_by_id(id_)
Finds a list of elements within this element’s children by ID. Will return a list of webelements if found, or
an empty list if not.
Args
myelement.find_elements_by_xpath(".//a")
myelement.find_elements_by_xpath("//a")
Returns
• list of WebElement - a list with elements if any was found. An empty list if not
Usage elements = element.find_elements_by_xpath(“//div[contains(@class, ‘foo’)]”)
get_attribute(name)
Gets the given attribute or property of the element.
This method will first try to return the value of a property with the given name. If a property with that
name doesn’t exist, it returns the value of the attribute with the same name. If there’s no attribute with that
name, None is returned.
Values which are considered truthy, that is equals “true” or “false”, are returned as booleans. All other
non-None values are returned as strings. For attributes or properties which do not exist, None is returned.
Args
• name - Name of the attribute/property to retrieve.
Example:
get_property(name)
Gets the given property of the element.
Args
• name - Name of the property to retrieve.
Example:
text_length = target_element.get_property("text_length")
is_displayed()
Whether the element is visible to a user.
is_enabled()
Returns whether the element is enabled.
is_selected()
Returns whether the element is selected.
Can be used to check if a checkbox or radio button is selected.
screenshot(filename)
Saves a screenshot of the current element to a PNG image file. Returns False if there is any IOError,
else returns True. Use full paths in your filename.
Args
• filename: The full path you wish to save your screenshot to. This should end with a .png
extension.
Usage element.screenshot(‘/Screenshots/foo.png’)
send_keys(*value)
Simulates typing into the element.
Args
• value - A string for typing, or setting form fields. For setting file inputs, this could be a
local file path.
Use this to send simple key events or to fill out form fields:
form_textfield = driver.find_element_by_name('username')
form_textfield.send_keys("admin")
file_input = driver.find_element_by_name('profilePic')
file_input.send_keys("path/to/profilepic.gif")
# Generally it's better to wrap the file path in one of the methods
# in os.path to return the actual path to support cross OS testing.
# file_input.send_keys(os.path.abspath("path/to/profilepic.gif"))
submit()
Submits a form.
value_of_css_property(property_name)
The value of a CSS property.
id
Internal ID used by selenium.
This is mainly for internal use. Simple use cases such as checking if 2 webelements refer to the same
element, can be done using ==:
if element1 == element2:
print("These 2 are equal")
location
The location of the element in the renderable canvas.
location_once_scrolled_into_view
THIS PROPERTY MAY CHANGE WITHOUT WARNING. Use this to discover where on the screen an
element is so that we can click it. This method should cause the element to be scrolled into view.
Returns the top lefthand corner location on the screen, or None if the element is not visible.
parent
Internal reference to the WebDriver instance this element was found from.
rect
A dictionary with the size and location of the element.
screenshot_as_base64
Gets the screenshot of the current element as a base64 encoded string.
Usage img_b64 = element.screenshot_as_base64
screenshot_as_png
Gets the screenshot of the current element as a binary data.
Usage element_png = element.screenshot_as_png
size
The size of the element.
tag_name
This element’s tagName property.
text
The text of the element.
FIND_ELEMENT = 'findElement'
FIND_ELEMENTS = 'findElements'
FLICK = 'touchFlick'
FULLSCREEN_WINDOW = 'fullscreenWindow'
GET = 'get'
GET_ACTIVE_ELEMENT = 'getActiveElement'
GET_ALERT_TEXT = 'getAlertText'
GET_ALL_COOKIES = 'getCookies'
GET_ALL_SESSIONS = 'getAllSessions'
GET_APP_CACHE = 'getAppCache'
GET_APP_CACHE_STATUS = 'getAppCacheStatus'
GET_AVAILABLE_LOG_TYPES = 'getAvailableLogTypes'
GET_COOKIE = 'getCookie'
GET_CURRENT_URL = 'getCurrentUrl'
GET_CURRENT_WINDOW_HANDLE = 'getCurrentWindowHandle'
GET_ELEMENT_ATTRIBUTE = 'getElementAttribute'
GET_ELEMENT_LOCATION = 'getElementLocation'
GET_ELEMENT_LOCATION_ONCE_SCROLLED_INTO_VIEW = 'getElementLocationOnceScrolledIntoView'
GET_ELEMENT_PROPERTY = 'getElementProperty'
GET_ELEMENT_RECT = 'getElementRect'
GET_ELEMENT_SIZE = 'getElementSize'
GET_ELEMENT_TAG_NAME = 'getElementTagName'
GET_ELEMENT_TEXT = 'getElementText'
GET_ELEMENT_VALUE = 'getElementValue'
GET_ELEMENT_VALUE_OF_CSS_PROPERTY = 'getElementValueOfCssProperty'
GET_LOCAL_STORAGE_ITEM = 'getLocalStorageItem'
GET_LOCAL_STORAGE_KEYS = 'getLocalStorageKeys'
GET_LOCAL_STORAGE_SIZE = 'getLocalStorageSize'
GET_LOCATION = 'getLocation'
GET_LOG = 'getLog'
GET_NETWORK_CONNECTION = 'getNetworkConnection'
GET_PAGE_SOURCE = 'getPageSource'
GET_SCREEN_ORIENTATION = 'getScreenOrientation'
GET_SESSION_STORAGE_ITEM = 'getSessionStorageItem'
GET_SESSION_STORAGE_KEYS = 'getSessionStorageKeys'
GET_SESSION_STORAGE_SIZE = 'getSessionStorageSize'
GET_TITLE = 'getTitle'
GET_WINDOW_HANDLES = 'getWindowHandles'
GET_WINDOW_POSITION = 'getWindowPosition'
GET_WINDOW_RECT = 'getWindowRect'
GET_WINDOW_SIZE = 'getWindowSize'
GO_BACK = 'goBack'
GO_FORWARD = 'goForward'
IMPLICIT_WAIT = 'implicitlyWait'
IS_ELEMENT_DISPLAYED = 'isElementDisplayed'
IS_ELEMENT_ENABLED = 'isElementEnabled'
IS_ELEMENT_SELECTED = 'isElementSelected'
LONG_PRESS = 'touchLongPress'
MAXIMIZE_WINDOW = 'windowMaximize'
MINIMIZE_WINDOW = 'minimizeWindow'
MOUSE_DOWN = 'mouseButtonDown'
MOUSE_UP = 'mouseButtonUp'
MOVE_TO = 'mouseMoveTo'
NEW_SESSION = 'newSession'
QUIT = 'quit'
REFRESH = 'refresh'
REMOVE_LOCAL_STORAGE_ITEM = 'removeLocalStorageItem'
REMOVE_SESSION_STORAGE_ITEM = 'removeSessionStorageItem'
SCREENSHOT = 'screenshot'
SEND_KEYS_TO_ACTIVE_ELEMENT = 'sendKeysToActiveElement'
SEND_KEYS_TO_ELEMENT = 'sendKeysToElement'
SET_ALERT_CREDENTIALS = 'setAlertCredentials'
SET_ALERT_VALUE = 'setAlertValue'
SET_ELEMENT_SELECTED = 'setElementSelected'
SET_LOCAL_STORAGE_ITEM = 'setLocalStorageItem'
SET_LOCATION = 'setLocation'
SET_NETWORK_CONNECTION = 'setNetworkConnection'
SET_SCREEN_ORIENTATION = 'setScreenOrientation'
SET_SCRIPT_TIMEOUT = 'setScriptTimeout'
SET_SESSION_STORAGE_ITEM = 'setSessionStorageItem'
SET_TIMEOUTS = 'setTimeouts'
SET_WINDOW_POSITION = 'setWindowPosition'
SET_WINDOW_RECT = 'setWindowRect'
SET_WINDOW_SIZE = 'setWindowSize'
SINGLE_TAP = 'touchSingleTap'
STATUS = 'status'
SUBMIT_ELEMENT = 'submitElement'
SWITCH_TO_CONTEXT = 'switchToContext'
SWITCH_TO_FRAME = 'switchToFrame'
SWITCH_TO_PARENT_FRAME = 'switchToParentFrame'
SWITCH_TO_WINDOW = 'switchToWindow'
TOUCH_DOWN = 'touchDown'
TOUCH_MOVE = 'touchMove'
TOUCH_SCROLL = 'touchScroll'
TOUCH_UP = 'touchUp'
UPLOAD_FILE = 'uploadFile'
W3C_ACCEPT_ALERT = 'w3cAcceptAlert'
W3C_ACTIONS = 'actions'
W3C_CLEAR_ACTIONS = 'clearActionState'
W3C_DISMISS_ALERT = 'w3cDismissAlert'
W3C_EXECUTE_SCRIPT = 'w3cExecuteScript'
W3C_EXECUTE_SCRIPT_ASYNC = 'w3cExecuteScriptAsync'
W3C_GET_ACTIVE_ELEMENT = 'w3cGetActiveElement'
W3C_GET_ALERT_TEXT = 'w3cGetAlertText'
W3C_GET_CURRENT_WINDOW_HANDLE = 'w3cGetCurrentWindowHandle'
W3C_GET_WINDOW_HANDLES = 'w3cGetWindowHandles'
W3C_GET_WINDOW_POSITION = 'w3cGetWindowPosition'
W3C_GET_WINDOW_SIZE = 'w3cGetWindowSize'
W3C_MAXIMIZE_WINDOW = 'w3cMaximizeWindow'
W3C_SET_ALERT_VALUE = 'w3cSetAlertValue'
W3C_SET_WINDOW_POSITION = 'w3cSetWindowPosition'
W3C_SET_WINDOW_SIZE = 'w3cSetWindowSize'
class selenium.webdriver.remote.errorhandler.ErrorHandler
Bases: object
Handles errors returned by the WebDriver server.
check_response(response)
Checks that a JSON response from the WebDriver does not have an error.
Args
• response - The JSON response from the WebDriver server as a dictionary object.
Raises If the response contains an error message.
class selenium.webdriver.remote.mobile.Mobile(driver)
Bases: object
class ConnectionType(mask)
Bases: object
__init__(mask)
Initialize self. See help(type(self)) for accurate signature.
airplane_mode
data
wifi
__init__(driver)
Initialize self. See help(type(self)) for accurate signature.
set_network_connection(network)
Set the network connection for the remote device.
Example of setting airplane mode:
driver.mobile.set_network_connection(driver.mobile.AIRPLANE_MODE)
class selenium.webdriver.remote.remote_connection.RemoteConnection(remote_server_addr,
keep_alive=False,
re-
solve_ip=True)
Bases: object
A connection with the Remote WebDriver server.
Communicates with the server using the WebDriver wire protocol: https://github.com/SeleniumHQ/selenium/
wiki/JsonWireProtocol
__init__(remote_server_addr, keep_alive=False, resolve_ip=True)
Initialize self. See help(type(self)) for accurate signature.
execute(command, params)
Send a command to the remote server.
Any path subtitutions required for the URL mapped to the command should be included in the command
parameters.
Args
• command - A string specifying the command to execute.
• params - A dictionary of named parameters to send with the command as its JSON pay-
load.
classmethod get_remote_connection_headers(parsed_url, keep_alive=False)
Get headers for remote request.
Args
• parsed_url - The parsed url
• keep_alive (Boolean) - Is this a keep-alive connection (default: False)
classmethod get_timeout()
Returns Timeout value in seconds for all http requests made to the Remote Connection
classmethod reset_timeout()
Reset the http request timeout to socket._GLOBAL_DEFAULT_TIMEOUT
classmethod set_timeout(timeout)
Override the default timeout
Args
• timeout - timeout value for http requests in seconds
selenium.webdriver.remote.utils.dump_json(json_struct)
selenium.webdriver.remote.utils.format_json(json_struct)
selenium.webdriver.remote.utils.load_json(s)
selenium.webdriver.remote.utils.unzip_to_temp_dir(zip_file_name)
Unzip zipfile to a temporary directory.
The directory of the unzipped files is returned if success, otherwise None is returned.
class selenium.webdriver.ie.webdriver.WebDriver(executable_path=’IEDriverServer.exe’,
capabilities=None, port=0, time-
out=30, host=None, log_level=None,
service_log_path=None, op-
tions=None, ie_options=None,
desired_capabilities=None,
log_file=None, keep_alive=False)
Bases: selenium.webdriver.remote.webdriver.WebDriver
Controls the IEServerDriver and allows you to drive Internet Explorer
__init__(executable_path=’IEDriverServer.exe’, capabilities=None, port=0, timeout=30,
host=None, log_level=None, service_log_path=None, options=None, ie_options=None,
desired_capabilities=None, log_file=None, keep_alive=False)
Creates a new instance of the chrome driver.
Starts the service and then creates new instance of chrome driver.
Args
• executable_path - path to the executable. If the default is used it assumes the executable is
in the $PATH
• capabilities: capabilities Dictionary object
• port - port you would like the service to run, if left as 0, a free port will be found.
• timeout - no longer used, kept for backward compatibility
• host - IP address for the service
• log_level - log level you would like the service to run.
• service_log_path - target of logging of service, may be “stdout”, “stderr” or file path.
• options - IE Options instance, providing additional IE options
• ie_options - Deprecated argument for options
• desired_capabilities - alias of capabilities; this will make the signature consistent with
RemoteWebDriver.
• log_file - Deprecated argument for service_log_path
• keep_alive - Whether to configure RemoteConnection to use HTTP keep-alive.
create_options()
quit()
Quits the driver and closes every associated window.
Usage driver.quit()
class selenium.webdriver.android.webdriver.WebDriver(host=’localhost’,
port=4444, de-
sired_capabilities={’browserName’:
’android’, ’platform’: ’AN-
DROID’, ’version’: ”})
Bases: selenium.webdriver.remote.webdriver.WebDriver
Simple RemoteWebDriver wrapper to start connect to Selendroid’s WebView app
For more info on getting started with Selendroid http://selendroid.io/mobileWeb.html
__init__(host=’localhost’, port=4444, desired_capabilities={’browserName’: ’android’, ’platform’:
’ANDROID’, ’version’: ”})
Creates a new instance of Selendroid using the WebView app
Args
• host - location of where selendroid is running
• port - port that selendroid is running on
• desired_capabilities: Dictionary object with capabilities
class selenium.webdriver.opera.webdriver.OperaDriver(executable_path=None,
port=0, options=None,
service_args=None, de-
sired_capabilities=None,
service_log_path=None,
opera_options=None,
keep_alive=True)
Bases: selenium.webdriver.chrome.webdriver.WebDriver
Controls the new OperaDriver and allows you to drive the Opera browser based on Chromium.
__init__(executable_path=None, port=0, options=None, service_args=None, de-
sired_capabilities=None, service_log_path=None, opera_options=None, keep_alive=True)
Creates a new instance of the operadriver.
Starts the service and then creates new instance of operadriver.
Args
• executable_path - path to the executable. If the default is used it assumes the exe-
cutable is in the $PATH
• port - port you would like the service to run, if left as 0, a free port will be found.
• options: this takes an instance of OperaOptions
• service_args - List of args to pass to the driver service
• desired_capabilities: Dictionary object with non-browser specific
• service_log_path - Where to log information from the driver.
• opera_options - Deprecated argument for options capabilities only, such as “proxy” or
“loggingPref”.
create_options()
class selenium.webdriver.opera.webdriver.WebDriver(desired_capabilities=None, ex-
ecutable_path=None, port=0,
service_log_path=None, ser-
vice_args=None, options=None)
Bases: selenium.webdriver.opera.webdriver.OperaDriver
class ServiceType
Bases: object
CHROMIUM = 2
__init__(desired_capabilities=None, executable_path=None, port=0, service_log_path=None, ser-
vice_args=None, options=None)
Creates a new instance of the operadriver.
Starts the service and then creates new instance of operadriver.
Args
• executable_path - path to the executable. If the default is used it assumes the exe-
cutable is in the $PATH
• port - port you would like the service to run, if left as 0, a free port will be found.
• options: this takes an instance of OperaOptions
• service_args - List of args to pass to the driver service
• desired_capabilities: Dictionary object with non-browser specific
• service_log_path - Where to log information from the driver.
• opera_options - Deprecated argument for options capabilities only, such as “proxy” or
“loggingPref”.
class selenium.webdriver.phantomjs.webdriver.WebDriver(executable_path=’phantomjs’,
port=0, de-
sired_capabilities={’browserName’:
’phantomjs’, ’javascriptEn-
abled’: True, ’platform’:
’ANY’, ’version’: ”},
service_args=None, ser-
vice_log_path=None)
Bases: selenium.webdriver.remote.webdriver.WebDriver
Wrapper to communicate with PhantomJS through Ghostdriver.
You will need to follow all the directions here: https://github.com/detro/ghostdriver
__init__(executable_path=’phantomjs’, port=0, desired_capabilities={’browserName’: ’phantomjs’,
’javascriptEnabled’: True, ’platform’: ’ANY’, ’version’: ”}, service_args=None, ser-
vice_log_path=None)
Creates a new instance of the PhantomJS / Ghostdriver.
Starts the service and then creates new instance of the driver.
Args
• executable_path - path to the executable. If the default is used it assumes the executable is
in the $PATH
• port - port you would like the service to run, if left as 0, a free port will be found.
• desired_capabilities: Dictionary object with non-browser specific capabilities only, such
as “proxy” or “loggingPref”.
• service_args : A List of command line arguments to pass to PhantomJS
• service_log_path: Path for phantomjs service to log to.
quit()
Closes the browser and shuts down the PhantomJS executable that is started when starting the PhantomJS
class selenium.webdriver.support.select.Select(webelement)
Bases: object
__init__(webelement)
Constructor. A check is made that the given element is, indeed, a SELECT tag. If it is not, then an
UnexpectedTagNameException is thrown.
Args
• webelement - element SELECT element to wrap
deselect_all()
Clear all selected entries. This is only valid when the SELECT supports multiple selections. throws
NotImplementedError If the SELECT does not support multiple selections
deselect_by_index(index)
Deselect the option at the given index. This is done by examing the “index” attribute of an element, and
not merely by counting.
Args
• index - The option at this index will be deselected
throws NoSuchElementException If there is no option with specisied index in SELECT
deselect_by_value(value)
Deselect all options that have a value matching the argument. That is, when given “foo” this would deselect
an option like:
<option value=”foo”>Bar</option>
Args
• value - The value to match against
throws NoSuchElementException If there is no option with specisied value in SELECT
deselect_by_visible_text(text)
Deselect all options that display text matching the argument. That is, when given “Bar” this would deselect
an option like:
<option value=”foo”>Bar</option>
Args
• text - The visible text to match against
select_by_index(index)
Select the option at the given index. This is done by examing the “index” attribute of an element, and not
merely by counting.
Args
• index - The option at this index will be selected
throws NoSuchElementException If there is no option with specisied index in SELECT
select_by_value(value)
Select all options that have a value matching the argument. That is, when given “foo” this would select an
option like:
<option value=”foo”>Bar</option>
Args
• value - The value to match against
throws NoSuchElementException If there is no option with specisied value in SELECT
select_by_visible_text(text)
Select all options that display text matching the argument. That is, when given “Bar” this would select an
option like:
<option value=”foo”>Bar</option>
Args
• text - The visible text to match against
throws NoSuchElementException If there is no option with specisied text in SELECT
all_selected_options
Returns a list of all selected options belonging to this select tag
first_selected_option
The first selected option in this select tag (or the currently selected option in a normal select)
options
Returns a list of all options belonging to this select tag
until(method, message=”)
Calls the method provided with the driver as an argument until the return value is not False.
until_not(method, message=”)
Calls the method provided with the driver as an argument until the return value is False.
print(Color.from_string('#00ff33').rgba)
print(Color.from_string('rgb(1, 255, 3)').hex)
print(Color.from_string('blue').rgba)
class selenium.webdriver.support.event_firing_webdriver.EventFiringWebDriver(driver,
event_listener)
Bases: object
A wrapper around an arbitrary WebDriver instance which supports firing events
__init__(driver, event_listener)
Creates a new instance of the EventFiringWebDriver
Args
• driver : A WebDriver instance
• event_listener : Instance of a class that subclasses AbstractEventListener and implements
it fully or partially
Example:
from selenium.webdriver import Firefox
from selenium.webdriver.support.events import EventFiringWebDriver,
˓→AbstractEventListener
class MyListener(AbstractEventListener):
def before_navigate_to(self, url, driver):
(continues on next page)
driver = Firefox()
ef_driver = EventFiringWebDriver(driver, MyListener())
ef_driver.get("http://www.google.co.in/")
back()
close()
execute_async_script(script, *args)
execute_script(script, *args)
find_element(by=’id’, value=None)
find_element_by_class_name(name)
find_element_by_css_selector(css_selector)
find_element_by_id(id_)
find_element_by_link_text(link_text)
find_element_by_name(name)
find_element_by_partial_link_text(link_text)
find_element_by_tag_name(name)
find_element_by_xpath(xpath)
find_elements(by=’id’, value=None)
find_elements_by_class_name(name)
find_elements_by_css_selector(css_selector)
find_elements_by_id(id_)
find_elements_by_link_text(text)
find_elements_by_name(name)
find_elements_by_partial_link_text(link_text)
find_elements_by_tag_name(name)
find_elements_by_xpath(xpath)
forward()
get(url)
quit()
wrapped_driver
Returns the WebDriver instance wrapped by this EventsFiringWebDriver
class selenium.webdriver.support.event_firing_webdriver.EventFiringWebElement(webelement,
ef_driver)
Bases: object
” A wrapper around WebElement instance which supports firing events
__init__(webelement, ef_driver)
Creates a new instance of the EventFiringWebElement
clear()
click()
find_element(by=’id’, value=None)
find_element_by_class_name(name)
find_element_by_css_selector(css_selector)
find_element_by_id(id_)
find_element_by_link_text(link_text)
find_element_by_name(name)
find_element_by_partial_link_text(link_text)
find_element_by_tag_name(name)
find_element_by_xpath(xpath)
find_elements(by=’id’, value=None)
find_elements_by_class_name(name)
find_elements_by_css_selector(css_selector)
find_elements_by_id(id_)
find_elements_by_link_text(link_text)
find_elements_by_name(name)
find_elements_by_partial_link_text(link_text)
find_elements_by_tag_name(name)
find_elements_by_xpath(xpath)
send_keys(*value)
wrapped_element
Returns the WebElement wrapped by this EventFiringWebElement instance
class selenium.webdriver.support.abstract_event_listener.AbstractEventListener
Bases: object
Event listener must subclass and implement this fully or partially
after_change_value_of(element, driver)
after_click(element, driver)
after_close(driver)
after_execute_script(script, driver)
after_find(by, value, driver)
after_navigate_back(driver)
after_navigate_forward(driver)
after_navigate_to(url, driver)
after_quit(driver)
before_change_value_of(element, driver)
before_click(element, driver)
before_close(driver)
before_execute_script(script, driver)
before_find(by, value, driver)
before_navigate_back(driver)
before_navigate_forward(driver)
before_navigate_to(url, driver)
before_quit(driver)
on_exception(exception, driver)
class selenium.webdriver.support.expected_conditions.alert_is_present
Bases: object
Expect an alert to be present.
__init__()
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.element_located_selection_state_to_be(
Bases: object
An expectation to locate an element and check if the selection state specified is in that state. locator is a tuple of
(by, path) is_selected is a boolean
__init__(locator, is_selected)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.element_located_to_be_selected(locator)
Bases: object
An expectation for the element to be located is selected. locator is a tuple of (by, path)
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.element_selection_state_to_be(element,
is_selected
Bases: object
An expectation for checking if the given element is selected. element is WebElement object is_selected is a
Boolean.”
__init__(element, is_selected)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.element_to_be_clickable(locator)
Bases: object
An Expectation for checking an element is visible and enabled such that you can click it.
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.element_to_be_selected(element)
Bases: object
An expectation for checking the selection is selected. element is WebElement object
__init__(element)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.frame_to_be_available_and_switch_to_it
Bases: object
An expectation for checking whether the given frame is available to switch to. If the frame is available it switches
the given driver to the specified frame.
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.invisibility_of_element(locator)
Bases: selenium.webdriver.support.expected_conditions.
invisibility_of_element_located
An Expectation for checking that an element is either invisible or not present on the DOM.
element is either a locator (text) or an WebElement
class selenium.webdriver.support.expected_conditions.invisibility_of_element_located(locator)
Bases: object
An Expectation for checking that an element is either invisible or not present on the DOM.
locator used to find the element
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.new_window_is_opened(current_handles)
Bases: object
An expectation that a new window will be opened and have the number of windows handles increase
__init__(current_handles)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.number_of_windows_to_be(num_windows)
Bases: object
An expectation for the number of windows to be a certain value.
__init__(num_windows)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.presence_of_all_elements_located(locator
Bases: object
An expectation for checking that there is at least one element present on a web page. locator is used to find the
element returns the list of WebElements once they are located
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.presence_of_element_located(locator)
Bases: object
An expectation for checking that an element is present on the DOM of a page. This does not necessarily mean
that the element is visible. locator - used to find the element returns the WebElement once it is located
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.staleness_of(element)
Bases: object
Wait until an element is no longer attached to the DOM. element is the element to wait for. returns False if the
element is still attached to the DOM, true otherwise.
__init__(element)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.text_to_be_present_in_element(locator,
text_)
Bases: object
An expectation for checking if the given text is present in the specified element. locator, text
__init__(locator, text_)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.text_to_be_present_in_element_value(loc
tex
Bases: object
An expectation for checking if the given text is present in the element’s locator, text
__init__(locator, text_)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.title_contains(title)
Bases: object
An expectation for checking that the title contains a case-sensitive substring. title is the fragment of title expected
returns True when the title matches, False otherwise
__init__(title)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.title_is(title)
Bases: object
An expectation for checking the title of a page. title is the expected title, which must be an exact match returns
True if the title matches, false otherwise.
__init__(title)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.url_changes(url)
Bases: object
An expectation for checking the current url. url is the expected url, which must not be an exact match returns
True if the url is different, false otherwise.
__init__(url)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.url_contains(url)
Bases: object
An expectation for checking that the current url contains a case-sensitive substring. url is the fragment of url
expected, returns True when the url matches, False otherwise
__init__(url)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.url_matches(pattern)
Bases: object
An expectation for checking the current url. pattern is the expected pattern, which must be an exact match
returns True if the url matches, false otherwise.
__init__(pattern)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.url_to_be(url)
Bases: object
An expectation for checking the current url. url is the expected url, which must be an exact match returns True
if the url matches, false otherwise.
__init__(url)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.visibility_of(element)
Bases: object
An expectation for checking that an element, known to be present on the DOM of a page, is visible. Visibility
means that the element is not only displayed but also has a height and width that is greater than 0. element is the
WebElement returns the (same) WebElement once it is visible
__init__(element)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.visibility_of_all_elements_located(loca
Bases: object
An expectation for checking that all elements are present on the DOM of a page and visible. Visibility means
that the elements are not only displayed but also has a height and width that is greater than 0. locator - used to
find the elements returns the list of WebElements once they are located and visible
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.visibility_of_any_elements_located(loca
Bases: object
An expectation for checking that there is at least one element visible on a web page. locator is used to find the
element returns the list of WebElements once they are located
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
class selenium.webdriver.support.expected_conditions.visibility_of_element_located(locator)
Bases: object
An expectation for checking that an element is present on the DOM of a page and visible. Visibility means that
the element is not only displayed but also has a height and width that is greater than 0. locator - used to find the
element returns the WebElement once it is located and visible
__init__(locator)
Initialize self. See help(type(self)) for accurate signature.
Download the latest chromedriver from download page. Unzip the file:
unzip chromedriver_linux32_x.x.x.x.zip
You should see a chromedriver executable. Now you can create an instance of Chrome WebDriver like this:
driver = webdriver.Chrome(executable_path="/path/to/chromedriver")
Ref: http://seleniumhq.org/docs/03_webdriver.html#how-xpath-works-in-webdriver
Selenium delegates XPath queries down to the browser’s own XPath engine, so Selenium support XPath supports
whatever the browser supports. In browsers which don’t have native XPath engines (IE 6,7,8), Selenium supports
XPath 1.0 only.
Ref: http://blog.varunin.com/2011/08/scrolling-on-pages-using-selenium.html
You can use the execute_script method to execute javascript on the loaded page. So, you can call the JavaScript API
to scroll to the bottom or any other position of a page.
95
Selenium Python Bindings, Release 2
The window object in DOM has a scrollTo method to scroll to any position of an opened window. The scrollHeight
is a common property for all elements. The document.body.scrollHeight will give the height of the entire body of the
page.
Ref: http://stackoverflow.com/questions/1176348/access-to-file-download-dialog-in-firefox
Ref: http://blog.codecentric.de/en/2010/07/file-downloads-with-selenium-mission-impossible/
The first step is to identify the type of file you want to auto save.
To identify the content type you want to download automatically, you can use curl:
curl -I URL | grep "Content-Type"
Another way to find content type is using the requests module, you can use it like this:
import requests
content_type = requests.head('http://www.python.org').headers['content-type']
print(content_type)
Once the content type is identified, you can use it to set the firefox profile preference: browser.helperApps.
neverAsk.saveToDisk
Here is an example:
import os
fp = webdriver.FirefoxProfile()
fp.set_preference("browser.download.folderList",2)
fp.set_preference("browser.download.manager.showWhenStarting",False)
fp.set_preference("browser.download.dir", os.getcwd())
fp.set_preference("browser.helperApps.neverAsk.saveToDisk", "application/octet-stream
˓→")
browser = webdriver.Firefox(firefox_profile=fp)
browser.get("http://pypi.python.org/pypi/selenium")
browser.find_element_by_partial_link_text("selenium-2").click()
Select the <input type="file"> element and call the send_keys() method passing the file path, either the
path relative to the test script, or an absolute path. Keep in mind the differences in path names between Windows and
Unix systems.
First download the Firebug XPI file, later you call the add_extension method available for the firefox profile:
fp = webdriver.FirefoxProfile()
fp.add_extension(extension='firebug-1.8.4.xpi')
fp.set_preference("extensions.firebug.currentVersion", "1.8.4") #Avoid startup screen
browser = webdriver.Firefox(firefox_profile=fp)
driver = webdriver.Firefox()
driver.get('http://www.python.org/')
driver.save_screenshot('screenshot.png')
driver.quit()
• genindex
• modindex
• search
99
Selenium Python Bindings, Release 2
s selenium.webdriver.remote.mobile, 78
selenium.common.exceptions, 32 selenium.webdriver.remote.remote_connection,
selenium.webdriver.android.webdriver, 79
81 selenium.webdriver.remote.utils, 79
selenium.webdriver.chrome.options, 55 selenium.webdriver.remote.webdriver, 57
selenium.webdriver.chrome.service, 56 selenium.webdriver.remote.webelement,
selenium.webdriver.chrome.webdriver, 54 66
selenium.webdriver.common.action_chains, selenium.webdriver.safari.service, 84
37 selenium.webdriver.safari.webdriver, 83
selenium.webdriver.common.alert, 40 selenium.webdriver.support.abstract_event_listener,
selenium.webdriver.common.by, 43 89
selenium.webdriver.support.color, 87
selenium.webdriver.common.desired_capabilities,
43 selenium.webdriver.support.event_firing_webdriver,
87
selenium.webdriver.common.html5.application_cache,
48 selenium.webdriver.support.expected_conditions,
selenium.webdriver.common.keys, 41 90
selenium.webdriver.common.proxy, 46 selenium.webdriver.support.select, 85
selenium.webdriver.common.service, 48 selenium.webdriver.support.wait, 86
selenium.webdriver.common.touch_actions,
44
selenium.webdriver.common.utils, 47
selenium.webdriver.firefox.extension_connection,
53
selenium.webdriver.firefox.firefox_binary,
53
selenium.webdriver.firefox.firefox_profile,
52
selenium.webdriver.firefox.options, 51
selenium.webdriver.firefox.webdriver,
49
selenium.webdriver.ie.webdriver, 80
selenium.webdriver.opera.webdriver, 81
selenium.webdriver.phantomjs.service,
83
selenium.webdriver.phantomjs.webdriver,
82
selenium.webdriver.remote.command, 73
selenium.webdriver.remote.errorhandler,
76
101
Selenium Python Bindings, Release 2
103
Selenium Python Bindings, Release 2
__init__() (selenium.webdriver.support.expected_conditions.element_to_be_selected
accept_insecure_certs (sele-
method), 91 nium.webdriver.firefox.options.Options at-
__init__() (selenium.webdriver.support.expected_conditions.frame_to_be_available_and_switch_to_it
tribute), 51
method), 91 accept_untrusted_certs (sele-
__init__() (selenium.webdriver.support.expected_conditions.invisibility_of_element_located
nium.webdriver.firefox.firefox_profile.FirefoxProfile
method), 91 attribute), 52
__init__() (selenium.webdriver.support.expected_conditions.new_window_is_opened
ActionChains (class in sele-
method), 91 nium.webdriver.common.action_chains),
__init__() (selenium.webdriver.support.expected_conditions.number_of_windows_to_be
37
method), 91 ADD (selenium.webdriver.common.keys.Keys attribute),
__init__() (selenium.webdriver.support.expected_conditions.presence_of_all_elements_located
41
method), 91 add_argument() (sele-
__init__() (selenium.webdriver.support.expected_conditions.presence_of_element_located
nium.webdriver.chrome.options.Options
method), 92 method), 55
__init__() (selenium.webdriver.support.expected_conditions.staleness_of
add_argument() (sele-
method), 92 nium.webdriver.firefox.options.Options
__init__() (selenium.webdriver.support.expected_conditions.text_to_be_present_in_element
method), 51
method), 92 add_command_line_options() (sele-
__init__() (selenium.webdriver.support.expected_conditions.text_to_be_present_in_element_value
nium.webdriver.firefox.firefox_binary.FirefoxBinary
method), 92 method), 53
__init__() (selenium.webdriver.support.expected_conditions.title_contains
ADD_COOKIE (selenium.webdriver.remote.command.Command
method), 92 attribute), 73
__init__() (selenium.webdriver.support.expected_conditions.title_is
add_cookie() (sele-
method), 92 nium.webdriver.remote.webdriver.WebDriver
__init__() (selenium.webdriver.support.expected_conditions.url_changes
method), 57
method), 92 add_encoded_extension() (sele-
__init__() (selenium.webdriver.support.expected_conditions.url_contains
nium.webdriver.chrome.options.Options
method), 93 method), 55
__init__() (selenium.webdriver.support.expected_conditions.url_matches
add_experimental_option() (sele-
method), 93 nium.webdriver.chrome.options.Options
__init__() (selenium.webdriver.support.expected_conditions.url_to_be
method), 55
method), 93 add_extension() (sele-
__init__() (selenium.webdriver.support.expected_conditions.visibility_of
nium.webdriver.chrome.options.Options
method), 93 method), 55
__init__() (selenium.webdriver.support.expected_conditions.visibility_of_all_elements_located
add_extension() (sele-
method), 93 nium.webdriver.firefox.firefox_profile.FirefoxProfile
__init__() (selenium.webdriver.support.expected_conditions.visibility_of_any_elements_located
method), 52
method), 93 add_to_capabilities() (sele-
__init__() (selenium.webdriver.support.expected_conditions.visibility_of_element_located
nium.webdriver.common.proxy.Proxy method),
method), 93 46
__init__() (selenium.webdriver.support.select.Select AddonFormatError, 52
method), 85 after_change_value_of() (sele-
__init__() (selenium.webdriver.support.wait.WebDriverWait nium.webdriver.support.abstract_event_listener.AbstractEventList
method), 86 method), 89
after_click() (sele-
A nium.webdriver.support.abstract_event_listener.AbstractEventList
AbstractEventListener (class in sele- method), 89
nium.webdriver.support.abstract_event_listener), after_close() (sele-
89 nium.webdriver.support.abstract_event_listener.AbstractEventList
accept() (selenium.webdriver.common.alert.Alert method), 89
method), 40 after_execute_script() (sele-
ACCEPT_ALERT (sele- nium.webdriver.support.abstract_event_listener.AbstractEventList
nium.webdriver.remote.command.Command method), 89
attribute), 73 after_find() (sele-
104 Index
Selenium Python Bindings, Release 2
nium.webdriver.support.abstract_event_listener.AbstractEventListener
assert_process_still_running() (sele-
method), 89 nium.webdriver.common.service.Service
after_navigate_back() (sele- method), 48
nium.webdriver.support.abstract_event_listener.AbstractEventListener
assume_untrusted_cert_issuer (sele-
method), 89 nium.webdriver.firefox.firefox_profile.FirefoxProfile
after_navigate_forward() (sele- attribute), 52
auto_detect (selenium.webdriver.common.proxy.Proxy
nium.webdriver.support.abstract_event_listener.AbstractEventListener
method), 89 attribute), 46
after_navigate_to() (sele- autodetect (selenium.webdriver.common.proxy.Proxy
attribute), 46
nium.webdriver.support.abstract_event_listener.AbstractEventListener
method), 90 AUTODETECT (selenium.webdriver.common.proxy.ProxyType
after_quit() (sele- attribute), 47
nium.webdriver.support.abstract_event_listener.AbstractEventListener
method), 90 B
AIRPLANE_MODE (sele- back() (selenium.webdriver.remote.webdriver.WebDriver
nium.webdriver.remote.mobile.Mobile at- method), 58
tribute), 78 back() (selenium.webdriver.support.event_firing_webdriver.EventFiringW
airplane_mode (sele- method), 88
nium.webdriver.remote.mobile.Mobile.ConnectionType BACK_SPACE (selenium.webdriver.common.keys.Keys
attribute), 78 attribute), 41
Alert (class in selenium.webdriver.common.alert), 40 BACKSPACE (selenium.webdriver.common.keys.Keys at-
alert_is_present (class in sele- tribute), 41
nium.webdriver.support.expected_conditions), before_change_value_of() (sele-
90 nium.webdriver.support.abstract_event_listener.AbstractEventList
ALL_NETWORK (selenium.webdriver.remote.mobile.Mobile method), 90
attribute), 78 before_click() (sele-
all_selected_options (sele- nium.webdriver.support.abstract_event_listener.AbstractEventList
nium.webdriver.support.select.Select attribute), method), 90
86 before_close() (sele-
ALT (selenium.webdriver.common.keys.Keys attribute), nium.webdriver.support.abstract_event_listener.AbstractEventList
41 method), 90
ANDROID (selenium.webdriver.common.desired_capabilities.DesiredCapabilities
before_execute_script() (sele-
attribute), 43 nium.webdriver.support.abstract_event_listener.AbstractEventList
ANONYMOUS_PROFILE_NAME (sele- method), 90
nium.webdriver.firefox.firefox_profile.FirefoxProfile
before_find() (sele-
attribute), 52 nium.webdriver.support.abstract_event_listener.AbstractEventList
application_cache (sele- method), 90
nium.webdriver.remote.webdriver.WebDriver before_navigate_back() (sele-
attribute), 65 nium.webdriver.support.abstract_event_listener.AbstractEventList
ApplicationCache (class in sele- method), 90
nium.webdriver.common.html5.application_cache), before_navigate_forward() (sele-
48 nium.webdriver.support.abstract_event_listener.AbstractEventList
arguments (selenium.webdriver.chrome.options.Options method), 90
attribute), 56 before_navigate_to() (sele-
arguments (selenium.webdriver.firefox.options.Options nium.webdriver.support.abstract_event_listener.AbstractEventList
attribute), 51 method), 90
ARROW_DOWN (selenium.webdriver.common.keys.Keys before_quit() (sele-
attribute), 41 nium.webdriver.support.abstract_event_listener.AbstractEventList
ARROW_LEFT (selenium.webdriver.common.keys.Keys method), 90
attribute), 41 binary (selenium.webdriver.firefox.options.Options at-
ARROW_RIGHT (selenium.webdriver.common.keys.Keys tribute), 51
attribute), 41 binary_location (sele-
ARROW_UP (selenium.webdriver.common.keys.Keys at- nium.webdriver.chrome.options.Options at-
tribute), 41 tribute), 56
Index 105
Selenium Python Bindings, Release 2
106 Index
Selenium Python Bindings, Release 2
Index 107
Selenium Python Bindings, Release 2
108 Index
Selenium Python Bindings, Release 2
Index 109
Selenium Python Bindings, Release 2
method), 68 method), 88
find_element_by_tag_name() (sele- find_elements_by_css_selector() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebDriver
nium.webdriver.support.event_firing_webdriver.EventFiringWebE
method), 88 method), 89
find_element_by_tag_name() (sele- find_elements_by_id() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebElement
nium.webdriver.remote.webdriver.WebDriver
method), 89 method), 61
find_element_by_xpath() (sele- find_elements_by_id() (sele-
nium.webdriver.remote.webdriver.WebDriver nium.webdriver.remote.webelement.WebElement
method), 60 method), 69
find_element_by_xpath() (sele- find_elements_by_id() (sele-
nium.webdriver.remote.webelement.WebElement nium.webdriver.support.event_firing_webdriver.EventFiringWebD
method), 68 method), 88
find_element_by_xpath() (sele- find_elements_by_id() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebDriver
nium.webdriver.support.event_firing_webdriver.EventFiringWebE
method), 88 method), 89
find_element_by_xpath() (sele- find_elements_by_link_text() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebElement
nium.webdriver.remote.webdriver.WebDriver
method), 89 method), 61
FIND_ELEMENTS (sele- find_elements_by_link_text() (sele-
nium.webdriver.remote.command.Command nium.webdriver.remote.webelement.WebElement
attribute), 74 method), 70
find_elements() (sele- find_elements_by_link_text() (sele-
nium.webdriver.remote.webdriver.WebDriver nium.webdriver.support.event_firing_webdriver.EventFiringWebD
method), 61 method), 88
find_elements() (sele- find_elements_by_link_text() (sele-
nium.webdriver.remote.webelement.WebElement nium.webdriver.support.event_firing_webdriver.EventFiringWebE
method), 69 method), 89
find_elements() (sele- find_elements_by_name() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebDriver
nium.webdriver.remote.webdriver.WebDriver
method), 88 method), 62
find_elements() (sele- find_elements_by_name() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebElement
nium.webdriver.remote.webelement.WebElement
method), 89 method), 70
find_elements_by_class_name() (sele- find_elements_by_name() (sele-
nium.webdriver.remote.webdriver.WebDriver nium.webdriver.support.event_firing_webdriver.EventFiringWebD
method), 61 method), 88
find_elements_by_class_name() (sele- find_elements_by_name() (sele-
nium.webdriver.remote.webelement.WebElement nium.webdriver.support.event_firing_webdriver.EventFiringWebE
method), 69 method), 89
find_elements_by_class_name() (sele- find_elements_by_partial_link_text()
(selenium.webdriver.remote.webdriver.WebDriver
nium.webdriver.support.event_firing_webdriver.EventFiringWebDriver
method), 88 method), 62
find_elements_by_class_name() (sele- find_elements_by_partial_link_text()
(selenium.webdriver.remote.webelement.WebElement
nium.webdriver.support.event_firing_webdriver.EventFiringWebElement
method), 89 method), 70
find_elements_by_css_selector() (sele- find_elements_by_partial_link_text()
nium.webdriver.remote.webdriver.WebDriver (selenium.webdriver.support.event_firing_webdriver.EventFiringW
method), 61 method), 88
find_elements_by_css_selector() (sele- find_elements_by_partial_link_text()
nium.webdriver.remote.webelement.WebElement (selenium.webdriver.support.event_firing_webdriver.EventFiringW
method), 69 method), 89
find_elements_by_css_selector() (sele- find_elements_by_tag_name() (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebDriver
nium.webdriver.remote.webdriver.WebDriver
110 Index
Selenium Python Bindings, Release 2
Index 111
Selenium Python Bindings, Release 2
attribute), 74 nium.webdriver.remote.command.Command
GET_CURRENT_WINDOW_HANDLE (sele- attribute), 74
nium.webdriver.remote.command.Command GET_PAGE_SOURCE (sele-
attribute), 74 nium.webdriver.remote.command.Command
GET_ELEMENT_ATTRIBUTE (sele- attribute), 74
nium.webdriver.remote.command.Command get_permission() (sele-
attribute), 74 nium.webdriver.safari.webdriver.WebDriver
GET_ELEMENT_LOCATION (sele- method), 84
nium.webdriver.remote.command.Command get_property() (sele-
attribute), 74 nium.webdriver.remote.webelement.WebElement
GET_ELEMENT_LOCATION_ONCE_SCROLLED_INTO_VIEW method), 71
(selenium.webdriver.remote.command.Command get_remote_connection_headers() (sele-
attribute), 74 nium.webdriver.remote.remote_connection.RemoteConnection
GET_ELEMENT_PROPERTY (sele- class method), 79
nium.webdriver.remote.command.Command GET_SCREEN_ORIENTATION (sele-
attribute), 74 nium.webdriver.remote.command.Command
GET_ELEMENT_RECT (sele- attribute), 74
nium.webdriver.remote.command.Command get_screenshot_as_base64() (sele-
attribute), 74 nium.webdriver.remote.webdriver.WebDriver
GET_ELEMENT_SIZE (sele- method), 63
nium.webdriver.remote.command.Command get_screenshot_as_file() (sele-
attribute), 74 nium.webdriver.remote.webdriver.WebDriver
GET_ELEMENT_TAG_NAME (sele- method), 63
nium.webdriver.remote.command.Command get_screenshot_as_png() (sele-
attribute), 74 nium.webdriver.remote.webdriver.WebDriver
GET_ELEMENT_TEXT (sele- method), 63
nium.webdriver.remote.command.Command GET_SESSION_STORAGE_ITEM (sele-
attribute), 74 nium.webdriver.remote.command.Command
GET_ELEMENT_VALUE (sele- attribute), 74
nium.webdriver.remote.command.Command GET_SESSION_STORAGE_KEYS (sele-
attribute), 74 nium.webdriver.remote.command.Command
GET_ELEMENT_VALUE_OF_CSS_PROPERTY (sele- attribute), 74
nium.webdriver.remote.command.Command GET_SESSION_STORAGE_SIZE (sele-
attribute), 74 nium.webdriver.remote.command.Command
GET_LOCAL_STORAGE_ITEM (sele- attribute), 74
nium.webdriver.remote.command.Command get_timeout() (sele-
attribute), 74 nium.webdriver.remote.remote_connection.RemoteConnection
GET_LOCAL_STORAGE_KEYS (sele- class method), 79
nium.webdriver.remote.command.Command GET_TITLE (selenium.webdriver.remote.command.Command
attribute), 74 attribute), 74
GET_LOCAL_STORAGE_SIZE (sele- GET_WINDOW_HANDLES (sele-
nium.webdriver.remote.command.Command nium.webdriver.remote.command.Command
attribute), 74 attribute), 75
GET_LOCATION (sele- GET_WINDOW_POSITION (sele-
nium.webdriver.remote.command.Command nium.webdriver.remote.command.Command
attribute), 74 attribute), 75
GET_LOG (selenium.webdriver.remote.command.Command get_window_position() (sele-
attribute), 74 nium.webdriver.remote.webdriver.WebDriver
get_log() (selenium.webdriver.remote.webdriver.WebDriver method), 63
method), 63 GET_WINDOW_RECT (sele-
get_network_conditions() (sele- nium.webdriver.remote.command.Command
nium.webdriver.chrome.webdriver.WebDriver attribute), 75
method), 55 get_window_rect() (sele-
GET_NETWORK_CONNECTION (sele- nium.webdriver.remote.webdriver.WebDriver
112 Index
Selenium Python Bindings, Release 2
Index 113
Selenium Python Bindings, Release 2
attribute), 44 L
IPHONE (selenium.webdriver.common.desired_capabilities.DesiredCapabilities
launch_app() (sele-
attribute), 44 nium.webdriver.chrome.webdriver.WebDriver
is_connectable() (in module sele- method), 55
nium.webdriver.common.utils), 47 launch_browser() (sele-
is_connectable() (sele- nium.webdriver.firefox.firefox_binary.FirefoxBinary
nium.webdriver.common.service.Service method), 53
method), 48 LEFT (selenium.webdriver.common.keys.Keys attribute),
is_connectable() (sele- 42
nium.webdriver.firefox.extension_connection.ExtensionConnection
LEFT_ALT (selenium.webdriver.common.keys.Keys at-
class method), 53 tribute), 42
is_displayed() (sele- LEFT_CONTROL (sele-
nium.webdriver.remote.webelement.WebElement nium.webdriver.common.keys.Keys attribute),
method), 71 42
IS_ELEMENT_DISPLAYED (sele- LEFT_SHIFT (selenium.webdriver.common.keys.Keys
nium.webdriver.remote.command.Command attribute), 42
attribute), 75 LINK_TEXT (selenium.webdriver.common.by.By at-
IS_ELEMENT_ENABLED (sele- tribute), 43
nium.webdriver.remote.command.Command load() (selenium.webdriver.common.proxy.ProxyType
attribute), 75 class method), 47
IS_ELEMENT_SELECTED (sele- load_json() (in module sele-
nium.webdriver.remote.command.Command nium.webdriver.remote.utils), 79
attribute), 75 location (selenium.webdriver.remote.webelement.WebElement
is_enabled() (sele- attribute), 72
nium.webdriver.remote.webelement.WebElement location_once_scrolled_into_view (sele-
method), 71 nium.webdriver.remote.webelement.WebElement
is_selected() (sele- attribute), 72
nium.webdriver.remote.webelement.WebElement Log (class in selenium.webdriver.firefox.options), 51
method), 71 log_types (selenium.webdriver.remote.webdriver.WebDriver
is_url_connectable() (in module sele- attribute), 66
nium.webdriver.common.utils), 48 LONG_PRESS (selenium.webdriver.remote.command.Command
attribute), 75
J long_press() (sele-
JAVASCRIPT_ERROR (sele- nium.webdriver.common.touch_actions.TouchActions
nium.webdriver.remote.errorhandler.ErrorCode method), 45
attribute), 77
JavascriptException, 34 M
join_host_port() (in module sele- make() (selenium.webdriver.common.proxy.ProxyTypeFactory
nium.webdriver.common.utils), 48 static method), 47
MANUAL (selenium.webdriver.common.proxy.ProxyType
K attribute), 47
KEY (selenium.webdriver.chrome.options.Options at- MAXIMIZE_WINDOW (sele-
tribute), 56 nium.webdriver.remote.command.Command
KEY (selenium.webdriver.firefox.options.Options at- attribute), 75
tribute), 51 maximize_window() (sele-
key_down() (selenium.webdriver.common.action_chains.ActionChains nium.webdriver.remote.webdriver.WebDriver
method), 38 method), 64
key_up() (selenium.webdriver.common.action_chains.ActionChains
META (selenium.webdriver.common.keys.Keys attribute),
method), 39 42
Keys (class in selenium.webdriver.common.keys), 41 METHOD_NOT_ALLOWED (sele-
keys_to_typing() (in module sele- nium.webdriver.remote.errorhandler.ErrorCode
nium.webdriver.common.utils), 48 attribute), 77
kill() (selenium.webdriver.firefox.firefox_binary.FirefoxBinary
MINIMIZE_WINDOW (sele-
method), 53 nium.webdriver.remote.command.Command
114 Index
Selenium Python Bindings, Release 2
Index 115
Selenium Python Bindings, Release 2
116 Index
Selenium Python Bindings, Release 2
Index 117
Selenium Python Bindings, Release 2
selenium.webdriver.remote.errorhandler tribute), 42
(module), 76 Service (class in selenium.webdriver.chrome.service),
selenium.webdriver.remote.mobile (mod- 56
ule), 78 Service (class in selenium.webdriver.common.service),
selenium.webdriver.remote.remote_connection 48
(module), 79 Service (class in sele-
selenium.webdriver.remote.utils (module), nium.webdriver.phantomjs.service), 83
79 Service (class in selenium.webdriver.safari.service),
selenium.webdriver.remote.webdriver 84
(module), 57 service_url (selenium.webdriver.common.service.Service
selenium.webdriver.remote.webelement attribute), 48
(module), 66 service_url (selenium.webdriver.phantomjs.service.Service
selenium.webdriver.safari.service (mod- attribute), 83
ule), 84 service_url (selenium.webdriver.safari.service.Service
selenium.webdriver.safari.webdriver attribute), 84
(module), 83 SESSION_NOT_CREATED (sele-
selenium.webdriver.support.abstract_event_listener nium.webdriver.remote.errorhandler.ErrorCode
(module), 89 attribute), 77
selenium.webdriver.support.color (mod- SessionNotCreatedException, 36
ule), 87 SET_ALERT_CREDENTIALS (sele-
selenium.webdriver.support.event_firing_webdriver nium.webdriver.remote.command.Command
(module), 87 attribute), 75
selenium.webdriver.support.expected_conditions SET_ALERT_VALUE (sele-
(module), 90 nium.webdriver.remote.command.Command
selenium.webdriver.support.select (mod- attribute), 75
ule), 85 set_capability() (sele-
selenium.webdriver.support.wait (module), nium.webdriver.chrome.options.Options
86 method), 56
SEMICOLON (selenium.webdriver.common.keys.Keys at- set_capability() (sele-
tribute), 42 nium.webdriver.firefox.options.Options
send_keys() (selenium.webdriver.common.action_chains.ActionChains
method), 51
method), 39 set_context() (sele-
send_keys() (selenium.webdriver.common.alert.Alert nium.webdriver.firefox.webdriver.WebDriver
method), 40 method), 50
send_keys() (selenium.webdriver.remote.webelement.WebElement
SET_ELEMENT_SELECTED (sele-
method), 72 nium.webdriver.remote.command.Command
send_keys() (selenium.webdriver.support.event_firing_webdriver.EventFiringWebElement
attribute), 75
method), 89 set_headless() (sele-
SEND_KEYS_TO_ACTIVE_ELEMENT (sele- nium.webdriver.chrome.options.Options
nium.webdriver.remote.command.Command method), 56
attribute), 75 set_headless() (sele-
SEND_KEYS_TO_ELEMENT (sele- nium.webdriver.firefox.options.Options
nium.webdriver.remote.command.Command method), 51
attribute), 75 SET_LOCAL_STORAGE_ITEM (sele-
send_keys_to_element() (sele- nium.webdriver.remote.command.Command
nium.webdriver.common.action_chains.ActionChains attribute), 75
method), 40 SET_LOCATION (sele-
send_remote_shutdown_command() (sele- nium.webdriver.remote.command.Command
nium.webdriver.common.service.Service attribute), 75
method), 48 set_network_conditions() (sele-
send_remote_shutdown_command() (sele- nium.webdriver.chrome.webdriver.WebDriver
nium.webdriver.phantomjs.service.Service method), 55
method), 83 SET_NETWORK_CONNECTION (sele-
SEPARATOR (selenium.webdriver.common.keys.Keys at- nium.webdriver.remote.command.Command
118 Index
Selenium Python Bindings, Release 2
Index 119
Selenium Python Bindings, Release 2
120 Index
Selenium Python Bindings, Release 2
Index 121
Selenium Python Bindings, Release 2
nium.webdriver.remote.command.Command
attribute), 76
W3C_SET_WINDOW_SIZE (sele-
nium.webdriver.remote.command.Command
attribute), 76
WebDriver (class in sele-
nium.webdriver.android.webdriver), 81
WebDriver (class in sele-
nium.webdriver.chrome.webdriver), 54
WebDriver (class in sele-
nium.webdriver.firefox.webdriver), 49
WebDriver (class in selenium.webdriver.ie.webdriver),
80
WebDriver (class in sele-
nium.webdriver.opera.webdriver), 82
WebDriver (class in sele-
nium.webdriver.phantomjs.webdriver), 82
WebDriver (class in sele-
nium.webdriver.remote.webdriver), 57
WebDriver (class in sele-
nium.webdriver.safari.webdriver), 83
WebDriver.ServiceType (class in sele-
nium.webdriver.opera.webdriver), 82
WebDriverException, 37
WebDriverWait (class in sele-
nium.webdriver.support.wait), 86
WebElement (class in sele-
nium.webdriver.remote.webelement), 66
WEBKITGTK (selenium.webdriver.common.desired_capabilities.DesiredCapabilities
attribute), 44
which() (selenium.webdriver.firefox.firefox_binary.FirefoxBinary
method), 53
wifi (selenium.webdriver.remote.mobile.Mobile.ConnectionType
attribute), 78
WIFI_NETWORK (sele-
nium.webdriver.remote.mobile.Mobile at-
tribute), 78
window_handles (sele-
nium.webdriver.remote.webdriver.WebDriver
attribute), 66
wrapped_driver (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebDriver
attribute), 88
wrapped_element (sele-
nium.webdriver.support.event_firing_webdriver.EventFiringWebElement
attribute), 89
X
XPATH (selenium.webdriver.common.by.By attribute), 43
XPATH_LOOKUP_ERROR (sele-
nium.webdriver.remote.errorhandler.ErrorCode
attribute), 77
122 Index