CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
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
 
def buildTagMap
 

Variables

string __author__ = "Leonard Richardson (leonardr@segfault.org)"
 
string __copyright__ = "Copyright (c) 2004-2012 Leonard Richardson"
 
string __license__ = "New-style BSD"
 
string __version__ = "3.2.1"
 
 chardet = None
 
string DEFAULT_OUTPUT_ENCODING = "utf-8"
 
dictionary name2codepoint = {}
 
tuple soup = BeautifulSoup(sys.stdin)
 

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

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

Definition at line 107 of file BeautifulSoup.py.

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

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

Variable Documentation

string BeautifulSoup.__author__ = "Leonard Richardson (leonardr@segfault.org)"

Definition at line 81 of file BeautifulSoup.py.

string BeautifulSoup.__copyright__ = "Copyright (c) 2004-2012 Leonard Richardson"

Definition at line 83 of file BeautifulSoup.py.

string BeautifulSoup.__license__ = "New-style BSD"

Definition at line 84 of file BeautifulSoup.py.

string BeautifulSoup.__version__ = "3.2.1"

Definition at line 82 of file BeautifulSoup.py.

BeautifulSoup.chardet = None

Definition at line 1742 of file BeautifulSoup.py.

string BeautifulSoup.DEFAULT_OUTPUT_ENCODING = "utf-8"

Definition at line 105 of file BeautifulSoup.py.

dictionary BeautifulSoup.name2codepoint = {}

Definition at line 95 of file BeautifulSoup.py.

tuple BeautifulSoup.soup = BeautifulSoup(sys.stdin)

Definition at line 2016 of file BeautifulSoup.py.