QXmlSimpleReader¶

The QXmlSimpleReader class provides an implementation of a simple XML parser. More…

Detailed Description¶

This XML reader is suitable for a wide range of applications. It is able to parse well-formed XML and can report the namespaces of elements to a content handler; however, it does not parse any external entities. For historical reasons, Attribute Value Normalization and End-of-Line Handling as described in the XML 1.0 specification is not performed.

The easiest pattern of use for this class is to create a reader instance, define an input source, specify the handlers to be used by the reader, and parse the data.

For example, we could use a QFile to supply the input. Here, we create a reader, and define an input source to be used by the reader:
QXmlSimpleReader xmlReader;
QXmlInputSource *source = new QXmlInputSource(file);
A handler lets us perform actions when the reader encounters certain types of content, or if errors in the input are found. The reader must be told which handler to use for each type of event. For many common applications, we can create a custom handler by subclassing QXmlDefaultHandler , and use this to handle both error and content events:
Handler *handler = new Handler;
xmlReader.setContentHandler(handler);
xmlReader.setErrorHandler(handler);
If you don’t set at least the content and error handlers, the parser will fall back on its default behavior—and will do nothing.

The most convenient way to handle the input is to read it in a single pass using the parse() function with an argument that specifies the input source:
bool ok = xmlReader.parse(source);

if (!ok)
    std::cout << "Parsing failed." << std::endl;
If you can’t parse the entire input in one go (for example, it is huge, or is being delivered over a network connection), data can be fed to the parser in pieces. This is achieved by telling parse() to work incrementally, and making subsequent calls to the parseContinue() function, until all the data has been processed.

A common way to perform incremental parsing is to connect the readyRead() signal of a network reply a slot, and handle the incoming data there. See QNetworkAccessManager .

Aspects of the parsing behavior can be adapted using setFeature() and setProperty() .
xmlReader.setFeature("http://xml.org/sax/features/namespace-prefixes", True)
QXmlSimpleReader is not reentrant. If you want to use the class in threaded code, lock the code using QXmlSimpleReader with a locking mechanism, such as a QMutex .

Note that this class is now deprecated, please use QXmlStreamReader or QDomDocument for reading XML files.

class PySide2.QtXml.QXmlSimpleReader¶: Constructs a simple XML reader.

PySide2.QtXml.QXmlSimpleReader.parse(input, incremental)¶

Parameters:

input – PySide2.QtXml.QXmlInputSource
incremental – bool

Return type:

bool

Reads an XML document from input and parses it. Returns true if the parsing is completed successfully; otherwise returns false , indicating that an error occurred.

If incremental is false, this function will return false if the XML file is not read completely. The parsing cannot be continued in this case.

If incremental is true, the parser does not return false if it reaches the end of the input before reaching the end of the XML file. Instead, it stores the state of the parser so that parsing can be continued later when more data is available. In such a case, you can use the function parseContinue() to continue with parsing. This class stores a pointer to the input source input and the parseContinue() function tries to read from that input source. Therefore, you should not delete the input source input until you no longer need to call parseContinue() .

If this function is called with incremental set to true while an incremental parse is in progress, a new parsing session will be started, and the previous session will be lost.

Table of Contents

Previous topic

Next topic

QXmlSimpleReader¶

Detailed Description¶