BeautifulSoup::BeautifulStoneSoup Class Reference

Inheritance diagram for BeautifulSoup::BeautifulStoneSoup:

List of all members.

Public Member Functions
def	__init__
def	__init__
def	endData
def	endData
def	extractCharsetFromMeta
def	extractCharsetFromMeta
def	handle_data
def	handle_data
def	isSelfClosingTag
def	isSelfClosingTag
def	popTag
def	popTag
def	pushTag
def	pushTag
def	reset
def	reset
def	unknown_endtag
def	unknown_endtag
def	unknown_starttag
def	unknown_starttag
Public Attributes
	builder
	convertEntities
	convertHTMLEntities
	convertXMLEntities
	currentData
	currentTag
	declaredHTMLEncoding
	escapeUnrecognizedEntities
	fromEncoding
	hidden
	instanceSelfClosingTags
	literal
	markup
	markupMassage
	originalEncoding
	parseOnlyThese
	previous
	quoteStack
	smartQuotesTo
	tagStack
Static Public Attributes
	ALL_ENTITIES = XHTML_ENTITIES
string	HTML_ENTITIES = "html"
list	MARKUP_MASSAGE
dictionary	NESTABLE_TAGS = {}
list	PRESERVE_WHITESPACE_TAGS = []
dictionary	QUOTE_TAGS = {}
dictionary	RESET_NESTING_TAGS = {}
string	ROOT_TAG_NAME = u'[document]'
dictionary	SELF_CLOSING_TAGS = {}
dictionary	STRIP_ASCII_SPACES = { 9: None, 10: None, 12: None, 13: None, 32: None, }
string	XHTML_ENTITIES = "xhtml"
string	XML_ENTITIES = "xml"
Private Member Functions
def	_feed
def	_feed
def	_popToTag
def	_popToTag
def	_smartPop
def	_smartPop

---

Detailed Description

This class contains the basic parser and search code. It defines
a parser that knows nothing about tag behavior except for the
following:

  You can't close a tag without closing all the tags it encloses.
  That is, "<foo><bar></foo>" actually means
  "<foo><bar></bar></foo>".

[Another possible explanation is "<foo><bar /></foo>", but since
this class defines no SELF_CLOSING_TAGS, it will never use that
explanation.]

This class is useful for parsing XML or made-up markup languages,
or when BeautifulSoup makes an assumption counter to what you were
expecting.

Definition at line 1120 of file BeautifulSoup.py.

---

Constructor & Destructor Documentation

def BeautifulSoup::BeautifulStoneSoup::__init__	(		self,
			markup = "",
			parseOnlyThese = None,
			fromEncoding = None,
			markupMassage = True,
			smartQuotesTo = XML_ENTITIES,
			convertEntities = None,
			selfClosingTags = None,
			isHTML = False,
			builder = HTMLParserBuilder
	)

The Soup object is initialized as the 'root tag', and the
provided markup (which can be a string or a file-like object)
is fed into the underlying parser.

HTMLParser will process most bad HTML, and the BeautifulSoup
class has some tricks for dealing with some HTML that kills
HTMLParser, but Beautiful Soup can nonetheless choke or lose data
if your data uses self-closing tags or declarations
incorrectly.

By default, Beautiful Soup uses regexes to sanitize input,
avoiding the vast majority of these problems. If the problems
don't apply to you, pass in False for markupMassage, and
you'll get better performance.

The default parser massage techniques fix the two most common
instances of invalid HTML that choke HTMLParser:

 <br/> (No space between name of closing tag and tag close)
 <! --Comment--> (Extraneous whitespace in declaration)

You can pass in a custom list of (RE object, replace method)
tuples to get Beautiful Soup to scrub your input the way you
want.

