Python BeautifulSoup - Parse HTML, XML Documents in Python

ZetCode
All Spring Boot Python C# Java JavaScript Subscribe
Python BeautifulSoup
last modified July 27, 2020
Python BeautifulSoup tutorial is an introductory tutorial to BeautifulSoup Python library. The

examples find tags, traverse document tree, modify document, and scrape web pages.
BeautifulSoup
BeautifulSoup is a Python library for parsing HTML and XML documents. It is often used for web
scraping. BeautifulSoup transforms a complex HTML document into a complex tree of Python
objects, such as tag, navigable string, or comment.
Installing BeautifulSoup
We use the pip3 command to install the necessary modules.
$ sudo pip3 install lxml
We need to install the lxml module, which is used by BeautifulSoup.
$ sudo pip3 install bs4

BeautifulSoup is installed with the above command.
The HTML file

In the examples, we will use the following HTML file:
index.html
<!DOCTYPE html>
<html>
<head>
<title>Header</title>
<meta charset="utf-8">
</head>
<body>
<h2>Operating systems</h2>
<ul id="mylist" style="width:150px">

<li>Solaris</li>
<li>FreeBSD</li>
<li>Debian</li>
<li>NetBSD</li>
<li>Windows</li>
</ul>
<p>
FreeBSD is an advanced computer operating system used to
power modern servers, desktops, and embedded platforms.
</p>
<p>
Debian is a Unix-like computer operating system that is
composed entirely of free software.
</p>
</body>
</html>
Python BeautifulSoup simple example
In the first example, we use BeautifulSoup module to get three tags.
simple.py
#!/usr/bin/python
from bs4 import BeautifulSoup
with open('index.html', 'r') as f:
contents = f.read()
soup = BeautifulSoup(contents, 'lxml')
print(soup.h2)
print(soup.head)
print(soup.li)
The code example prints HTML code of three tags.
We import the BeautifulSoup class from the bs4 module. The BeautifulSoup is the main class
for doing work.
contents = f.read()
Google Ads -
Sitio O cial
Con Google Ads, no hay
contratos ni mínimo de
Google Ads inversión.
We open the index.html file and read its contents with the read method.
A BeautifulSoup object is created; the HTML data is passed to the constructor. The second option
specifies the parser.
print(soup.h2)
print(soup.head)
Here we print the HTML code of two tags: h2 and head.
print(soup.li)
There are multiple li elements; the line prints the first one.
$ ./simple.py
<h2>Operating systems</h2>
<head>
<title>Header</title>
<meta charset="utf-8"/>
</head>
<li>Solaris</li>
This is the output.
BeautifulSoup tags, name, text

The name attribute of a tag gives its name and the text attribute its text content.
tags_names.py
#!/usr/bin/python
contents = f.read()
print(f'HTML: {soup.h2}, name: {soup.h2.name}, text: {soup.h2.text}')
The code example prints HTML code, name, and text of the h2 tag.
$ ./tags_names.py
HTML: <h2>Operating systems</h2>, name: h2, text: Operating systems
This is the output.
BeautifulSoup traverse tags

With the recursiveChildGenerator method we traverse the HTML document.
traverse_tree.py
#!/usr/bin/python
contents = f.read()
for child in soup.recursiveChildGenerator():
if child.name:
print(child.name)
The example goes through the document tree and prints the names of all HTML tags.
$ ./traverse_tree.py
html
head
title
meta
body
h2
ul
li
li
li
li
li
p
p
In the HTML document we have these tags.
BeautifulSoup element children

With the children attribute, we can get the children of a tag.
get_children.py
#!/usr/bin/python
contents = f.read()
root = soup.html
root_childs = [e.name for e in root.children if e.name is not None]
print(root_childs)
The example retrieves children of the html tag, places them into a Python list and prints them to
the console. Since the children attribute also returns spaces between the tags, we add a condition
to include only the tag names.
$ ./get_children.py
['head', 'body']
The html tags has two children: head and body.
BeautifulSoup element descendants

With the descendants attribute we get all descendants (children of all levels) of a tag.
get_descendants.py
#!/usr/bin/python
contents = f.read()
root = soup.body
root_childs = [e.name for e in root.descendants if e.name is not None]

