What is web scraping?
What is selenium?
According to selenium official web page, it is a suite of tools for automating web browsers. This project is a member of the Software Freedom Conservancy, Selenium has three projects, each provides a different functionality if you are interested in it, visit their official website. The scope of this blog will be attached to the Selenium WebDriver project
When should you use selenium?
Selenium is going to facilitate us with tools to perform web scraping, but when should it be used? You generally can use selenium in the following scenarios:
- When the data is loaded dynamically – for example Twitter. What you see in “view source” is different to what you see on the page (The reason is that “view source” just shows the static HTML files. If you want to see under the covers of a dynamic website, right click and “inspect element” instead)
So why not use selenium all the time? It is a bit slower then using requests and urllib. The reason is that selenium simulates running a full browser including the overhead that a brings with it. There are also a few extra steps required to use selenium as you can see below.
Once you have the data extracted, you can still use similar approaches to process the data (e.g. using tools such as BeautifulSoup)
Pre-requisites for using selenium
Step 1: Install selenium library
Before starting with a web scraping sample ensure that all requirements have been set, Selenium requires pip or pip3 installed, if you don’t have it installed you can follow the official guide to install it based on the operating system you have.
Once pip is installed you can proceed with the installation of selenium, with the following command
pip install selenium
Alternatively, you can download the PyPI source archive (selenium-x.x.x.tar.gz) and install it using setup.py:
python setup.py install
Step 2: Install web driver
Selenium simulates an actual browser. It won’t use your chrome installation but it will use a “driver” which is the browser engine to run a browser. Selenium supports multiple web browsers, so you may chose which web browser to use (read on)
Selenium WebDriver refers to both the language bindings and the implementations of the individual browser controlling code. This is commonly referred to as just a web driver.
Web driver needs to be downloaded, and then it could be either added to the path environment variable or initialized with a string containing the path where downloaded web driver is. Environment variables are out of the scope of the blog so we are going to use the second option.
From here to the end Firefox web driver is going to be used, but here is a table containing information regarding each web driver, you are able to choose any of them, Firefox is recommended to follow this blog
|Browser||Supported OS||Maintained by||Download||Issue Tracker|
|Internet Explorer||Windows||Selenium Project||Downloads||Issues|
|Safari||macOS El Capitan and newer||Apple||Built-in||Issues|
Download the driver to a common folder which is accessible. Your script will refer to this driver.
You can follow our guide on how to install the web driver here.
A Simple Selenium Example in Python
Ok, we’re all set. To begin with, let’s start with a quick staring example to ensure things are all working. Our first example will involving collecting a website title. In order to achieve this goal, we are going to use selenium, assuming it is already installed in your environment, just import
webdriver from selenium in a python file as it’s shown in the following.
# scraper.py # importing selenium into code from selenium import webdriver # this constant should be modified according to where the web driver has been placed WEBDRIVER_PATH = './' # initialize the firefox web driver driver = webdriver.Firefox(WEBDRIVER_PATH) # define URL URL = 'https://www.google.com' driver.get(URL) print (driver.title)
Running the code below will open a firefox window which looks a little bit different as can be seen in the following image and at the then it prints into the console the title of the website, in this case, it is collecting data from ‘Google’. Results should be similar to the following images:
Note that this was run in foreground so that you can see what is happening. Now we are going to manually close the firefox window opened, it was intentionally opened in this way to be able to see that the web driver actually navigates just like a human will do. But now that it is known, we can add at the end of the out this code:
driver.quit() so the window will automatically be closed after the job is done. Code now will look like this.
# scraper.py from selenium import webdriver WEBDRIVER_PATH = './' driver = webdriver.Firefox(WEBDRIVER_PATH) URL = 'https://www.google.com' driver.get(URL) print (driver.title) driver.quit()
Now the sample will open the Firefox web driver do its jobs and then close the windows. With this little and simple example, we are ready to go dipper and learn with a complex sample
How To Run Selenium in background
In case you are running your environment in console only or through putty or other terminal, you may not have access to the GUI. Also, in an automated environment, you will certainly want to run selenium without the browser popping up – e.g. in silent or headless mode. This is where you can add the following code at the start “options” and “–headless”.
# import web driver's Options from selenium.webdriver.firefox.options import Options # initialize the options firefox_options = Options() # add the argument headless firefox_options.add_argument('--headless') # creates the driver setting the options defined before WEBDRIVER_PATH = './' driver = webdriver.Firefox(WEBDRIVER_PATH,options=firefox_options)
The remaining examples will be run in ‘online’ mode so that you can see what is happening, but you can add the above snippet to help.
Example of Scraping a Dynamic Website in Python With Selenium
Until here, we have figure out how to scrap data from a static website, with a little bit of time, and patience you are now able to collect data from static websites. Let’s now dive a little bit more into the topic and build a script to extract data from a webpage which is dynamically loaded.
Imagine that you were requested to collect a list of YouTube videos regarding “Selenium”. With that information, we know that we are going to gather data from YouTube, that we need the searching result of “Selenium”, but this result will be dynamic and will change all the time.
The first approach is to replicate what we have done with Google, but now with YouTube, so a new file needs to be created
# yt-scraper.py from selenium import webdriver WEBDRIVER_PATH = './' driver = webdriver.Firefox(WEBDRIVER_PATH) URL = 'https://www.youtube.com' driver.get(URL) print (driver.title) driver.quit()
Now we are retrieving data YouTube title printed, but we are about to add some magic to the code. Our next step is to edit the search box and fill it with the word that we are looking for “Selenium” by simulating a person typing this into the search. This is done by using the Keys class:
from selenium.webdriver.common.keys import Keys.
driver.quit() line is going to be commented temporally so we are able to see what we are performing
# yt-scraper.py from selenium import webdriver from selenium.webdriver.common.keys import Keys WEBDRIVER_PATH = './' # initialize the firefox web driver driver = webdriver.Firefox(WEBDRIVER_PATH) URL = 'https://www.youtube.com' driver.get(URL) print (driver.title) # create a object which contains the searchbox with xpath search_box = driver.find_element_by_xpath('//input[@id="search"]') # edit the content of the seatch box, filling it with "Selenium" search_box.send_keys('Selenium') # once searchbox is with content we can press "press enter" to active the search search_box.send_keys(Keys.ENTER) #driver.quit()
The Youtube page shows a list of videos from the search as expected!
As you might notice, a new function has been called, named find_element_by_xpath, which could be kind of confusing at the moment as it uses strange xpath text. Let’s learn a little bit about XPath to understand a bit more.
What is XPath?
XPath is an XML path used for navigation through the HTML structure of the page. It is a syntax for finding any element on a web page using XML path expression. XPath can be used for both HTML and XML documents to find the location of any element on a webpage using HTML DOM structure.
The above diagram shows how it can be used to find an element. In the above example we had ‘//input[@id=”search”]. This finds all <input> elements which have an attributed called “id” where the value is “search”. See the image below – under the “inspect element” for the search box from youTube, you can seen there’s a tag <input id=”search” … >. That’s exactly the element we’re searching for with XPath
There are a great variety of ways to find elements within a website, here is the full list which is recommended to read if you want to master the web scraping technique.
Looping Through Elements with Selenium
Now that Xpath has been explained, we are able to the next step, listing videos. Until now we have a code that is able to open https://youtube.com, type in the search box the word “Selenium” and hit Enter key so the search is performed by youtube engine, resulting in a bunch of videos related to Selenium, so let’s now list them.
Firstly, right click and “inspect element” on the video section and find the element which is the start of the video section. You can see in the image below that it’s a <div> tag with “id=’dismissable'”
We want to grab the title, so within the video, find the tag that covers the title. Again, right click on the title and “inspect element” – here you can see the element “id=’video-title'”. Within this tag, you can see the text of the title.
One last thing, let’s remind that we are working with internet and web browsing, so sometimes is needed to wait for the data to be able, in this case, we are going to wait 5 seconds after the search is performed and then retrieve the data we are looking information. Keep in mind that the results could vary due to internet speed, and device performance.
# yt-scraper.py from selenium import webdriver from selenium.webdriver.common.keys import Keys import time WEBDRIVER_PATH = './' driver = webdriver.Firefox(WEBDRIVER_PATH) URL = 'https://www.youtube.com' driver.get(URL) print (driver.title) search_box = driver.find_element_by_xpath('//input[@id="search"]') search_box.send_keys('Selenium') search_box.send_keys(Keys.ENTER) # waiting data to be loaded time.sleep(5) # collect an HTML Tag which contains all videos videos = driver.find_elements_by_xpath('//*[@id="dismissable"]') # print how many videos were collected print (len(videos)) # iterate through all videos for video in videos: # collect each video title #please note that the find_element_by_xpath under the video variable title = video.find_element_by_xpath('.//*[@id="video-title"]') #print the title collected print (title.text) # close the webdriver driver.quit()
Once the code is executed you are going to see a list printed containing videos collected from YouTube as shown in the following image, which firstly prints the website title, then it tells us how many videos were collected and finally, it lists those videos.
Waiting for 5 seconds works, but then you have to adjust for each internet speed. There’s another mechanism you can use which is to wait for the actual element to be loaded – you can use this a with a try/except block instead.
from selenium.webdriver.support.ui import WebDriverWait def selenium_wait_for_class( browser, id, waitperiod=5): try: # Wait for an id with a specific name WebDriverWait(browser, waitperiod).until( EC.presence_of_element_located( (By.XPATH, "//*[@id='"+ classid + "']")) ) except TimeoutException: return False #if hit a timeout then it failed to find it return True
So instead of the time.sleep(5), you can then replace the code with:
selenium_wait_for_class( browser=driver, id='dismissable', waitperiod=5)
This will wait up to a maximum of 5 seconds for the videos to load, otherwise it’ll timeout