1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
| Help on class ContentHandler in module xml.sax.handler:
class ContentHandler(builtins.object) | Interface for receiving logical document content events. | | This is the main callback interface in SAX, and the one most | important to applications. The order of events in this interface | mirrors the order of the information in the document. | | Methods defined here: | | __init__(self) | Initialize self. See help(type(self)) for accurate signature. | | characters(self, content) | Receive notification of character data. | | The Parser will call this method to report each chunk of | character data. SAX parsers may return all contiguous | character data 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. | | 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. | | endElementNS(self, name, qname) | Signals the end of an element in namespace mode. | | The name parameter contains the name of the element type, just | as with the startElementNS 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. | | 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. | | startElementNS(self, name, qname, attrs) | Signals the start of an element in namespace mode. | | The name parameter contains the name of the element type as a | (uri, localname) tuple, the qname parameter the raw XML 1.0 | name used in the source document, and the attrs parameter | holds an instance of the Attributes class containing the | attributes of the element. | | The uri part of the name tuple is None for elements which have | no namespace. | | 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. | | ----------------------------------------------------------------------
|