Definition at line 1164 of file BeautifulSoup.py.

                                           :
        """The Soup object is initialized as the 'root tag', and the
        provided markup (which can be a string or a file-like object)
        is fed into the underlying parser.

        HTMLParser will process most bad HTML, and the BeautifulSoup
        class has some tricks for dealing with some HTML that kills
        HTMLParser, but Beautiful Soup can nonetheless choke or lose data
        if your data uses self-closing tags or declarations
        incorrectly.

        By default, Beautiful Soup uses regexes to sanitize input,
        avoiding the vast majority of these problems. If the problems
        don't apply to you, pass in False for markupMassage, and
        you'll get better performance.

        The default parser massage techniques fix the two most common
        instances of invalid HTML that choke HTMLParser:

         <br/> (No space between name of closing tag and tag close)
         <! --Comment--> (Extraneous whitespace in declaration)

        You can pass in a custom list of (RE object, replace method)
        tuples to get Beautiful Soup to scrub your input the way you
        want."""

        self.parseOnlyThese = parseOnlyThese
        self.fromEncoding = fromEncoding
        self.smartQuotesTo = smartQuotesTo
        self.convertEntities = convertEntities
        # Set the rules for how we'll deal with the entities we
        # encounter
        if self.convertEntities:
            # It doesn't make sense to convert encoded characters to
            # entities even while you're converting entities to Unicode.
            # Just convert it all to Unicode.
            self.smartQuotesTo = None
            if convertEntities == self.HTML_ENTITIES:
                self.convertXMLEntities = False
                self.convertHTMLEntities = True
                self.escapeUnrecognizedEntities = True
            elif convertEntities == self.XHTML_ENTITIES:
                self.convertXMLEntities = True
                self.convertHTMLEntities = True
                self.escapeUnrecognizedEntities = False
            elif convertEntities == self.XML_ENTITIES:
                self.convertXMLEntities = True
                self.convertHTMLEntities = False
                self.escapeUnrecognizedEntities = False
        else:
            self.convertXMLEntities = False
            self.convertHTMLEntities = False
            self.escapeUnrecognizedEntities = False

        self.instanceSelfClosingTags = buildTagMap(None, selfClosingTags)
        self.builder = builder(self)
        self.reset()

        if hasattr(markup, 'read'):        # It's a file-type object.
            markup = markup.read()
        self.markup = markup
        self.markupMassage = markupMassage
        try:
            self._feed(isHTML=isHTML)
        except StopParsing:
            pass
        self.markup = None                 # The markup can now be GCed.
        self.builder = None                # So can the builder.

def BeautifulSoup::BeautifulStoneSoup::__init__	(		self,
			markup = "",
			parseOnlyThese = None,
			fromEncoding = None,
			markupMassage = True,
			smartQuotesTo = XML_ENTITIES,
			convertEntities = None,
			selfClosingTags = None,
			isHTML = False,
			builder = HTMLParserBuilder
	)

The Soup object is initialized as the 'root tag', and the
provided markup (which can be a string or a file-like object)
is fed into the underlying parser.

HTMLParser will process most bad HTML, and the BeautifulSoup
class has some tricks for dealing with some HTML that kills
HTMLParser, but Beautiful Soup can nonetheless choke or lose data
if your data uses self-closing tags or declarations
incorrectly.

By default, Beautiful Soup uses regexes to sanitize input,
avoiding the vast majority of these problems. If the problems
don't apply to you, pass in False for markupMassage, and
you'll get better performance.

The default parser massage techniques fix the two most common
instances of invalid HTML that choke HTMLParser:

 <br/> (No space between name of closing tag and tag close)
 <! --Comment--> (Extraneous whitespace in declaration)

You can pass in a custom list of (RE object, replace method)
tuples to get Beautiful Soup to scrub your input the way you
want.

