CMS 3D CMS Logo

Classes | Functions | Variables
BeautifulSoup Namespace Reference

Classes

class  BeautifulSOAP
 
class  BeautifulSoup
 
class  BeautifulStoneSoup
 
class  CData
 
class  Comment
 
class  Declaration
 
class  ICantBelieveItsBeautifulSoup
 
class  MinimalSoup
 
class  NavigableString
 
class  PageElement
 
class  ProcessingInstruction
 
class  ResultSet
 
class  RobustHTMLParser
 
class  RobustInsanelyWackAssHTMLParser
 
class  RobustWackAssHTMLParser
 
class  RobustXMLParser
 
class  SimplifyingSOAPParser
 
class  SoupStrainer
 
class  StopParsing
 
class  Tag
 
class  UnicodeDammit
 

Functions

def _match_css_class (str)
 
def buildTagMap (default, args)
 

Variables

 __author__
 
 __copyright__
 
 __license__
 
 __version__
 
 _declname_match
 
 chardet
 
 DEFAULT_OUTPUT_ENCODING
 
 name2codepoint
 
 soup
 
 tagfind
 

Detailed Description

Beautiful Soup
Elixir and Tonic
"The Screen-Scraper's Friend"
http://www.crummy.com/software/BeautifulSoup/

Beautiful Soup parses a (possibly invalid) XML or HTML document into a
tree representation. It provides methods and Pythonic idioms that make
it easy to navigate, search, and modify the tree.

A well-formed XML/HTML document yields a well-formed data
structure. An ill-formed XML/HTML document yields a correspondingly
ill-formed data structure. If your document is only locally
well-formed, you can use this library to find and process the
well-formed part of it.

Beautiful Soup works with Python 2.2 and up. It has no external
dependencies, but you'll have more success at converting data to UTF-8
if you also install these three packages:

* chardet, for auto-detecting character encodings
http://chardet.feedparser.org/
* cjkcodecs and iconv_codec, which add more encodings to the ones supported
by stock Python.
http://cjkpython.i18n.org/

Beautiful Soup defines classes for two main parsing strategies:

 * BeautifulStoneSoup, for parsing XML, SGML, or your domain-specific
 language that kind of looks like XML.

 * BeautifulSoup, for parsing run-of-the-mill HTML code, be it valid
 or invalid. This class has web browser-like heuristics for
 obtaining a sensible parse tree in the face of common HTML errors.

Beautiful Soup also defines a class (UnicodeDammit) for autodetecting
the encoding of an HTML or XML document, and converting it to
Unicode. Much of this code is taken from Mark Pilgrim's Universal Feed Parser.

For more than you ever wanted to know about Beautiful Soup, see the
documentation:
http://www.crummy.com/software/BeautifulSoup/documentation.html

Here, have some legalese:

Copyright (c) 2004-2010, Leonard Richardson

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the following
  disclaimer in the documentation and/or other materials provided
  with the distribution.

* Neither the name of the the Beautiful Soup Consortium and All
  Night Kosher Bakery nor the names of its contributors may be
  used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE, DAMMIT.

Function Documentation

◆ _match_css_class()

def BeautifulSoup._match_css_class (   str)
private
Build a RE to match the given CSS class.

Definition at line 107 of file BeautifulSoup.py.

107 def _match_css_class(str):
108  """Build a RE to match the given CSS class."""
109  return re.compile(r"(^|.*\s)%s($|\s)" % str)
110 
111 # First, the classes that represent markup elements.
112 
def _match_css_class(str)

◆ buildTagMap()

def BeautifulSoup.buildTagMap (   default,
  args 
)
Turns a list of maps, lists, or scalars into a single map.
Used to build the SELF_CLOSING_TAGS, NESTABLE_TAGS, and
NESTING_RESET_TAGS maps out of lists and partial maps.

Definition at line 1018 of file BeautifulSoup.py.

1018 def buildTagMap(default, *args):
1019  """Turns a list of maps, lists, or scalars into a single map.
1020  Used to build the SELF_CLOSING_TAGS, NESTABLE_TAGS, and
1021  NESTING_RESET_TAGS maps out of lists and partial maps."""
1022  built = {}
1023  for portion in args:
1024  if hasattr(portion, 'items'):
1025  #It's a map. Merge it.
1026  for k,v in portion.items():
1027  built[k] = v
1028  elif hasattr(portion, '__iter__'): # is a list
1029  #It's a list. Map each item to the default.
1030  for k in portion:
1031  built[k] = default
1032  else:
1033  #It's a scalar. Map it to the default.
1034  built[portion] = default
1035  return built
1036 
1037 # Now, the parser classes.
1038 
def buildTagMap(default, args)

Variable Documentation

◆ __author__

BeautifulSoup.__author__
private

Definition at line 81 of file BeautifulSoup.py.

◆ __copyright__

BeautifulSoup.__copyright__
private

Definition at line 83 of file BeautifulSoup.py.

◆ __license__

BeautifulSoup.__license__
private

Definition at line 84 of file BeautifulSoup.py.

◆ __version__

BeautifulSoup.__version__
private

Definition at line 82 of file BeautifulSoup.py.

◆ _declname_match

BeautifulSoup._declname_match
private

Definition at line 103 of file BeautifulSoup.py.

◆ chardet

BeautifulSoup.chardet

Definition at line 1742 of file BeautifulSoup.py.

◆ DEFAULT_OUTPUT_ENCODING

BeautifulSoup.DEFAULT_OUTPUT_ENCODING

Definition at line 105 of file BeautifulSoup.py.

◆ name2codepoint

BeautifulSoup.name2codepoint

Definition at line 95 of file BeautifulSoup.py.

◆ soup

BeautifulSoup.soup

Definition at line 2016 of file BeautifulSoup.py.

◆ tagfind

BeautifulSoup.tagfind

Definition at line 102 of file BeautifulSoup.py.