What is python web crawling?

Web scraping is the process of collecting and parsing raw data from the Web, and the Python community has come up with some pretty powerful web scraping tools.

The Internet hosts perhaps the greatest source of information—and misinformation—on the planet. Many disciplines, such as data science, business intelligence, and investigative reporting, can benefit enormously from collecting and analyzing data from websites.

In this tutorial, you’ll learn how to:

  • Parse website data using string methods and regular expressions
  • Parse website data using an HTML parser
  • Interact with forms and other website components

Scrape and Parse Text From Websites

Collecting data from websites using an automated process is known as web scraping. Some websites explicitly forbid users from scraping their data with automated tools like the ones you’ll create in this tutorial. Websites do this for two possible reasons:

  1. The site has a good reason to protect its data. For instance, Google Maps doesn’t let you request too many results too quickly.
  2. Making many repeated requests to a website’s server may use up bandwidth, slowing down the website for other users and potentially overloading the server such that the website stops responding entirely.

Let’s start by grabbing all the HTML code from a single web page. You’ll use a page on Real Python that’s been set up for use with this tutorial.

Your First Web Scraper

One useful package for web scraping that you can find in Python’s standard library is urllib, which contains tools for working with URLs. In particular, the urllib.request module contains a function called urlopen() that can be used to open a URL within a program.

In IDLE’s interactive window, type the following to import urlopen():

>>>

>>> from urllib.request import urlopen

The web page that we’ll open is at the following URL:

>>>

>>> url = "http://olympus.realpython.org/profiles/aphrodite"

To open the web page, pass url to urlopen():

>>>

>>> page = urlopen(url)

urlopen() returns an HTTPResponse object:

>>>

>>> page

To extract the HTML from the page, first use the HTTPResponse object’s .read() method, which returns a sequence of bytes. Then use .decode() to decode the bytes to a string using UTF-8:

>>>

>>> html_bytes = page.read()
>>> html = html_bytes.decode("utf-8")

Now you can print the HTML to see the contents of the web page:

>>>

>>> print(html)


Profile: Aphrodite




What is python web crawling?

Name: Aphrodite



Favorite animal: Dove

Favorite color: Red

Hometown: Mount Olympus

Once you have the HTML as text, you can extract information from it in a couple of different ways.

A Primer on Regular Expressions

Regular expressions—or regexes for short—are patterns that can be used to search for text within a string. Python supports regular expressions through the standard library’s re module.

To work with regular expressions, the first thing you need to do is import the re module:

Regular expressions use special characters called metacharacters to denote different patterns. For instance, the asterisk character (*) stands for zero or more of whatever comes just before the asterisk.

In the following example, you use findall() to find any text within a string that matches a given regular expression:

>>>

>>> re.findall("ab*c", "ac")
['ac']

The first argument of re.findall() is the regular expression that you want to match, and the second argument is the string to test. In the above example, you search for the pattern "ab*c" in the string "ac".

The regular expression "ab*c" matches any part of the string that begins with an "a", ends with a "c", and has zero or more instances of "b" between the two. re.findall() returns a list of all matches. The string "ac" matches this pattern, so it’s returned in the list.

Here’s the same pattern applied to different strings:

>>>

>>> re.findall("ab*c", "abcd")
['abc']

>>> re.findall("ab*c", "acc")
['ac']

>>> re.findall("ab*c", "abcac")
['abc', 'ac']

>>> re.findall("ab*c", "abdc")
[]

Notice that if no match is found, then findall() returns an empty list.

Pattern matching is case sensitive. If you want to match this pattern regardless of the case, then you can pass a third argument with the value re.IGNORECASE:

>>>

>>> re.findall("ab*c", "ABC")
[]

>>> re.findall("ab*c", "ABC", re.IGNORECASE)
['ABC']

You can use a period (.) to stand for any single character in a regular expression. For instance, you could find all the strings that contain the letters "a" and "c" separated by a single character as follows:

>>>

>>> re.findall("a.c", "abc")
['abc']

