Skip to content

beautifulsoup

- - - MIT License
4.12.3 (17 Jan 2024) Jul 26 2019 119.1 million (month)

beautifulsoup is a Python library for pulling data out of HTML and XML files. It creates parse trees from the source code that can be used to extract data from HTML, which is useful for web scraping. With beautifulsoup, you can search, navigate, and modify the parse tree. It sits atop popular Python parsers like lxml and html5lib, allowing users to try out different parsing strategies or trade speed for flexibility.

beautifulsoup has a number of useful methods and attributes that can be used to extract and manipulate data from an HTML or XML document. Some of the key features include:

  • Searching the parse tree
    You can search the parse tree using the various search methods that beautifulsoup provides, such as find(), find_all(), and select(). These methods take various arguments to search for specific tags, attributes, and text, and return a list of matching elements.
  • Navigating the parse tree
    You can navigate the parse tree using the various navigation methods that beautifulsoup provides, such as next_sibling, previous_sibling, next_element, previous_element, parent, and children. These methods allow you to move up, down, and around the parse tree.
  • Modifying the parse tree
    You can modify the parse tree using the various modification methods that beautifulsoup provides, such as append(), extend(), insert(), insert_before(), and insert_after(). These methods allow you to add new elements to the parse tree, or to change the position of existing elements.
  • Accessing tag attributes
    You can access the attributes of a tag using the attrs property. This property returns a dictionary of the tag's attributes and their values.
  • Accessing tag text
    You can access the text within a tag using the string property. This property returns the text as a string, with any leading or trailing whitespace removed.

With the above feature one can easily extract data out of HTML or XML files. It is widely used in web scraping and other data extraction projects.

It also has features for parsing XML files, special methods for dealing with HTML forms, pretty printing HTML and a few other functionalities.

Highlights


css-selectorsdsl-selectorshttp2

Example Use


from bs4 import BeautifulSoup

# this is our HTML page:
html = """
<head>
  <title>Hello World!</title>
</head>
<body>
  <div id="product">
    <h1>Product Title</h1>
    <p>paragraph 1</p>
    <p>paragraph2</p>
    <span class="price">$10</span>
  </div>
</body>
"""

soup = BeautifulSoup(html)

# we can iterate using dot notation:
soup.head.title
"Hello World"

# or use find method to recursively find matching elements:
soup.find(class_="price").text
"$10"

# the selected elements can be modified in place:
soup.find(class_="price").string = "$20"

# beautifulsoup also supports CSS selectors:
soup.select_one("#product .price").text
"$20"

# bs4 also contains various utility functions like HTML formatting
print(soup.prettify())
"""
<html>
 <head>
  <title>
   Hello World!
  </title>
 </head>
 <body>
  <div id="product">
   <h1>
    Product Title
   </h1>
   <p>
    paragraph 1
   </p>
   <p>
    paragraph2
   </p>
   <span class="price">
    $20
   </span>
  </div>
 </body>
</html>
"""

Alternatives / Similar


2,719 5.3.0 (3 months ago) Dec 13 2022 compare
5,523 0.14.2 (a month ago) Jul 30 2007 compare
1,135 1.1 (4 years ago) Jul 30 2007 compare
291 1.2.0 (2 years ago) Apr 14 2012 compare
1,992 6.0.11 (a year ago) Jun 15 2007 compare
2,302 2.0.1 (3 months ago) Dec 05 2008 compare
1,156 1.9.1 (8 months ago) Jul 26 2019 compare
13,748 0.10.0 (5 years ago) Feb 25 2018 compare
1,173 0.3.26 (29 days ago) Mar 01 2018 compare
612 1.2.1 (2 years ago) Jun 09 2011 compare
682 0.4.12 (1 year, 21 days ago) Jun 03 2007 compare
198 1.3.0 (3 months ago) Jul 30 2007 compare
747 1.1 (4 years ago) Dec 28 2012 compare
22 0.6.0 (1 year, 7 months ago) Jul 24 2014 compare

Other Languages

3,682 7.2.1 (a month ago) Jul 03 2013 compare
1,096 1.4.1 (6 months ago) Feb 09 2011 compare
4,467 9.1.0 (11 months ago) Aug 28 2011 compare
28,757 1.0.0 (4 months ago) Oct 08 2011 compare
6,137 1.16.7 (4 months ago) Jul 25 2009 compare
220 1.3.6 (1 year, 5 months ago) Apr 20 2015 compare
1,494 1.0.4 (2 years ago) Nov 22 2014 compare
1,609 2.9.0 (8 months ago) Jun 01 2013 compare
3,973 v7.2.0 (26 days ago) Sep 26 2011 compare
704 Start (6 years ago) Feb 20 2018 compare
14,116 v1.10.0 (3 months ago) Aug 29 2016 compare
744 v1.3.3 (2 months ago) Feb 07 2019 compare
2,186 v1.2.5 (2 years ago) Apr 29 2017 compare
696 v1.3.2 (2 months ago) Jun 08 2019 compare
2,096 v4.4.14 (5 days ago) Oct 26 2013 compare
156 2.2.4 (3 years ago) Dec 22 2019 compare
Was this page helpful?