Inheritance diagram for CellMLToNektar.pycml.MathsError:

[legend]

Public Member Functions
def	__init__ (self, context_obj, message, warn=False, level=None)

def	show_xml_context_only (self)

def	__str__ (self)

def	ordinal (self, i)

def	__unicode__ (self)

Public Attributes
	message

	warn

	level

	show_xml_context

	cname

	ename

	context

	expr_index

	math_index

	reaction_spec

Private Member Functions
def	_generate_message (self, where)

Private Attributes
	_show_xml_context_only

Detailed Description

Exception class for validation errors raised while checking mathematics.

Definition at line 3343 of file pycml.py.

Constructor & Destructor Documentation

◆ init()

def CellMLToNektar.pycml.MathsError.__init__	(	self,
		context_obj,
		message,
		warn = `False`,
		level = `None`
	)

Create a mathematics validation error.

context_class should be the object that is reporting the error.
message gives more details on what went wrong.
If warn is set to true then produce a warning message, not an error.
level gives the level of the message logged.

Reimplemented in CellMLToNektar.pycml.UnitsError.

Definition at line 3347 of file pycml.py.

    def __init__(self, context_obj, message, warn=False, level=None):
        """Create a mathematics validation error.
        
        context_class should be the object that is reporting the error.
        message gives more details on what went wrong.
        If warn is set to true then produce a warning message, not an error.
        level gives the level of the message logged.
        """
        self.message = message
        self.warn = warn
        self.level = level or (logging.ERROR,logging.WARNING)[warn]
        self.show_xml_context = False
        self._show_xml_context_only = False
 
        self.cname = context_obj.component.name
        self.ename = context_obj.localName
        self.context = context_obj
        
        # Nicer context explanation
        if isinstance(context_obj, cellml_variable):
            self.expr_index = self.math_index = 0
            self.reaction_spec = ''
            return
        expr_root = context_obj.xml_xpath(u'ancestor-or-self::*[local-name(..)="math"]')[0]
        self.expr_index = self.math_index = 1
        math = expr_root.xml_parent
        for elt in math.xml_element_children():
            if elt is expr_root: break
            if elt.localName in [u'apply', u'semantics']:
                self.expr_index += 1
        for elt in math.xml_element_children(math.xml_parent):
            if elt is math: break
            if elt.localName == u'math':
                self.math_index += 1
        # Is this in a reaction?
        vref = context_obj.xml_xpath(u'ancestor::cml:variable_ref')
        if vref:
            self.reaction_spec = ' in mathematics for variable "%s" in a reaction' % vref[0].variable
        else:
            self.reaction_spec = ''
        return
 

Member Function Documentation

◆ str()

def CellMLToNektar.pycml.MathsError.__str__ ( self )

Definition at line 3394 of file pycml.py.

    def __str__(self):
        msg = unicode(self)
        return msg.encode('UTF-8')
 

◆ unicode()

def CellMLToNektar.pycml.MathsError.__unicode__ ( self )

Reimplemented in CellMLToNektar.pycml.UnitsError.

Definition at line 3425 of file pycml.py.

    def __unicode__(self):
        return self._generate_message('checking mathematics')
 

References CellMLToNektar.pycml.MathsError._generate_message().

◆ _generate_message()

def CellMLToNektar.pycml.MathsError._generate_message	(	self,
		where
	)

private

Definition at line 3407 of file pycml.py.

    def _generate_message(self, where):
        if self.warn: type = 'Warning'
        else: type = 'Error'
        msg = [type, ' ', where, ': ', self.message]
        if not self._show_xml_context_only:
            msg.extend(['\n  Context: ', self.ordinal(self.expr_index),
                         ' expression in the ', self.ordinal(self.math_index),
                         ' math element', self.reaction_spec,
                         ' in component ', self.cname, '\n  XPath: ',
                        element_xpath(self.context)])
        msg = u''.join(msg)
        if self.show_xml_context:
            # Return the context XML tree as well.
            xml = self.context.xml(indent = u'yes',
                                   omitXmlDeclaration = u'yes')
            msg = msg + u'\n' + unicode(xml, encoding='UTF-8')
        return msg
 