>>> re.findall("a.c", "abbc")
[]

>>> re.findall("a.c", "ac")
[]

>>> re.findall("a.c", "acc")
['acc']

The pattern .* inside a regular expression stands for any character repeated any number of times. For instance, "a.*c" can be used to find every substring that starts with "a" and ends with "c", regardless of which letter—or letters—are in between:

>>>

>>> re.findall("a.*c", "abc")
['abc']

>>> re.findall("a.*c", "abbc")
['abbc']

>>> re.findall("a.*c", "ac")
['ac']

>>> re.findall("a.*c", "acc")
['acc']

Often, you use re.search() to search for a particular pattern inside a string. This function is somewhat more complicated than re.findall() because it returns an object called a MatchObject that stores different groups of data. This is because there might be matches inside other matches, and re.search() returns every possible result.

The details of the MatchObject are irrelevant here. For now, just know that calling .group() on a MatchObject will return the first and most inclusive result, which in most cases is just what you want:

>>>

>>> match_results = re.search("ab*c", "ABC", re.IGNORECASE)
>>> match_results.group()
'ABC'

There’s one more function in the re module that’s useful for parsing out text. re.sub(), which is short for substitute, allows you to replace text in a string that matches a regular expression with new text. It behaves sort of like the .replace() string method.

The arguments passed to re.sub() are the regular expression, followed by the replacement text, followed by the string. Here’s an example:

>>>

>>> string = "Everything is  if it's in ."
>>> string = re.sub("<.*>", "ELEPHANTS", string)
>>> string
'Everything is ELEPHANTS.'

Perhaps that wasn’t quite what you expected to happen.

re.sub() uses the regular expression "<.*>" to find and replace everything between the first < and last >, which spans from the beginning of to the end of . This is because Python’s regular expressions are greedy, meaning they try to find the longest possible match when characters like * are used.

Alternatively, you can use the non-greedy matching pattern *?, which works the same way as * except that it matches the shortest possible string of text:

>>>

>>> string = "Everything is  if it's in ."
>>> string = re.sub("<.*?>", "ELEPHANTS", string)
>>> string
"Everything is ELEPHANTS if it's in ELEPHANTS."

This time, re.sub() finds two matches, and , and substitutes the string "ELEPHANTS" for both matches.

Check Your Understanding

Expand the block below to check your understanding.

Write a program that grabs the full HTML from the following URL:

>>>

>>> url = "http://olympus.realpython.org/profiles/dionysus"

Then use .find() to display the text following “Name:” and “Favorite Color:” (not including any leading spaces or trailing HTML tags that might appear on the same line).

You can expand the block below to see a solution.

First, import the urlopen function from the urlib.request module:

from urllib.request import urlopen

Then open the URL and use the .read() method of the HTTPResponse object returned by urlopen() to read the page’s HTML:

url = "http://olympus.realpython.org/profiles/dionysus"
html_page = urlopen(url)
html_text = html_page.read().decode("utf-8")

.read() returns a byte string, so you use .decode() to decode the bytes using the UTF-8 encoding.

Now that you have the HTML source of the web page as a string assigned to the html_text variable, you can extract Dionysus’s name and favorite color from his profile. The structure of the HTML for Dionysus’s profile is the same as Aphrodite’s profile that you saw earlier.

You can get the name by finding the string "Name:" in the text and extracting everything that comes after the first occurence of the string and before the next HTML tag. That is, you need to extract everything after the colon (:) and before the first angle bracket (<). You can use the same technique to extract the favorite color.

The following for loop extracts this text for both the name and favorite color:

for string in ["Name: ", "Favorite Color:"]:
    string_start_idx = html_text.find(string)
    text_start_idx = string_start_idx + len(string)

    next_html_tag_offset = html_text[text_start_idx:].find("<")
    text_end_idx = text_start_idx + next_html_tag_offset

    raw_text = html_text[text_start_idx : text_end_idx]
    clean_text = raw_text.strip(" \r\n\t")
    print(clean_text)