Definition at line 1164 of file BeautifulSoup.py.

                                           :
        """The Soup object is initialized as the 'root tag', and the
        provided markup (which can be a string or a file-like object)
        is fed into the underlying parser.

        HTMLParser will process most bad HTML, and the BeautifulSoup
        class has some tricks for dealing with some HTML that kills
        HTMLParser, but Beautiful Soup can nonetheless choke or lose data
        if your data uses self-closing tags or declarations
        incorrectly.

        By default, Beautiful Soup uses regexes to sanitize input,
        avoiding the vast majority of these problems. If the problems
        don't apply to you, pass in False for markupMassage, and
        you'll get better performance.

        The default parser massage techniques fix the two most common
        instances of invalid HTML that choke HTMLParser:

         <br/> (No space between name of closing tag and tag close)
         <! --Comment--> (Extraneous whitespace in declaration)

        You can pass in a custom list of (RE object, replace method)
        tuples to get Beautiful Soup to scrub your input the way you
        want."""

        self.parseOnlyThese = parseOnlyThese
        self.fromEncoding = fromEncoding
        self.smartQuotesTo = smartQuotesTo
        self.convertEntities = convertEntities
        # Set the rules for how we'll deal with the entities we
        # encounter
        if self.convertEntities:
            # It doesn't make sense to convert encoded characters to
            # entities even while you're converting entities to Unicode.
            # Just convert it all to Unicode.
            self.smartQuotesTo = None
            if convertEntities == self.HTML_ENTITIES:
                self.convertXMLEntities = False
                self.convertHTMLEntities = True
                self.escapeUnrecognizedEntities = True
            elif convertEntities == self.XHTML_ENTITIES:
                self.convertXMLEntities = True
                self.convertHTMLEntities = True
                self.escapeUnrecognizedEntities = False
            elif convertEntities == self.XML_ENTITIES:
                self.convertXMLEntities = True
                self.convertHTMLEntities = False
                self.escapeUnrecognizedEntities = False
        else:
            self.convertXMLEntities = False
            self.convertHTMLEntities = False
            self.escapeUnrecognizedEntities = False

        self.instanceSelfClosingTags = buildTagMap(None, selfClosingTags)
        self.builder = builder(self)
        self.reset()

        if hasattr(markup, 'read'):        # It's a file-type object.
            markup = markup.read()
        self.markup = markup
        self.markupMassage = markupMassage
        try:
            self._feed(isHTML=isHTML)
        except StopParsing:
            pass
        self.markup = None                 # The markup can now be GCed.
        self.builder = None                # So can the builder.

---

Member Function Documentation

def BeautifulSoup::BeautifulStoneSoup::_feed	(		self,
			inDocumentEncoding = None,
			isHTML = False
	)		[private]

Definition at line 1236 of file BeautifulSoup.py.

                                                          :
        # Convert the document to Unicode.
        markup = self.markup
        if isinstance(markup, unicode):
            if not hasattr(self, 'originalEncoding'):
                self.originalEncoding = None
        else:
            dammit = UnicodeDammit\
                     (markup, [self.fromEncoding, inDocumentEncoding],
                      smartQuotesTo=self.smartQuotesTo, isHTML=isHTML)
            markup = dammit.unicode
            self.originalEncoding = dammit.originalEncoding
            self.declaredHTMLEncoding = dammit.declaredHTMLEncoding
        if markup:
            if self.markupMassage:
                if not isList(self.markupMassage):
                    self.markupMassage = self.MARKUP_MASSAGE
                for fix, m in self.markupMassage:
                    markup = fix.sub(m, markup)
                # TODO: We get rid of markupMassage so that the
                # soup object can be deepcopied later on. Some
                # Python installations can't copy regexes. If anyone
                # was relying on the existence of markupMassage, this
                # might cause problems.
                del(self.markupMassage)
        self.builder.reset()

        self.builder.feed(markup)
        # Close out any unfinished strings and close all the open tags.
        self.endData()
        while self.currentTag.name != self.ROOT_TAG_NAME:
            self.popTag()

def BeautifulSoup::BeautifulStoneSoup::_feed	(		self,
			inDocumentEncoding = None,
			isHTML = False
	)		[private]

Definition at line 1236 of file BeautifulSoup.py.

                                                          :
        # Convert the document to Unicode.
        markup = self.markup
        if isinstance(markup, unicode):
            if not hasattr(self, 'originalEncoding'):
                self.originalEncoding = None
        else:
            dammit = UnicodeDammit\
                     (markup, [self.fromEncoding, inDocumentEncoding],
                      smartQuotesTo=self.smartQuotesTo, isHTML=isHTML)
            markup = dammit.unicode
            self.originalEncoding = dammit.originalEncoding
            self.declaredHTMLEncoding = dammit.declaredHTMLEncoding
        if markup:
            if self.markupMassage:
                if not isList(self.markupMassage):
                    self.markupMassage = self.MARKUP_MASSAGE
                for fix, m in self.markupMassage:
                    markup = fix.sub(m, markup)
                # TODO: We get rid of markupMassage so that the
                # soup object can be deepcopied later on. Some
                # Python installations can't copy regexes. If anyone
                # was relying on the existence of markupMassage, this
                # might cause problems.
                del(self.markupMassage)
        self.builder.reset()

        self.builder.feed(markup)
        # Close out any unfinished strings and close all the open tags.
        self.endData()
        while self.currentTag.name != self.ROOT_TAG_NAME:
            self.popTag()

