Skip to content

beautifulsoup

- - - MIT License
4.12.3 (17 Jan 2024) Jul 26 2019 93.8 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,562 5.2.1 (3 days ago) Dec 13 2022 compare
5,361 0.13.0 (1 year, 10 months ago) Jul 30 2007 compare
1,092 1.1 (3 years ago) Jul 30 2007 compare
281 1.2.0 (1 year, 5 months ago) Apr 14 2012 compare
2,270 2.0.0 (1 year, 3 months ago) Dec 05 2008 compare
1,821 6.0.11 (3 months ago) Jun 15 2007 compare
1,067 1.9.0 (22 days ago) Jul 26 2019 compare
13,558 0.10.0 (5 years ago) Feb 25 2018 compare
663 0.4.12 (4 months ago) Jun 03 2007 compare
608 1.2.1 (1 year, 9 months ago) Jun 09 2011 compare
946 0.3.21 (26 days ago) Mar 01 2018 compare
175 1.2.3 (2 months ago) Jul 30 2007 compare
730 1.1 (3 years ago) Dec 28 2012 compare
22 0.6.0 (11 months ago) Jul 24 2014 compare

Other Languages

3,539 7.1.2 (8 months ago) Jul 03 2013 compare
1,073 1.3.0 (6 months ago) Feb 09 2011 compare
4,263 9.1.0 (2 months ago) Aug 28 2011 compare
27,690 1.0.0-rc.12 (4 months ago) Oct 08 2011 compare
6,097 1.16.3 (21 days ago) Jul 25 2009 compare
1,455 1.0.4 (1 year, 7 months ago) Nov 22 2014 compare
216 1.3.6 (9 months ago) Apr 20 2015 compare
3,892 v7.0.4 (a month ago) Sep 26 2011 compare
1,460 2.9.0 (6 days ago) Jun 01 2013 compare
693 v1.3.0 (1 year, 2 months ago) Feb 07 2019 compare
675 Start (6 years ago) Feb 20 2018 compare
646 (a day ago) Jun 08 2019 compare
13,502 v1.9.1 (a month ago) Aug 29 2016 compare
2,116 v1.2.5 (2 years ago) Apr 29 2017 compare
2,063 v4.4.10 (3 months ago) Oct 26 2013 compare
153 2.2.4 (3 years ago) Dec 22 2019 compare