References CellMLToNektar.pycml.MathsError._show_xml_context_only, CellMLToNektar.pycml.MathsError.cname, CellMLToNektar.pycml.MathsError.context, CellMLToNektar.utilities.element_xpath(), CellMLToNektar.pycml.MathsError.expr_index, CellMLToNektar.pycml.MathsError.math_index, CellMLToNektar.pycml.MathsError.message, CellMLToNektar.pycml.MathsError.ordinal(), CellMLToNektar.pycml.MathsError.reaction_spec, CellMLToNektar.pycml.MathsError.show_xml_context, and CellMLToNektar.pycml.MathsError.warn.

Referenced by CellMLToNektar.pycml.MathsError.__unicode__(), and CellMLToNektar.pycml.UnitsError.__unicode__().

◆ ordinal()

def CellMLToNektar.pycml.MathsError.ordinal	(	self,
		i
	)

Definition at line 3398 of file pycml.py.

    def ordinal(self, i):
        "Convert integer i to an ordinal string."
        if i // 10 == 1:  suf = 'th'
        elif i % 10 == 1: suf = 'st'
        elif i % 10 == 2: suf = 'nd'
        elif i % 10 == 3: suf = 'rd'
        else:             suf = 'th'
        return "%d%s" % (i, suf)
 

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ show_xml_context_only()

def CellMLToNektar.pycml.MathsError.show_xml_context_only ( self )

Only show the XML where the error occurred.

Definition at line 3389 of file pycml.py.

    def show_xml_context_only(self):
        """Only show the XML where the error occurred."""
        self.show_xml_context = True
        self._show_xml_context_only = True
 

References CellMLToNektar.pycml.MathsError._show_xml_context_only, and CellMLToNektar.pycml.MathsError.show_xml_context.

Referenced by CellMLToNektar.processors.UnitsConverter.try_convert().

Member Data Documentation

◆ _show_xml_context_only

CellMLToNektar.pycml.MathsError._show_xml_context_only

private

Definition at line 3359 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message(), and CellMLToNektar.pycml.MathsError.show_xml_context_only().

◆ cname

CellMLToNektar.pycml.MathsError.cname

Definition at line 3361 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ context

CellMLToNektar.pycml.MathsError.context

Definition at line 3363 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ ename

CellMLToNektar.pycml.MathsError.ename

Definition at line 3362 of file pycml.py.

◆ expr_index

CellMLToNektar.pycml.MathsError.expr_index

Definition at line 3367 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ level

CellMLToNektar.pycml.MathsError.level

Definition at line 3357 of file pycml.py.

◆ math_index

CellMLToNektar.pycml.MathsError.math_index

Definition at line 3367 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ message

CellMLToNektar.pycml.MathsError.message

Definition at line 3355 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ reaction_spec

CellMLToNektar.pycml.MathsError.reaction_spec

Definition at line 3368 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

◆ show_xml_context

CellMLToNektar.pycml.MathsError.show_xml_context

Definition at line 3358 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message(), and CellMLToNektar.pycml.MathsError.show_xml_context_only().

◆ warn

CellMLToNektar.pycml.MathsError.warn

Definition at line 3356 of file pycml.py.

Referenced by CellMLToNektar.pycml.MathsError._generate_message().

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __str__()

◆ __unicode__()

◆ _generate_message()

◆ ordinal()

◆ show_xml_context_only()

Member Data Documentation

◆ _show_xml_context_only

◆ cname

◆ context

◆ ename

◆ expr_index

◆ level

◆ math_index

◆ message

◆ reaction_spec

◆ show_xml_context

◆ warn

◆ init()

◆ str()

◆ unicode()