print(root_childs)
The example retrieves all descendants of the body tag.

$ ./get_descendants.py
['h2', 'ul', 'li', 'li', 'li', 'li', 'li', 'p', 'p']
These are all the descendants of the body tag.
BeautifulSoup web scraping

Requests is a simple Python HTTP library. It provides methods for accessing Web resources via
HTTP.
scraping.py
#!/usr/bin/python

import requests as req
resp = req.get('http://webcode.me')
soup = BeautifulSoup(resp.text, 'lxml')
print(soup.title)
print(soup.title.text)
print(soup.title.parent)
The example retrieves the title of a simple web page. It also prints its parent.
We get the HTML data of the page.
print(soup.title)
print(soup.title.text)
print(soup.title.parent)
We retrieve the HTML code of the title, its text, and the HTML code of its parent.
$ ./scraping.py
<title>My html page</title>
My html page
<head>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<title>My html page</title>
</head>
This is the output.
BeautifulSoup prettify code

With the prettify method, we can make the HTML code look better.
prettify.py
#!/usr/bin/python

print(soup.prettify())
We prettify the HTML code of a simple web page.
$ ./prettify.py
<!DOCTYPE html>
<html lang="en">
<head>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<title>
My html page
</title>
</head>
<body>
<p>
Today is a beautiful day. We go swimming and fishing.
</p>
<p>
Hello there. How are you?
</p>
</body>
</html>
This is the output.
BeautifulSoup scraping with built-in web server

We can also serve HTML pages with a simple built-in HTTP server.
$ mkdir public
$ cp index.html public/
We create a public directory and copy the index.html there.
$ python -m http.server --directory public

Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
Then we start the Python HTTP server.
scraping2.py
#!/usr/bin/python

resp = req.get('http://localhost:8000/')
print(soup.title)
print(soup.body)
Now we get the document from the locally running server.
BeautifulSoup find elements by Id

With the find method we can find elements by various means including element id.
find_by_id.py
#!/usr/bin/python
contents = f.read()
#print(soup.find('ul', attrs={ 'id' : 'mylist'}))

print(soup.find('ul', id='mylist'))
The code example finds ul tag that has mylist id. The commented line has is an alternative way of
doing the same task.
BeautifulSoup find all tags

With the find_all method we can find all elements that meet some criteria.
find_all.py
#!/usr/bin/python
contents = f.read()
for tag in soup.find_all('li'):

print(f'{tag.name}: {tag.text}')
The code example finds and prints all li tags.
$ ./find_all.py
li: Solaris
li: FreeBSD
li: Debian
li: NetBSD
li: Windows
This is the output.
The find_all method can take a list of elements to search for.
find_all2.py
#!/usr/bin/python
contents = f.read()
tags = soup.find_all(['h2', 'p'])
for tag in tags:

print(' '.join(tag.text.split()))
The example finds all h2 and p elements and prints their text.
The find_all method can also take a function which determines what elements should be
returned.
find_by_fun.py
#!/usr/bin/python
def myfun(tag):
return tag.is_empty_element
contents = f.read()
tags = soup.find_all(myfun)
print(tags)
The example prints empty elements.
$ ./find_by_fun.py
[<meta charset="utf-8"/>]
The only empty element in the document is meta.
It is also possible to find elements by using regular expressions.
regex.py
#!/usr/bin/python
import re
contents = f.read()
strings = soup.find_all(string=re.compile('BSD'))
for txt in strings:
print(' '.join(txt.split()))
The example prints content of elements that contain 'BSD' string.

$ ./regex.py
FreeBSD
NetBSD
FreeBSD is an advanced computer operating system used to power modern servers, desktops, and embedded plat
This is the output.
BeautifulSoup CSS selectors

With the select and select_one methods, we can use some CSS selectors to find elements.
select_nth_tag.py
#!/usr/bin/python
contents = f.read()

print(soup.select('li:nth-of-type(3)'))
This example uses a CSS selector to print the HTML code of the third li element.
$ ./select_nth_tag.py
<li>Debian</li>
This is the third li element.
The # character is used in CSS to select tags by their id attributes.
select_by_id.py
#!/usr/bin/python
contents = f.read()
print(soup.select_one('#mylist'))
The example prints the element that has mylist id.
BeautifulSoup append element

