QXmlSchemaValidator

The QXmlSchemaValidator class validates XML instance documents against a W3C XML Schema. More…

New in version 4.6.

Synopsis

Functions

• def messageHandler ()

• def namePool ()

• def networkAccessManager ()

• def schema ()

• def setMessageHandler (handler)

• def setNetworkAccessManager (networkmanager)

• def setSchema (schema)

• def setUriResolver (resolver)

• def uriResolver ()

• def validate (data[, documentUri=QUrl()])

• def validate (source)

• def validate (source[, documentUri=QUrl()])

Detailed Description

The QXmlSchemaValidator class loads, parses an XML instance document and validates it against a W3C XML Schema that has been compiled with QXmlSchema .

The following example shows how to load a XML Schema from a local file, check whether it is a valid schema document and use it for validation of an XML instance document:

schemaUrl = QUrl("file:///home/user/schema.xsd")

schema = QXmlSchema()
schema.load(schemaUrl)

if schema.isValid():
    file = QFile("test.xml")
    file.open(QIODevice.ReadOnly)

    validator = QXmlSchemaValidator(schema)
    if validator.validate(file, QUrl.fromLocalFile(file.fileName())):
        print "instance document is valid"
    else:
        print "instance document is invalid"
}

XML Schema Version

This class implements schema validation according to the XML Schema 1.0 specification.

See also

QXmlSchema XML Schema Validation Example

class PySide2.QtXmlPatterns.QXmlSchemaValidator

PySide2.QtXmlPatterns.QXmlSchemaValidator(schema)

param schema:

PySide2.QtXmlPatterns.QXmlSchema

Constructs a schema validator. The schema used for validation must be referenced in the XML instance document via the xsi:schemaLocation or xsi:noNamespaceSchemaLocation attribute.

PySide2.QtXmlPatterns.QXmlSchemaValidator.messageHandler()

Return type:

PySide2.QtXmlPatterns.QAbstractMessageHandler

Returns the message handler that handles parsing and validation messages for this QXmlSchemaValidator .

See also

setMessageHandler()

PySide2.QtXmlPatterns.QXmlSchemaValidator.namePool()

Return type:

PySide2.QtXmlPatterns.QXmlNamePool

Returns the name pool used by this QXmlSchemaValidator for constructing names . There is no setter for the name pool, because mixing name pools causes errors due to name confusion.

PySide2.QtXmlPatterns.QXmlSchemaValidator.networkAccessManager()

Return type:

PySide2.QtNetwork.QNetworkAccessManager

Returns the network manager, or 0 if it has not been set.

See also

setNetworkAccessManager()

PySide2.QtXmlPatterns.QXmlSchemaValidator.schema()

Return type:

QXmlSchema*

Returns the schema that is used for validation.

See also

setSchema()

PySide2.QtXmlPatterns.QXmlSchemaValidator.setMessageHandler(handler)

Parameters:

handler – PySide2.QtXmlPatterns.QAbstractMessageHandler

Changes the message handler for this QXmlSchemaValidator to handler . The schema validator sends all parsing and validation messages to this message handler. QXmlSchemaValidator does not take ownership of handler .

Normally, the default message handler is sufficient. It writes compile and validation messages to stderr . The default message handler includes color codes if stderr can render colors.

When QXmlSchemaValidator calls message() , the arguments are as follows:

message() argument	Semantics
QtMsgType type	Only QtWarningMsg and QtFatalMsg are used. The former identifies a warning, while the latter identifies an error.
const QString & description	An XHTML document which is the actual message. It is translated into the current language.
const QUrl &identifier	Identifies the error with a URI, where the fragment is the error code, and the rest of the URI is the error namespace.
const QSourceLocation & sourceLocation	Identifies where the error occurred.

See also

messageHandler()

PySide2.QtXmlPatterns.QXmlSchemaValidator.setNetworkAccessManager(networkmanager)

Parameters:

networkmanager – PySide2.QtNetwork.QNetworkAccessManager

Sets the network manager to manager . QXmlSchemaValidator does not take ownership of manager .

See also

networkAccessManager()

PySide2.QtXmlPatterns.QXmlSchemaValidator.setSchema(schema)

Parameters:

schema – PySide2.QtXmlPatterns.QXmlSchema

Sets the schema that shall be used for further validation. If the schema is empty, the schema used for validation must be referenced in the XML instance document via the xsi:schemaLocation or xsi:noNamespaceSchemaLocation attribute.

See also

schema()

PySide2.QtXmlPatterns.QXmlSchemaValidator.setUriResolver(resolver)

Parameters:

resolver – PySide2.QtXmlPatterns.QAbstractUriResolver

Sets the URI resolver to resolver . QXmlSchemaValidator does not take ownership of resolver .

See also

uriResolver()

PySide2.QtXmlPatterns.QXmlSchemaValidator.uriResolver()

Return type:

PySide2.QtXmlPatterns.QAbstractUriResolver

Returns the schema’s URI resolver. If no URI resolver has been set, Qt XML Patterns will use the URIs in instance documents as they are.

The URI resolver provides a level of abstraction, or polymorphic URIs . A resolver can rewrite logical URIs to physical ones, or it can translate obsolete or invalid URIs to valid ones.

When Qt XML Patterns calls resolve() the absolute URI is the URI mandated by the schema specification, and the relative URI is the URI specified by the user.

See also

setUriResolver()

PySide2.QtXmlPatterns.QXmlSchemaValidator.validate(source[, documentUri=QUrl()])

Parameters:

• source – PySide2.QtCore.QIODevice

• documentUri – PySide2.QtCore.QUrl

Return type:

bool

PySide2.QtXmlPatterns.QXmlSchemaValidator.validate(data[, documentUri=QUrl()])

Parameters:

• data – PySide2.QtCore.QByteArray

• documentUri – PySide2.QtCore.QUrl

Return type:

bool

PySide2.QtXmlPatterns.QXmlSchemaValidator.validate(source)

Parameters:

source – PySide2.QtCore.QUrl

Return type:

bool

Validates the XML instance document read from source against the schema.

Returns true if the XML instance document is valid according to the schema, false otherwise.

Example:

schema = getSchema()

url = QUrl("http://www.schema-example.org/test.xml")

validator = QXmlSchemaValidator(schema)
if validator.validate(url):
    print "instance document is valid"
else:
    print "instance document is invalid"