def BeautifulSoup::BeautifulStoneSoup::_popToTag	(		self,
			name,
			inclusivePop = True
	)		[private]

Pops the tag stack up to and including the most recent
instance of the given tag. If inclusivePop is false, pops the tag
stack up to but *not* including the most recent instqance of
the given tag.

Definition at line 1329 of file BeautifulSoup.py.

                                                :
        """Pops the tag stack up to and including the most recent
        instance of the given tag. If inclusivePop is false, pops the tag
        stack up to but *not* including the most recent instqance of
        the given tag."""
        #print "Popping to %s" % name
        if name == self.ROOT_TAG_NAME:
            return

        numPops = 0
        mostRecentTag = None
        for i in range(len(self.tagStack)-1, 0, -1):
            if name == self.tagStack[i].name:
                numPops = len(self.tagStack)-i
                break
        if not inclusivePop:
            numPops = numPops - 1

        for i in range(0, numPops):
            mostRecentTag = self.popTag()
        return mostRecentTag

def BeautifulSoup::BeautifulStoneSoup::_popToTag	(		self,
			name,
			inclusivePop = True
	)		[private]

Pops the tag stack up to and including the most recent
instance of the given tag. If inclusivePop is false, pops the tag
stack up to but *not* including the most recent instqance of
the given tag.

Definition at line 1329 of file BeautifulSoup.py.

                                                :
        """Pops the tag stack up to and including the most recent
        instance of the given tag. If inclusivePop is false, pops the tag
        stack up to but *not* including the most recent instqance of
        the given tag."""
        #print "Popping to %s" % name
        if name == self.ROOT_TAG_NAME:
            return

        numPops = 0
        mostRecentTag = None
        for i in range(len(self.tagStack)-1, 0, -1):
            if name == self.tagStack[i].name:
                numPops = len(self.tagStack)-i
                break
        if not inclusivePop:
            numPops = numPops - 1

        for i in range(0, numPops):
            mostRecentTag = self.popTag()
        return mostRecentTag

def BeautifulSoup::BeautifulStoneSoup::_smartPop	(		self,
			name
	)		[private]

We need to pop up to the previous tag of this type, unless
one of this tag's nesting reset triggers comes between this
tag and the previous tag of this type, OR unless this tag is a
generic nesting trigger and another generic nesting trigger
comes between this tag and the previous tag of this type.

Examples:
 <p>Foo<b>Bar *<p>* should pop to 'p', not 'b'.
 <p>Foo<table>Bar *<p>* should pop to 'table', not 'p'.
 <p>Foo<table><tr>Bar *<p>* should pop to 'tr', not 'p'.

 <li><ul><li> *<li>* should pop to 'ul', not the first 'li'.
 <tr><table><tr> *<tr>* should pop to 'table', not the first 'tr'
 <td><tr><td> *<td>* should pop to 'tr', not the first 'td'

Definition at line 1351 of file BeautifulSoup.py.

                             :

        """We need to pop up to the previous tag of this type, unless
        one of this tag's nesting reset triggers comes between this
        tag and the previous tag of this type, OR unless this tag is a
        generic nesting trigger and another generic nesting trigger
        comes between this tag and the previous tag of this type.

        Examples:
         <p>Foo<b>Bar *<p>* should pop to 'p', not 'b'.
         <p>Foo<table>Bar *<p>* should pop to 'table', not 'p'.
         <p>Foo<table><tr>Bar *<p>* should pop to 'tr', not 'p'.

         <li><ul><li> *<li>* should pop to 'ul', not the first 'li'.
         <tr><table><tr> *<tr>* should pop to 'table', not the first 'tr'
         <td><tr><td> *<td>* should pop to 'tr', not the first 'td'
        """

        nestingResetTriggers = self.NESTABLE_TAGS.get(name)
        isNestable = nestingResetTriggers != None
        isResetNesting = self.RESET_NESTING_TAGS.has_key(name)
        popTo = None
        inclusive = True
        for i in range(len(self.tagStack)-1, 0, -1):
            p = self.tagStack[i]
            if (not p or p.name == name) and not isNestable:
                #Non-nestable tags get popped to the top or to their
                #last occurance.
                popTo = name
                break
            if (nestingResetTriggers != None
                and p.name in nestingResetTriggers) \
                or (nestingResetTriggers == None and isResetNesting
                    and self.RESET_NESTING_TAGS.has_key(p.name)):

                #If we encounter one of the nesting reset triggers
                #peculiar to this tag, or we encounter another tag
                #that causes nesting to reset, pop up to but not
                #including that tag.
                popTo = p.name
                inclusive = False
                break
            p = p.parent
        if popTo:
            self._popToTag(popTo, inclusive)