It looks like there’s a lot going on in this forloop, but it’s just a little bit of arithmetic to calculate the right indices for extracting the desired text. Let’s break it down:

  1. You use html_text.find() to find the starting index of the string, either "Name:" or "Favorite Color:", and then assign the index to string_start_idx.

  2. Since the text to extract starts just after the colon in "Name:" or "Favorite Color:", you get the index of the the character immediately after the colon by adding the length of the string to start_string_idx and assign the result to text_start_idx.

  3. You calculate the ending index of the text to extract by determining the index of the first angle bracket (<) relative to text_start_idx and assign this value to next_html_tag_offset. Then you add that value to text_start_idx and assign the result to text_end_idx.

  4. You extract the text by slicing html_text from text_start_idx to text_end_idx and assign this string to raw_text.

  5. You remove any whitespace from the beginning and end of raw_text using .strip() and assign the result to clean_text.

At the end of the loop, you use print() to display the extracted text. The final output looks like this:

This solution is one of many that solves this problem, so if you got the same output with a different solution, then you did great!

When you’re ready, you can move on to the next section.

Use an HTML Parser for Web Scraping in Python

Although regular expressions are great for pattern matching in general, sometimes it’s easier to use an HTML parser that’s explicitly designed for parsing out HTML pages. There are many Python tools written for this purpose, but the Beautiful Soup library is a good one to start with.

Install Beautiful Soup

To install Beautiful Soup, you can run the following in your terminal:

$ python3 -m pip install beautifulsoup4

Run pip show to see the details of the package you just installed:

$ python3 -m pip show beautifulsoup4
Name: beautifulsoup4
Version: 4.9.1
Summary: Screen-scraping library
Home-page: http://www.crummy.com/software/BeautifulSoup/bs4/
Author: Leonard Richardson
Author-email: 
License: MIT
Location: c:\realpython\venv\lib\site-packages
Requires:
Required-by:

In particular, notice that the latest version at the time of writing was 4.9.1.

Create a BeautifulSoup Object

Type the following program into a new editor window:

from bs4 import BeautifulSoup
from urllib.request import urlopen

url = "http://olympus.realpython.org/profiles/dionysus"
page = urlopen(url)
html = page.read().decode("utf-8")
soup = BeautifulSoup(html, "html.parser")

This program does three things:

  1. Opens the URL http://olympus.realpython.org/profiles/dionysus using urlopen() from the urllib.request module

  2. Reads the HTML from the page as a string and assigns it to the html variable

  3. Creates a BeautifulSoup object and assigns it to the soup variable

The BeautifulSoup object assigned to soup is created with two arguments. The first argument is the HTML to be parsed, and the second argument, the string "html.parser", tells the object which parser to use behind the scenes. "html.parser" represents Python’s built-in HTML parser.

Use a BeautifulSoup Object

Save and run the above program. When it’s finished running, you can use the soup variable in the interactive window to parse the content of html in various ways.

For example, BeautifulSoup objects have a .get_text() method that can be used to extract all the text from the document and automatically remove any HTML tags.

Type the following code into IDLE’s interactive window:

>>>

>>> print(soup.get_text())


Profile: Dionysus





Name: Dionysus

Hometown: Mount Olympus

Favorite animal: Leopard

Favorite Color: Wine

There are a lot of blank lines in this output. These are the result of newline characters in the HTML document’s text. You can remove them with the string .replace() method if you need to.

Often, you need to get only specific text from an HTML document. Using Beautiful Soup first to extract the text and then using the .find() string method is sometimes easier than working with regular expressions.

However, sometimes the HTML tags themselves are the elements that point out the data you want to retrieve. For instance, perhaps you want to retrieve the URLs for all the images on the page. These links are contained in the src attribute of

What is python web crawling?
,
What is python web crawling?
]

This returns a list of all

What is python web crawling?
tag has a single attribute, src, with the value "/static/dionysus.jpg". Likewise, an HTML tag such as the link has two attributes, href and target.

To get the source of the images in the Dionysus profile page, you access the src attribute using the dictionary notation mentioned above:

