CellMLToNektar.pycml.element_base Class Reference

Inheritance diagram for CellMLToNektar.pycml.element_base:

Public Member Functions
def	__init__ (self)
def	__delattr__ (self, key)
def	__setattr__ (self, key, value)
def	rootNode (self)
def	cmeta_id (self)
def	xml_remove_child_at (self, index=-1)
def	xml_doc (self)
def	xml_properties (self)

Public Attributes
	xml_attributes

Detailed Description

Base element class to allow me to set certain attributes on my instances
that are Python objects rather than unicode strings.

Definition at line 207 of file pycml.py.

Constructor & Destructor Documentation

__init__()

def CellMLToNektar.pycml.element_base.__init__

(

self

)

Reimplemented in CellMLToNektar.pycml.mathml_plus, CellMLToNektar.pycml.mathml_piecewise, CellMLToNektar.pycml.mathml_apply, CellMLToNektar.pycml.mathml_ci, CellMLToNektar.pycml.mathml_cn, CellMLToNektar.pycml.mathml_constructor, CellMLToNektar.pycml.mathml_math, CellMLToNektar.pycml.mathml, CellMLToNektar.pycml.cellml_unit, CellMLToNektar.pycml.cellml_units, CellMLToNektar.pycml.cellml_variable, CellMLToNektar.pycml.cellml_component, and CellMLToNektar.pycml.cellml_model.

Definition at line 212 of file pycml.py.

    def __init__(self):
        self.xml_attributes = {} # Amara should really do this!
        super(element_base, self).__init__()
    

Member Function Documentation

__delattr__()

def CellMLToNektar.pycml.element_base.__delattr__	(		self,
			key
	)

Bypass Amara's __delattr__ for attribute names that start with _cml_

Definition at line 216 of file pycml.py.

    def __delattr__(self, key):
        """
        Bypass Amara's __delattr__ for attribute names that start with _cml_
        """
        if key.startswith('_cml_'):
            del self.__dict__[key]
        else:
            amara.bindery.element_base.__delattr__(self, key)
    

__setattr__()

def CellMLToNektar.pycml.element_base.__setattr__	(		self,
			key,
			value
	)

Bypass Amara's __setattr__ for attribute names that start with _cml_

Definition at line 225 of file pycml.py.

    def __setattr__(self, key, value):
        """
        Bypass Amara's __setattr__ for attribute names that start with _cml_
        """
        if key.startswith('_cml_'):
            self.__dict__[key] = value
        else:
            amara.bindery.element_base.__setattr__(self, key, value)
    

cmeta_id()

def CellMLToNektar.pycml.element_base.cmeta_id

(

self

)

Get the value of the cmeta:id attribute, or the empty string if not set.

Definition at line 244 of file pycml.py.

    def cmeta_id(self):
        """Get the value of the cmeta:id attribute, or the empty string if not set."""
        return self.getAttributeNS(NSS['cmeta'], u'id')
 

Referenced by CellMLToNektar.pycml.cellml_variable.add_rdf_annotation(), CellMLToNektar.pycml.cellml_variable.get_rdf_annotation(), CellMLToNektar.pycml.cellml_variable.get_rdf_annotations(), CellMLToNektar.pycml.cellml_model.is_self_excitatory(), and CellMLToNektar.pycml.cellml_variable.remove_rdf_annotations().

rootNode()

def CellMLToNektar.pycml.element_base.rootNode

(

self

)

Definition at line 235 of file pycml.py.

    def rootNode(self):
        p = self.parentNode
        if p:
            return p.rootNode
        elif isinstance(self, mathml):
            raise ValueError('MathML element with no parent!')
        return self
 

Referenced by CellMLToNektar.pycml.mathml_ci._reduce(), CellMLToNektar.pycml.mathml_constructor._tree_complexity(), CellMLToNektar.pycml.mathml.model(), CellMLToNektar.pycml.mathml_piecewise.tree_complexity(), and CellMLToNektar.pycml.cellml_model.validate().

xml_doc()

def CellMLToNektar.pycml.element_base.xml_doc

(

self

)

Definition at line 275 of file pycml.py.

    def xml_doc(self):
        msg = []
        xml_attrs = []
        if hasattr(self, 'xml_attributes'):
            msg.append('Object references based on XML attributes:')
            for apyname in self.xml_attributes:
                local, ns = self.xml_attributes[apyname]
                if ns:
                    source_phrase = " based on '{%s}%s' in XML"%(ns, local)
                else:
                    source_phrase = " based on '%s' in XML"%(local)
                msg.append(apyname+source_phrase)
                xml_attrs.append(apyname)
        msg.append('Object references based on XML child elements:')
        for attr, val in self.__dict__.items():
            if not (attr.startswith('xml') or
                    attr.startswith('_cml_') or
                    attr in self.xml_ignore_members):
                if attr not in xml_attrs:
                    count = len(list(getattr(self, attr)))
                    if count == 1:
                        count_phrase = " (%s element)"%count
                    else:
                        count_phrase = " (%s elements)"%count
                    local, ns = val.localName, val.namespaceURI
                    if ns:
                        source_phrase = " based on '{%s}%s' in XML"%(ns, local)
                    else:
                        source_phrase = " based on '%s' in XML"%(local)
                    msg.append(attr+count_phrase+source_phrase)
        return u'\n'.join(msg)
    

References CellMLToNektar.pycml.element_base.xml_attributes.

xml_properties()

def CellMLToNektar.pycml.element_base.xml_properties

(

self

)

Return a dictionary whose keys are Python properties on this
object that represent XML attributes and elements, and whose vaues
are the corresponding objects (a subset of __dict__)

Definition at line 308 of file pycml.py.

    def xml_properties(self):
        """
        Return a dictionary whose keys are Python properties on this
        object that represent XML attributes and elements, and whose vaues
        are the corresponding objects (a subset of __dict__)
        """
        properties = {}
        for attr in self.__dict__:
            if (not (attr.startswith('xml')
                     or attr.startswith('_cml_')
                     or attr in self.xml_ignore_members)):
                properties[attr] = self.__dict__[attr]
        return properties
 
# Add some improved/new methods to all bindings

xml_remove_child_at()

def CellMLToNektar.pycml.element_base.xml_remove_child_at	(		self,
			index = -1
	)

Remove child object at a given index
index - optional, 0-based index of child to remove (defaults to the last child)

Definition at line 248 of file pycml.py.

    def xml_remove_child_at(self, index=-1):
        """
        Remove child object at a given index
        index - optional, 0-based index of child to remove (defaults to the last child)
        """
        obj = self.xml_children[index]
        if isinstance(obj, unicode):
            del self.xml_children[index]
        else:
            # Remove references to the object
            # Probably a slow way to go about this
            for attr, val in self.__dict__.items():
                if not (attr.startswith('xml') or
                        attr.startswith('_cml_') or
                        attr in self.xml_ignore_members):
                    next = getattr(val, 'next_elem', None)
                    if val == obj:
                        del self.__dict__[attr]
                        if next: self.__dict__[attr] = next
                    while next:
                        prev, val = val, next
                        next = getattr(val, 'next_elem', None)
                        if val == obj:
                            prev.next_elem = next
                            break
            del self.xml_children[index]
 

Member Data Documentation

xml_attributes

CellMLToNektar.pycml.element_base.xml_attributes

Definition at line 213 of file pycml.py.

Referenced by CellMLToNektar.pycml.cellml_unit.clone(), CellMLToNektar.pycml.cellml_model.xml(), and CellMLToNektar.pycml.element_base.xml_doc().