def BeautifulSoup::BeautifulStoneSoup::_smartPop	(		self,
			name
	)		[private]

We need to pop up to the previous tag of this type, unless
one of this tag's nesting reset triggers comes between this
tag and the previous tag of this type, OR unless this tag is a
generic nesting trigger and another generic nesting trigger
comes between this tag and the previous tag of this type.

Examples:
 <p>Foo<b>Bar *<p>* should pop to 'p', not 'b'.
 <p>Foo<table>Bar *<p>* should pop to 'table', not 'p'.
 <p>Foo<table><tr>Bar *<p>* should pop to 'tr', not 'p'.

 <li><ul><li> *<li>* should pop to 'ul', not the first 'li'.
 <tr><table><tr> *<tr>* should pop to 'table', not the first 'tr'
 <td><tr><td> *<td>* should pop to 'tr', not the first 'td'

Definition at line 1351 of file BeautifulSoup.py.

                             :

        """We need to pop up to the previous tag of this type, unless
        one of this tag's nesting reset triggers comes between this
        tag and the previous tag of this type, OR unless this tag is a
        generic nesting trigger and another generic nesting trigger
        comes between this tag and the previous tag of this type.

        Examples:
         <p>Foo<b>Bar *<p>* should pop to 'p', not 'b'.
         <p>Foo<table>Bar *<p>* should pop to 'table', not 'p'.
         <p>Foo<table><tr>Bar *<p>* should pop to 'tr', not 'p'.

         <li><ul><li> *<li>* should pop to 'ul', not the first 'li'.
         <tr><table><tr> *<tr>* should pop to 'table', not the first 'tr'
         <td><tr><td> *<td>* should pop to 'tr', not the first 'td'
        """

        nestingResetTriggers = self.NESTABLE_TAGS.get(name)
        isNestable = nestingResetTriggers != None
        isResetNesting = self.RESET_NESTING_TAGS.has_key(name)
        popTo = None
        inclusive = True
        for i in range(len(self.tagStack)-1, 0, -1):
            p = self.tagStack[i]
            if (not p or p.name == name) and not isNestable:
                #Non-nestable tags get popped to the top or to their
                #last occurance.
                popTo = name
                break
            if (nestingResetTriggers != None
                and p.name in nestingResetTriggers) \
                or (nestingResetTriggers == None and isResetNesting
                    and self.RESET_NESTING_TAGS.has_key(p.name)):

                #If we encounter one of the nesting reset triggers
                #peculiar to this tag, or we encounter another tag
                #that causes nesting to reset, pop up to but not
                #including that tag.
                popTo = p.name
                inclusive = False
                break
            p = p.parent
        if popTo:
            self._popToTag(popTo, inclusive)

def BeautifulSoup::BeautifulStoneSoup::endData	(		self,
			containerClass = NavigableString
	)

Definition at line 1306 of file BeautifulSoup.py.

                                                     :
        if self.currentData:
            currentData = u''.join(self.currentData)
            if (currentData.translate(self.STRIP_ASCII_SPACES) == '' and
                not set([tag.name for tag in self.tagStack]).intersection(
                    self.PRESERVE_WHITESPACE_TAGS)):
                if '\n' in currentData:
                    currentData = '\n'
                else:
                    currentData = ' '
            self.currentData = []
            if self.parseOnlyThese and len(self.tagStack) <= 1 and \
                   (not self.parseOnlyThese.text or \
                    not self.parseOnlyThese.search(currentData)):
                return
            o = containerClass(currentData)
            o.setup(self.currentTag, self.previous)
            if self.previous:
                self.previous.next = o
            self.previous = o
            self.currentTag.contents.append(o)

def BeautifulSoup::BeautifulStoneSoup::endData	(		self,
			containerClass = NavigableString
	)