>>>

>>> image1["src"]
'/static/dionysus.jpg'

>>> image2["src"]
'/static/grapes.png'

Certain tags in HTML documents can be accessed by properties of the Tag object. For example, to get the </code> tag in a document, you can use the <code>.title</code> property:</p><p><p><span>>>></span></p><pre><span></span><code><span>>>> </span><span>soup</span><span>.</span><span>title</span> <span><title>Profile: Dionysus

If you look at the source of the Dionysus profile by navigating to the profile page, right-clicking on the page, and selecting View page source, then you’ll notice that the </code> tag as written in the document looks like this:</p><p><pre><span></span><code><span><</span><span>title</span> <span>></span>Profile: Dionysus<span><</span>/title/> </code></pre></p><p>Beautiful Soup automatically cleans up the tags for you by removing the extra space in the opening tag and the extraneous forward slash (<code>/</code>) in the closing tag.</p><p>You can also retrieve just the string between the title tags with the <code>.string</code> property of the <code>Tag</code> object:</p><p><p><span>>>></span></p><div style="width:100%; margin:20px auto; display:block"> <ins class="adsbygoogle" style="display:block; text-align:center;" data-ad-layout="in-article" data-ad-format="fluid" data-ad-client="ca-pub-4987931798153631" data-ad-slot="8587332220"></ins> <script> (adsbygoogle = window.adsbygoogle || []).push({}); </script> </div></p><pre><span></span><code><span>>>> </span><span>soup</span><span>.</span><span>title</span><span>.</span><span>string</span> <span>'Profile: Dionysus'</span> </code></pre></p><p>One of the more useful features of Beautiful Soup is the ability to search for specific kinds of tags whose attributes match certain values. For example, if you want to find all the <code><div class="imgBox"><img alt="What is python web crawling?" data-orgimg="https://sg.cdnki.com/what-is-python-web-crawling---L3N0YXRpYy9kaW9ueXN1cy5qcGc=.webp" ></img></div>]</span> </code></pre></p><p>This example is somewhat arbitrary, and the usefulness of this technique may not be apparent from the example. If you spend some time browsing various websites and viewing their page sources, then you’ll notice that many websites have extremely complicated HTML structures.</p><p>When scraping data from websites with Python, you’re often interested in particular parts of the page. By spending some time looking through the HTML document, you can identify tags with unique attributes that you can use to extract the data you need.</p><p>Then, instead of relying on complicated regular expressions or using <code>.find()</code> to search through the document, you can directly access the particular tag you’re interested in and extract the data you need.</p><p>In some cases, you may find that Beautiful Soup doesn’t offer the functionality you need. The lxml library is somewhat trickier to get started with but offers far more flexibility than Beautiful Soup for parsing HTML documents. You may want to check it out once you’re comfortable using Beautiful Soup.</p><p>BeautifulSoup is great for scraping data from a website’s HTML, but it doesn’t provide any way to work with HTML forms. For example, if you need to search a website for some query and then scrape the results, then BeautifulSoup alone won’t get you very far.</p></section><section><h3 id="check-your-understanding">Check Your Understanding</h3><p>Expand the block below to check your understanding.</p><p><p>Write a program that grabs the full HTML from the page at the URL <code>http://olympus.realpython.org/profiles</code>.</p><p>Using Beautiful Soup, print out a list of all the links on the page by looking for HTML tags with the name <code>a</code> and retrieving the value taken on by the <code>href</code> attribute of each tag.</p><p>The final output should look like this:</p><p><pre><span></span><code><span>http://olympus.realpython.org/profiles/aphrodite</span> <span>http://olympus.realpython.org/profiles/poseidon</span> <span>http://olympus.realpython.org/profiles/dionysus</span> </code></pre></p><p>You can expand the block below to see a solution:</p><p><p>First, import the <code>urlopen</code> function from the <code>urlib.request</code> module and the <code>BeautifulSoup</code> class from the <code>bs4</code> package:</p><p><pre><span></span><code><span>from</span> <span>urllib.request</span> <span>import</span> <span>urlopen</span> <span>from</span> <span>bs4</span> <span>import</span> <span>BeautifulSoup</span> </code></pre></p><p>Each link URL on the <code>/profiles</code> page is a relative URL, so create a <code>base_url</code> variable with the base URL of the website:</p><p><pre><span></span><code><span>base_url</span> <span>=</span> <span>"http://olympus.realpython.org"</span> </code></pre></p><p>You can build a full URL by concatenating <code>base_url</code> with a relative URL.</p><p>Now open the <code>/profiles</code> page with <code>urlopen()</code> and use <code>.read()</code> to get the HTML source:</p><p><pre><span></span><code><span>html_page</span> <span>=</span> <span>urlopen</span><span>(</span><span>base_url</span> <span>+</span> <span>"/profiles"</span><span>)</span> <span>html_text</span> <span>=</span> <span>html_page</span><span>.</span><span>read</span><span>()</span><span>.</span><span>decode</span><span>(</span><span>"utf-8"</span><span>)</span> </code></pre></p><p>With the HTML source downloaded and decoded, you can create a new <code>BeautifulSoup</code> object to parse the HTML:</p><p><pre><span></span><code><span>soup</span> <span>=</span> <span>BeautifulSoup</span><span>(</span><span>html_text</span><span>,</span> <span>"html.parser"</span><span>)</span> </code></pre></p><p><code>soup.find_all("a")</code> returns a list of all links in the HTML source. You can loop over this list to print out all the links on the webpage:</p><p><pre><span></span><code><span>for</span> <span>link</span> <span>in</span> <span>soup</span><span>.</span><span>find_all</span><span>(</span><span>"a"</span><span>):</span> <span>link_url</span> <span>=</span> <span>base_url</span> <span>+</span> <span>link</span><span>[</span><span>"href"</span><span>]</span> <span>print</span><span>(</span><span>link_url</span><span>)</span> </code></pre></p><p>The relative URL for each link can be accessed through the <code>"href"</code> subscript. Concatenate this value with <code>base_url</code> to create the full <code>link_url</code>.</p><p>When you’re ready, you can move on to the next section.</p></section></section><section><h2 id="interact-with-html-forms">Interact With HTML Forms</h2><p>The <code>urllib</code> module you’ve been working with so far in this tutorial is well suited for requesting the contents of a web page. Sometimes, though, you need to interact with a web page to obtain the content you need. For example, you might need to submit a form or click a button to display hidden content.</p><p>The Python standard library doesn’t provide a built-in means for working with web pages interactively, but many third-party packages are available from PyPI. Among these, MechanicalSoup is a popular and relatively straightforward package to use.</p><p>In essence, MechanicalSoup installs what’s known as a <strong>headless browser</strong>, which is a web browser with no graphical user interface. This browser is controlled programmatically via a Python program.</p><section><h3 id="install-mechanicalsoup">Install MechanicalSoup</h3><p>You can install MechanicalSoup with <code>pip</code> in your terminal:</p><p><pre><span></span><code><span>$ </span>python3 -m pip install MechanicalSoup </code></pre></p><p>You can now view some details about the package with <code>pip show</code>:</p><p><pre><span></span><code><span>$ </span>python3 -m pip show mechanicalsoup <span>Name: MechanicalSoup</span> <span>Version: 0.12.0</span> <span>Summary: A Python library for automating interaction with websites</span> <span>Home-page: https://mechanicalsoup.readthedocs.io/</span> <span>Author: UNKNOWN</span> <span>Author-email: UNKNOWN</span> <span>License: MIT</span> <span>Location: c:\realpython\venv\lib\site-packages</span> <span>Requires: requests, beautifulsoup4, six, lxml</span> <span>Required-by:</span> </code></pre></p><p>In particular, notice that the latest version at the time of writing was 0.12.0. You’ll need to close and restart your IDLE session for MechanicalSoup to load and be recognized after it’s been installed.</p></section><section><h3 id="create-a-browser-object">Create a Browser Object</h3><p>Type the following into IDLE’s interactive window:</p><p><p><span>>>></span></p><pre><span></span><code><span>>>> </span><span>import</span> <span>mechanicalsoup</span> <span>>>> </span><span>browser</span> <span>=</span> <span>mechanicalsoup</span><span>.</span><span>Browser</span><span>()</span> </code></pre></p><p><code>Browser</code> objects represent the headless web browser. You can use them to request a page from the Internet by passing a URL to their <code>.get()</code> method:</p><p><p><span>>>></span></p><pre><span></span><code><span>>>> </span><span>url</span> <span>=</span> <span>"http://olympus.realpython.org/login"</span> <span>>>> </span><span>page</span> <span>=</span> <span>browser</span><span>.</span><span>get</span><span>(</span><span>url</span><span>)</span> </code></pre></p><p><code>page</code> is a <code>Response</code> object that stores the response from requesting the URL from the browser:</p><p><p><span>>>></span></p><pre><span></span><code><span>>>> </span><span>page</span> <span><Response [200]></span> </code></pre></p><p>The number <code>200</code> represents the status code returned by the request. A status code of <code>200</code> means that the request was successful. An unsuccessful request might show a status code of <code>404</code> if the URL doesn’t exist or <code>500</code> if there’s a server error when making the request.</p><p>MechanicalSoup uses Beautiful Soup to parse the HTML from the request. <code>page</code> has a <code>.soup</code> attribute that represents a <code>BeautifulSoup</code> object:</p><p><p><span>>>></span></p><pre><span></span><code><span>>>> </span><span>type</span><span>(</span><span>page</span><span>.</span><span>soup</span><span>)</span> <span><class 'bs4.BeautifulSoup'></span> </code></pre></p><p>You can view the HTML by inspecting the <code>.soup</code> attribute:</p><p><p><span>>>></span></p><pre><span></span><code><span>>>> </span><span>page</span><span>.</span><span>soup</span> <span><html></span> <span><head></span> <span><title>Log In



