CellMLToNektar.validator.LxmlRelaxngValidator Class Reference

Inheritance diagram for CellMLToNektar.validator.LxmlRelaxngValidator:

Public Member Functions
def	__init__ (self, schemaBase)
def	validate (self, stream)
def	quit (self)

Private Attributes
	_validator

Detailed Description

A RELAX NG validator built on top of lxml (http://lxml.de/validation.html#relaxng).
Can validate against schemas written in the XML syntax.

Definition at line 215 of file validator.py.

Constructor & Destructor Documentation

__init__()

def CellMLToNektar.validator.LxmlRelaxngValidator.__init__	(		self,
			schemaBase
	)

Initialise the RELAX NG validator.

Parses the schema into memory, and constructs lxml's validator object.
We are passed the path to the schema with no extension.

Definition at line 220 of file validator.py.

    def __init__(self, schemaBase):
        """Initialise the RELAX NG validator.
        
        Parses the schema into memory, and constructs lxml's validator object.
        We are passed the path to the schema with no extension.
        """
        try:
            from lxml import etree
        except ImportError, e:
            raise ValidatorError("Unable to import lxml: " + str(e))
        fp = open(schemaBase + '.rng', 'r')
        schema_doc = etree.parse(fp)
        self._validator = etree.RelaxNG(schema_doc)
    

Member Function Documentation

quit()

def CellMLToNektar.validator.LxmlRelaxngValidator.quit

(

self

)

Providing for compatibility with RvpRelaxngValidator; does nothing.

Definition at line 248 of file validator.py.

    def quit(self):
        """Providing for compatibility with RvpRelaxngValidator; does nothing."""
        pass
 
 

validate()

def CellMLToNektar.validator.LxmlRelaxngValidator.validate	(		self,
			stream
	)

Validate an XML document, returning a boolean.

stream should be a file-like object containing the document to be validated.
Returns True iff the document was valid.

Definition at line 234 of file validator.py.

    def validate(self, stream):
        """Validate an XML document, returning a boolean.
        
        stream should be a file-like object containing the document to be validated.
        Returns True iff the document was valid."""
        from lxml import etree
        doc = etree.parse(stream)
        res = self._validator.validate(doc)
        # Report error details via the logger
        logger = logging.getLogger('validator')
        for e in self._validator.error_log:
            logger.error(e)
        return res
 

References CellMLToNektar.validator.LxmlRelaxngValidator._validator.

Member Data Documentation

_validator

CellMLToNektar.validator.LxmlRelaxngValidator._validator

private

Definition at line 232 of file validator.py.

Referenced by CellMLToNektar.validator.LxmlRelaxngValidator.validate().