Definition at line 1306 of file BeautifulSoup.py.

                                                     :
        if self.currentData:
            currentData = u''.join(self.currentData)
            if (currentData.translate(self.STRIP_ASCII_SPACES) == '' and
                not set([tag.name for tag in self.tagStack]).intersection(
                    self.PRESERVE_WHITESPACE_TAGS)):
                if '\n' in currentData:
                    currentData = '\n'
                else:
                    currentData = ' '
            self.currentData = []
            if self.parseOnlyThese and len(self.tagStack) <= 1 and \
                   (not self.parseOnlyThese.text or \
                    not self.parseOnlyThese.search(currentData)):
                return
            o = containerClass(currentData)
            o.setup(self.currentTag, self.previous)
            if self.previous:
                self.previous.next = o
            self.previous = o
            self.currentTag.contents.append(o)

def BeautifulSoup::BeautifulStoneSoup::extractCharsetFromMeta	(		self,
			attrs
	)

Reimplemented in BeautifulSoup::BeautifulSoup, and BeautifulSoup::BeautifulSoup.

Definition at line 1443 of file BeautifulSoup.py.

                                           :
        self.unknown_starttag('meta', attrs)

def BeautifulSoup::BeautifulStoneSoup::extractCharsetFromMeta	(		self,
			attrs
	)

Reimplemented in BeautifulSoup::BeautifulSoup, and BeautifulSoup::BeautifulSoup.

Definition at line 1443 of file BeautifulSoup.py.

                                           :
        self.unknown_starttag('meta', attrs)

def BeautifulSoup::BeautifulStoneSoup::handle_data	(		self,
			data
	)

Definition at line 1440 of file BeautifulSoup.py.

                               :
        self.currentData.append(data)

def BeautifulSoup::BeautifulStoneSoup::handle_data	(		self,
			data
	)

Definition at line 1440 of file BeautifulSoup.py.

                               :
        self.currentData.append(data)

def BeautifulSoup::BeautifulStoneSoup::isSelfClosingTag	(		self,
			name
	)

Returns true iff the given string is the name of a
self-closing tag according to this parser.

Definition at line 1269 of file BeautifulSoup.py.

                                    :
        """Returns true iff the given string is the name of a
        self-closing tag according to this parser."""
        return self.SELF_CLOSING_TAGS.has_key(name) \
               or self.instanceSelfClosingTags.has_key(name)

def BeautifulSoup::BeautifulStoneSoup::isSelfClosingTag	(		self,
			name
	)

Returns true iff the given string is the name of a
self-closing tag according to this parser.

Definition at line 1269 of file BeautifulSoup.py.

                                    :
        """Returns true iff the given string is the name of a
        self-closing tag according to this parser."""
        return self.SELF_CLOSING_TAGS.has_key(name) \
               or self.instanceSelfClosingTags.has_key(name)

def BeautifulSoup::BeautifulStoneSoup::popTag

(

self

)

Reimplemented in BeautifulSoup::BeautifulSOAP, and BeautifulSoup::BeautifulSOAP.

Definition at line 1285 of file BeautifulSoup.py.

                    :
        tag = self.tagStack.pop()
        # Tags with just one string-owning child get the child as a
        # 'string' property, so that soup.tag.string is shorthand for
        # soup.tag.contents[0]
        if len(self.currentTag.contents) == 1 and \
           isinstance(self.currentTag.contents[0], NavigableString):
            self.currentTag.string = self.currentTag.contents[0]

        #print "Pop", tag.name
        if self.tagStack:
            self.currentTag = self.tagStack[-1]
        return self.currentTag

def BeautifulSoup::BeautifulStoneSoup::popTag

(

self

)

Reimplemented in BeautifulSoup::BeautifulSOAP, and BeautifulSoup::BeautifulSOAP.

Definition at line 1285 of file BeautifulSoup.py.

                    :
        tag = self.tagStack.pop()
        # Tags with just one string-owning child get the child as a
        # 'string' property, so that soup.tag.string is shorthand for
        # soup.tag.contents[0]
        if len(self.currentTag.contents) == 1 and \
           isinstance(self.currentTag.contents[0], NavigableString):
            self.currentTag.string = self.currentTag.contents[0]

        #print "Pop", tag.name
        if self.tagStack:
            self.currentTag = self.tagStack[-1]
        return self.currentTag

def BeautifulSoup::BeautifulStoneSoup::pushTag	(		self,
			tag
	)

Definition at line 1299 of file BeautifulSoup.py.

                          :
        #print "Push", tag.name
        if self.currentTag:
            self.currentTag.contents.append(tag)
        self.tagStack.append(tag)
        self.currentTag = self.tagStack[-1]