Please log in to access Mount Olympus:



Username:
Password:

Notice this page has a

on it with elements for a username and a password.

Submit a Form With MechanicalSoup

Open the /login page from the previous example in a browser and look at it yourself before moving on. Try typing in a random username and password combination. If you guess incorrectly, then the message “Wrong username or password!” is displayed at the bottom of the page.

However, if you provide the correct login credentials (username zeus and password ThunderDude), then you’re redirected to the /profiles page.

In the next example, you’ll see how to use MechanicalSoup to fill out and submit this form using Python!

The important section of HTML code is the login form—that is, everything inside the tags. The on this page has the name attribute set to login. This form contains two elements, one named user and the other named pwd. The third element is the Submit button.

Now that you know the underlying structure of the login form, as well as the credentials needed to log in, let’s take a look at a program. that fills the form out and submits it.

In a new editor window, type in the following program:

import mechanicalsoup

# 1
browser = mechanicalsoup.Browser()
url = "http://olympus.realpython.org/login"
login_page = browser.get(url)
login_html = login_page.soup

# 2
form = login_html.select("form")[0]
form.select("input")[0]["value"] = "zeus"
form.select("input")[1]["value"] = "ThunderDude"

# 3
profiles_page = browser.submit(form, login_page.url)

Save the file and press F5 to run it. You can confirm that you successfully logged in by typing the following into the interactive window:

