| | |
- __builtin__.object
-
- web.xparse._elemMap
-
- web.xparse.__init__
- web.xparse.ElemInfo
- web.xparse.Element
- xml.sax.handler.ContentHandler
-
- web.xparse.XParseHandler
ElemHandler = class _elemMap(__builtin__.object) |
| | |
Methods defined here:
- characters(self, data)
- Called to handle raw character content. Derived classes may override
this to capture character data, base class implementation does
nothing.
- default(self, info)
- Called when a nested element is found that does not match any
elements defined for the handler. Derived classes may override this,
base class implementation does nothing.
- end(self, info)
- Called when the end tag of the current element is parsed. Base class
implementation pops the handler.
parms:
info::
[@ElemInfo]
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __metaclass__ = <class 'web.xparse._NameMapper'>
- This is the metaclass for @ElemHandler. It iterates over the @Element
definitions in the class body and uses them to construct a dictionary.
|
class Element |
| |
This is meant to be used as a method decorator to define a mapping from
an XML element to a method.
Both or either of the namespace URI and the element name may be omitted
- in this case the method name is used as the element name and the
default namespace is used.
Example:
{{
@Element('http://www.mindhog.net/schemas/example.xml', 'elem-name')
def elemName(self, elemInfo):
...
}}
|
| |
Methods defined here:
- __call__(self, method)
- __init__(self, uri=None, name=None)
- getKey(self)
|
SimpleContentCollector = class __init__(_elemMap) |
| |
Collects the element character content and passes it to a function.
Element contents must consist of character content only - if nested
elements are discovered, a ValueError will be raised.
|
| |
- Method resolution order:
- __init__
- _elemMap
- __builtin__.object
Methods defined here:
- __init__(self, callback)
- parms:
callback::
[callable<string>] function that accepts a string as input.
Used to feedback the contents of the element.
- characters(self, data)
- default(self, info)
- Overrides @ElemHandler.default() to always raise a @ValueError when a
nested element is discovered.
- end(self, info)
Data descriptors inherited from _elemMap:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _elemMap:
- __metaclass__ = <class 'web.xparse._NameMapper'>
- This is the metaclass for @ElemHandler. It iterates over the @Element
definitions in the class body and uses them to construct a dictionary.
|
class XParseHandler(xml.sax.handler.ContentHandler) |
| |
A content handler that keeps a stack tracking the nested elements in a
document and calls methods in the currently defined @ElemHandler.
This class basically serves as an adapter between SAX and the
ElemHandler interface.
|
| |
Methods defined here:
- __init__(self, topHandler)
- characters(self, data)
- endElementNS(self, name, qname)
- setHandler(self, handler)
- Sets the handler for the current element and all nested elements
until another handler is defined. When the element's end tag is
parsed, the handlers "end()" method will be called.
- startElementNS(self, name, qname, attrs)
Data and other attributes defined here:
- ElemFrame = <class web.xparse.ElemFrame at 0x828c80c>
- A stack frame corresponding to an element.
Methods inherited from xml.sax.handler.ContentHandler:
- endDocument(self)
- Receive notification of the end of a document.
The SAX parser will invoke this method only once, and it will
be the last method invoked during the parse. The parser shall
not invoke this method until it has either abandoned parsing
(because of an unrecoverable error) or reached the end of
input.
- endElement(self, name)
- Signals the end of an element in non-namespace mode.
The name parameter contains the name of the element type, just
as with the startElement event.
- endPrefixMapping(self, prefix)
- End the scope of a prefix-URI mapping.
See startPrefixMapping for details. This event will always
occur after the corresponding endElement event, but the order
of endPrefixMapping events is not otherwise guaranteed.
- ignorableWhitespace(self, whitespace)
- Receive notification of ignorable whitespace in element content.
Validating Parsers must use this method to report each chunk
of ignorable whitespace (see the W3C XML 1.0 recommendation,
section 2.10): non-validating parsers may also use this method
if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single
chunk, or they may split it into several chunks; however, all
of the characters in any single event must come from the same
external entity, so that the Locator provides useful
information.
The application must not attempt to read from the array
outside of the specified range.
- processingInstruction(self, target, data)
- Receive notification of a processing instruction.
The Parser will invoke this method once for each processing
instruction found: note that processing instructions may occur
before or after the main document element.
A SAX parser should never report an XML declaration (XML 1.0,
section 2.8) or a text declaration (XML 1.0, section 4.3.1)
using this method.
- setDocumentLocator(self, locator)
- Called by the parser to give the application a locator for
locating the origin of document events.
SAX parsers are strongly encouraged (though not absolutely
required) to supply a locator: if it does so, it must supply
the locator to the application by invoking this method before
invoking any of the other methods in the DocumentHandler
interface.
The locator allows the application to determine the end
position of any document-related event, even if the parser is
not reporting an error. Typically, the application will use
this information for reporting its own errors (such as
character content that does not match an application's
business rules). The information returned by the locator is
probably not sufficient for use with a search engine.
Note that the locator will return correct information only
during the invocation of the events in this interface. The
application should not attempt to use it at any other time.
- skippedEntity(self, name)
- Receive notification of a skipped entity.
The Parser will invoke this method once for each entity
skipped. Non-validating processors may skip entities if they
have not seen the declarations (because, for example, the
entity was declared in an external DTD subset). All processors
may skip external entities, depending on the values of the
http://xml.org/sax/features/external-general-entities and the
http://xml.org/sax/features/external-parameter-entities
properties.
- startDocument(self)
- Receive notification of the beginning of a document.
The SAX parser will invoke this method only once, before any
other methods in this interface or in DTDHandler (except for
setDocumentLocator).
- startElement(self, name, attrs)
- Signals the start of an element in non-namespace mode.
The name parameter contains the raw XML 1.0 name of the
element type as a string and the attrs parameter holds an
instance of the Attributes class containing the attributes of
the element.
- startPrefixMapping(self, prefix, uri)
- Begin the scope of a prefix-URI Namespace mapping.
The information from this event is not necessary for normal
Namespace processing: the SAX XML reader will automatically
replace prefixes for element and attribute names when the
http://xml.org/sax/features/namespaces feature is true (the
default).
There are cases, however, when applications need to use
prefixes in character data or in attribute values, where they
cannot safely be expanded automatically; the
start/endPrefixMapping event supplies the information to the
application to expand prefixes in those contexts itself, if
necessary.
Note that start/endPrefixMapping events are not guaranteed to
be properly nested relative to each-other: all
startPrefixMapping events will occur before the corresponding
startElement event, and all endPrefixMapping events will occur
after the corresponding endElement event, but their order is
not guaranteed.
| |