def BeautifulSoup::BeautifulStoneSoup::pushTag	(		self,
			tag
	)

Definition at line 1299 of file BeautifulSoup.py.

                          :
        #print "Push", tag.name
        if self.currentTag:
            self.currentTag.contents.append(tag)
        self.tagStack.append(tag)
        self.currentTag = self.tagStack[-1]

def BeautifulSoup::BeautifulStoneSoup::reset

(

self

)

Definition at line 1275 of file BeautifulSoup.py.

                   :
        Tag.__init__(self, self, self.ROOT_TAG_NAME)
        self.hidden = 1
        self.builder.reset()
        self.currentData = []
        self.currentTag = None
        self.tagStack = []
        self.quoteStack = []
        self.pushTag(self)

def BeautifulSoup::BeautifulStoneSoup::reset

(

self

)

Definition at line 1275 of file BeautifulSoup.py.

                   :
        Tag.__init__(self, self, self.ROOT_TAG_NAME)
        self.hidden = 1
        self.builder.reset()
        self.currentData = []
        self.currentTag = None
        self.tagStack = []
        self.quoteStack = []
        self.pushTag(self)

def BeautifulSoup::BeautifulStoneSoup::unknown_endtag	(		self,
			name
	)

Definition at line 1427 of file BeautifulSoup.py.

                                  :
        #print "End tag %s" % name
        if self.quoteStack and self.quoteStack[-1] != name:
            #This is not a real end tag.
            #print "</%s> is not real!" % name
            self.handle_data('</%s>' % name)
            return
        self.endData()
        self._popToTag(name)
        if self.quoteStack and self.quoteStack[-1] == name:
            self.quoteStack.pop()
            self.literal = (len(self.quoteStack) > 0)

def BeautifulSoup::BeautifulStoneSoup::unknown_endtag	(		self,
			name
	)

Definition at line 1427 of file BeautifulSoup.py.

                                  :
        #print "End tag %s" % name
        if self.quoteStack and self.quoteStack[-1] != name:
            #This is not a real end tag.
            #print "</%s> is not real!" % name
            self.handle_data('</%s>' % name)
            return
        self.endData()
        self._popToTag(name)
        if self.quoteStack and self.quoteStack[-1] == name:
            self.quoteStack.pop()
            self.literal = (len(self.quoteStack) > 0)

def BeautifulSoup::BeautifulStoneSoup::unknown_starttag	(		self,
			name,
			attrs,
			selfClosing = 0
	)

Definition at line 1397 of file BeautifulSoup.py.

                                                          :
        #print "Start tag %s: %s" % (name, attrs)
        if self.quoteStack:
            #This is not a real tag.
            #print "<%s> is not real!" % name
            attrs = ''.join(map(lambda(x, y): ' %s="%s"' % (x, y), attrs))
            self.handle_data('<%s%s>' % (name, attrs))
            return
        self.endData()

        if not self.isSelfClosingTag(name) and not selfClosing:
            self._smartPop(name)

        if self.parseOnlyThese and len(self.tagStack) <= 1 \
               and (self.parseOnlyThese.text or not self.parseOnlyThese.searchTag(name, attrs)):
            return

        tag = Tag(self, name, attrs, self.currentTag, self.previous)
        if self.previous:
            self.previous.next = tag
        self.previous = tag
        self.pushTag(tag)
        if selfClosing or self.isSelfClosingTag(name):
            self.popTag()
        if name in self.QUOTE_TAGS:
            #print "Beginning quote (%s)" % name
            self.quoteStack.append(name)
            self.literal = 1
        return tag

def BeautifulSoup::BeautifulStoneSoup::unknown_starttag	(		self,
			name,
			attrs,
			selfClosing = 0
	)

Definition at line 1397 of file BeautifulSoup.py.

                                                          :
        #print "Start tag %s: %s" % (name, attrs)
        if self.quoteStack:
            #This is not a real tag.
            #print "<%s> is not real!" % name
            attrs = ''.join(map(lambda(x, y): ' %s="%s"' % (x, y), attrs))
            self.handle_data('<%s%s>' % (name, attrs))
            return
        self.endData()

        if not self.isSelfClosingTag(name) and not selfClosing:
            self._smartPop(name)

        if self.parseOnlyThese and len(self.tagStack) <= 1 \
               and (self.parseOnlyThese.text or not self.parseOnlyThese.searchTag(name, attrs)):
            return

        tag = Tag(self, name, attrs, self.currentTag, self.previous)
        if self.previous:
            self.previous.next = tag
        self.previous = tag
        self.pushTag(tag)
        if selfClosing or self.isSelfClosingTag(name):
            self.popTag()
        if name in self.QUOTE_TAGS:
            #print "Beginning quote (%s)" % name
            self.quoteStack.append(name)
            self.literal = 1
        return tag