>>>

>>> profiles_page.url
'http://olympus.realpython.org/profiles'

Let’s break down the above example:

  1. You create a Browser instance and use it to request the URL http://olympus.realpython.org/login. You assign the HTML content of the page to the login_html variable using the .soup property.

  2. login_html.select("form") returns a list of all elements on the page. Since the page has only one element, you can access the form by retrieving the element at index 0 of the list. The next two lines select the username and password inputs and set their value to "zeus" and "ThunderDude", respectively.

  3. You submit the form with browser.submit(). Notice that you pass two arguments to this method, the form object and the URL of the login_page, which you access via login_page.url.

In the interactive window, you confirm that the submission successfully redirected to the /profiles page. If something had gone wrong, then the value of profiles_page.url would still be "http://olympus.realpython.org/login".

Now that we have the profiles_page variable set, let’s see how to programmatically obtain the URL for each link on the /profiles page.

To do this, you use .select() again, this time passing the string "a" to select all the anchor elements on the page:

>>>

>>> links = profiles_page.soup.select("a")

Now you can iterate over each link and print the href attribute:

>>>

>>> for link in links:
...     address = link["href"]
...     text = link.text
...     print(f"{text}: {address}")
...
Aphrodite: /profiles/aphrodite
Poseidon: /profiles/poseidon
Dionysus: /profiles/dionysus