The append method appends a new tag to the HTML document.
append_tag.py
#!/usr/bin/python

contents = f.read()
newtag = soup.new_tag('li')
newtag.string='OpenBSD'
ultag = soup.ul
ultag.append(newtag)
print(ultag.prettify())
The example appends a new li tag.
First, we create a new tag with the new_tag method.
ultag = soup.ul
We get the reference to the ul tag.
ultag.append(newtag)
We append the newly created tag to the ul tag.
We print the ul tag in a neat format.
BeautifulSoup insert element

The insert method inserts a tag at the specified location.
insert_tag.py
#!/usr/bin/python
contents = f.read()
ultag = soup.ul
ultag.insert(2, newtag)
The example inserts a li tag at the third position into the ul tag.
BeautifulSoup replace text

The replace_with replaces a text of an element.
replace_text.py
#!/usr/bin/python
contents = f.read()
tag = soup.find(text='Windows')
tag.replace_with('OpenBSD')
print(soup.ul.prettify())
The example finds a specific element with the find method and replaces its content with the
replace_with method.
BeautifulSoup remove element

The decompose method removes a tag from the tree and destroys it.
decompose_tag.py
#!/usr/bin/python
contents = f.read()
ptag2 = soup.select_one('p:nth-of-type(2)')
ptag2.decompose()
print(soup.body.prettify())
The example removes the second p element.
In this tutorial, we have worked with the Python BeautifulSoup library.

Python BeautifulSoup - Parse HTML, XML Documents in Python

Uploaded by

Copyright:

Available Formats

Python BeautifulSoup - Parse HTML, XML Documents in Python

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Python BeautifulSoup - Parse HTML, XML Documents in Python

Uploaded by

Copyright:

Available Formats

What is BeautifulSoup used for?

What is BeautifulSoup used for?

How can BeautifulSoup be used to parse HTML documents?

How can BeautifulSoup be used to parse HTML documents?

ZetCode

All Spring Boot Python C# Java JavaScript Subscribe

Python BeautifulSoup tutorial is an introductory tutorial to BeautifulSoup Python library. The

$ sudo pip3 install lxml

We need to install the lxml module, which is used by BeautifulSoup.

$ sudo pip3 install bs4

The HTML file

<ul id="mylist" style="width:150px">

from bs4 import BeautifulSoup

with open('index.html', 'r') as f:

soup = BeautifulSoup(contents, 'lxml')

The code example prints HTML code of three tags.

from bs4 import BeautifulSoup

with open('index.html', 'r') as f:

soup = BeautifulSoup(contents, 'lxml')

Here we print the HTML code of two tags: h2 and head.

This is the output.

BeautifulSoup tags, name, text

from bs4 import BeautifulSoup

with open('index.html', 'r') as f:

soup = BeautifulSoup(contents, 'lxml')

print(f'HTML: {soup.h2}, name: {soup.h2.name}, text: {soup.h2.text}')

This is the output.

BeautifulSoup traverse tags

from bs4 import BeautifulSoup

with open('index.html', 'r') as f:

soup = BeautifulSoup(contents, 'lxml')

for child in soup.recursiveChildGenerator():

In the HTML document we have these tags.

BeautifulSoup element children

from bs4 import BeautifulSoup

with open('index.html', 'r') as f:

soup = BeautifulSoup(contents, 'lxml')

The html tags has two children: head and body.

BeautifulSoup element descendants

from bs4 import BeautifulSoup

with open('index.html', 'r') as f:

soup = BeautifulSoup(contents, 'lxml')

root_childs = [e.name for e in root.descendants if e.name is not None]

The example retrieves all descendants of the body tag.

These are all the descendants of the body tag.

BeautifulSoup web scraping

from bs4 import BeautifulSoup

soup = BeautifulSoup(resp.text, 'lxml')

soup = BeautifulSoup(resp.text, 'lxml')

We get the HTML data of the page.

This is the output.

BeautifulSoup prettify code

from bs4 import BeautifulSoup

soup = BeautifulSoup(resp.text, 'lxml')

We prettify the HTML code of a simple web page.

This is the output.

BeautifulSoup scraping with built-in web server

We create a public directory and copy the index.html there.

$ python -m http.server --directory public