---

Member Data Documentation

BeautifulSoup::BeautifulStoneSoup::ALL_ENTITIES = XHTML_ENTITIES [static]

Definition at line 1156 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::builder

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::convertEntities

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::convertHTMLEntities

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::convertXMLEntities

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::currentData

Definition at line 1275 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::currentTag

Definition at line 1275 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::declaredHTMLEncoding

Reimplemented in BeautifulSoup::BeautifulSoup.

Definition at line 1236 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::escapeUnrecognizedEntities

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::fromEncoding

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::hidden

Definition at line 1275 of file BeautifulSoup.py.

string BeautifulSoup::BeautifulStoneSoup::HTML_ENTITIES = "html" [static]

Definition at line 1152 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::instanceSelfClosingTags

Definition at line 1187 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::literal

Definition at line 1397 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::markup

Definition at line 1187 of file BeautifulSoup.py.

list BeautifulSoup::BeautifulStoneSoup::MARKUP_MASSAGE [static]

Initial value:

[(re.compile('(<[^<>]*)/>'),
                       lambda x: x.group(1) + ' />'),
                      (re.compile('<!\s+([^<>]*)>'),
                       lambda x: '<!' + x.group(1) + '>')
                      ]

Definition at line 1144 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::markupMassage

Definition at line 1187 of file BeautifulSoup.py.

dictionary BeautifulSoup::BeautifulStoneSoup::NESTABLE_TAGS = {} [static]

Reimplemented in BeautifulSoup::BeautifulSoup, BeautifulSoup::ICantBelieveItsBeautifulSoup, and BeautifulSoup::MinimalSoup.

Definition at line 1139 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::originalEncoding

Reimplemented in BeautifulSoup::BeautifulSoup.

Definition at line 1236 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::parseOnlyThese

Definition at line 1187 of file BeautifulSoup.py.

list BeautifulSoup::BeautifulStoneSoup::PRESERVE_WHITESPACE_TAGS = [] [static]

Reimplemented in BeautifulSoup::BeautifulSoup.

Definition at line 1142 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::previous

Reimplemented from BeautifulSoup::PageElement.

Definition at line 1306 of file BeautifulSoup.py.

dictionary BeautifulSoup::BeautifulStoneSoup::QUOTE_TAGS = {} [static]

Reimplemented in BeautifulSoup::BeautifulSoup.

Definition at line 1141 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::quoteStack

Definition at line 1275 of file BeautifulSoup.py.

dictionary BeautifulSoup::BeautifulStoneSoup::RESET_NESTING_TAGS = {} [static]

Reimplemented in BeautifulSoup::BeautifulSoup, and BeautifulSoup::MinimalSoup.

Definition at line 1140 of file BeautifulSoup.py.

string BeautifulSoup::BeautifulStoneSoup::ROOT_TAG_NAME = u'[document]' [static]

Definition at line 1150 of file BeautifulSoup.py.

dictionary BeautifulSoup::BeautifulStoneSoup::SELF_CLOSING_TAGS = {} [static]

Reimplemented in BeautifulSoup::BeautifulSoup.

Definition at line 1138 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::smartQuotesTo

Definition at line 1187 of file BeautifulSoup.py.

dictionary BeautifulSoup::BeautifulStoneSoup::STRIP_ASCII_SPACES = { 9: None, 10: None, 12: None, 13: None, 32: None, } [static]

Definition at line 1162 of file BeautifulSoup.py.

BeautifulSoup::BeautifulStoneSoup::tagStack

Definition at line 1275 of file BeautifulSoup.py.

string BeautifulSoup::BeautifulStoneSoup::XHTML_ENTITIES = "xhtml" [static]

Definition at line 1154 of file BeautifulSoup.py.

string BeautifulSoup::BeautifulStoneSoup::XML_ENTITIES = "xml" [static]

Definition at line 1153 of file BeautifulSoup.py.