The URLs contained in each href attribute are relative URLs, which aren’t very helpful if you want to navigate to them later using MechanicalSoup. If you happen to know the full URL, then you can assign the portion needed to construct a full URL.

In this case, the base URL is just http://olympus.realpython.org. Then you can concatenate the base URL with the relative URLs found in the src attribute:

>>>

>>> base_url = "http://olympus.realpython.org"
>>> for link in links:
...     address = base_url + link["href"]
...     text = link.text
...     print(f"{text}: {address}")
...
Aphrodite: http://olympus.realpython.org/profiles/aphrodite
Poseidon: http://olympus.realpython.org/profiles/poseidon
Dionysus: http://olympus.realpython.org/profiles/dionysus

You can do a lot with just .get(), .select(), and .submit(). That said, MechanicalSoup is capable of much more. To learn more about MechanicalSoup, check out the official docs.

Check Your Understanding

Expand the block below to check your understanding

Use MechanicalSoup to provide the correct username (zeus) and password (ThunderDude) to the login form located at the URL http://olympus.realpython.org/login.

Once the form is submitted, display the title of the current page to determine that you’ve been redirected to the /profiles page.

Your program should print the text All Profiles.

You can expand the block below to see a solution.

First, import the mechanicalsoup package and create a Broswer object:

import mechanicalsoup

browser = mechanicalsoup.Browser()

Point the browser to the login page by passing the URL to browser.get() and grab the HTML with the .soup attribute:

login_url = "http://olympus.realpython.org/login"
login_page = browser.get(login_url)
login_html = login_page.soup

login_html is a BeautifulSoup instance. Since the page has only a single form on it, you can access the form via login_html.form. Using .select(), select the username and password inputs and fill them with the username "zeus" and the password "ThunderDude":

form = login_html.form
form.select("input")[0]["value"] = "zeus"
form.select("input")[1]["value"] = "ThunderDude"

Now that the form is filled out, you can submit it with browser.submit():

profiles_page = browser.submit(form, login_page.url)

If you filled the form with the correct username and password, then profiles_page should actually point to the /profiles page. You can confirm this by printing the title of the page assigned to profiles_page:

print(profiles_page.soup.title)

You should see the following text displayed:

All Profiles

If instead you see the text Log In or something else, then the form submission failed.

When you’re ready, you can move on to the next section.

Interact With Websites in Real Time

Sometimes you want to be able to fetch real-time data from a website that offers continually updated information.

In the dark days before you learned Python programming, you had to sit in front of a browser, clicking the Refresh button to reload the page each time you wanted to check if updated content was available. But now you can automate this process using the .get() method of the MechanicalSoup Browser object.

Open your browser of choice and navigate to the URL http://olympus.realpython.org/dice. This /dice page simulates a roll of a six-sided die, updating the result each time you refresh the browser. Below, you’ll write a program that repeatedly scrapes the page for a new result.

The first thing you need to do is determine which element on the page contains the result of the die roll. Do this now by right-clicking anywhere on the page and selecting View page source. A little more than halfway down the HTML code is an

tag that looks like this:

The text of the

tag might be different for you, but this is the page element you need for scraping the result.

Let’s start by writing a simple program that opens the /dice page, scrapes the result, and prints it to the console:

import mechanicalsoup

browser = mechanicalsoup.Browser()
page = browser.get("http://olympus.realpython.org/dice")
tag = page.soup.select("#result")[0]
result = tag.text

print(f"The result of your dice roll is: {result}")

This example uses the BeautifulSoup object’s .select() method to find the element with id=result. The string "#result" that you pass to .select() uses the CSS ID selector # to indicate that result is an id value.

To periodically get a new result, you’ll need to create a loop that loads the page at each step. So everything below the line browser = mechanicalsoup.Browser() in the above code needs to go in the body of the loop.

For this example, let’s get four rolls of the dice at ten-second intervals. To do that, the last line of your code needs to tell Python to pause running for ten seconds. You can do this with sleep() from Python’s time module. sleep() takes a single argument that represents the amount of time to sleep in seconds.

Here’s an example that illustrates how sleep() works:

import time

print("I'm about to wait for five seconds...")
time.sleep(5)
print("Done waiting!")

When you run this code, you’ll see that the "Done waiting!" message isn’t displayed until 5 seconds have passed from when the first print() function was executed.

For the die roll example, you’ll need to pass the number 10 to sleep(). Here’s the updated program:

import time
import mechanicalsoup

browser = mechanicalsoup.Browser()

for i in range(4):
    page = browser.get("http://olympus.realpython.org/dice")
    tag = page.soup.select("#result")[0]
    result = tag.text
    print(f"The result of your dice roll is: {result}")
    time.sleep(10)

When you run the program, you’ll immediately see the first result printed to the console. After ten seconds, the second result is displayed, then the third, and finally the fourth. What happens after the fourth result is printed?

The program continues running for another ten seconds before it finally stops!

Well, of course it does—that’s what you told it to do! But it’s kind of a waste of time. You can stop it from doing this by using an if statement to run time.sleep() for only the first three requests:

import time
import mechanicalsoup

browser = mechanicalsoup.Browser()

for i in range(4):
    page = browser.get("http://olympus.realpython.org/dice")
    tag = page.soup.select("#result")[0]
    result = tag.text
    print(f"The result of your dice roll is: {result}")

    # Wait 10 seconds if this isn't the last request
    if i < 3:
        time.sleep(10)

With techniques like this, you can scrape data from websites that periodically update their data. However, you should be aware that requesting a page multiple times in rapid succession can be seen as suspicious, or even malicious, use of a website.

It’s even possible to crash a server with an excessive number of requests, so you can imagine that many websites are concerned about the volume of requests to their server! Always check the Terms of Use and be respectful when sending multiple requests to a website.

Conclusion

Although it’s possible to parse data from the Web using tools in Python’s standard library, there are many tools on PyPI that can help simplify the process.

In this tutorial, you learned how to:

Writing automated web scraping programs is fun, and the Internet has no shortage of content that can lead to all sorts of exciting projects.

Just remember, not everyone wants you pulling data from their web servers. Always check a website’s Terms of Use before you start scraping, and be respectful about how you time your web requests so that you don’t flood a server with traffic.

Additional Resources

For more information on web scraping with Python, check out the following resources:

What is web crawling used for?

A web crawler, or spider, is a type of bot that is typically operated by search engines like Google and Bing. Their purpose is to index the content of websites all across the Internet so that those websites can appear in search engine results.

What is web crawling process?

What is web crawling? Web crawling is the process of indexing data on web pages by using a program or automated script. These automated scripts or programs are known by multiple names, including web crawler, spider, spider bot, and often shortened to crawler.

How do you create a web crawler in Python?

Building a Web Crawler using Python.
a name for identifying the spider or the crawler, “Wikipedia” in the above example..
a start_urls variable containing a list of URLs to begin crawling from. ... .
a parse() method which will be used to process the webpage to extract the relevant and necessary content..

What is the difference between web scraping and crawling?

The short answer is that web scraping is about extracting the data from one or more websites. While crawling is about finding or discovering URLs or links on the web. Usually, in web data extraction projects, you need to combine crawling and scraping.