ccpnmodel.ccpncore.memops.scripts.xmlio package

Submodules

ccpnmodel.ccpncore.memops.scripts.xmlio.CompatibilityGen module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.xmlio.CompatibilityGen.LocalXmlGen(**kw)

Bases: ccpnmodel.ccpncore.memops.format.xml.XmlGen.XmlGen

ccpnmodel.ccpncore.memops.scripts.xmlio.CompatibilityGen.dirNameFromVersionString(versionString)

generate directory name from version string

ccpnmodel.ccpncore.memops.scripts.xmlio.CompatibilityGen.makeCompatibility(fromModel, toModel, modelPortal=None, elementPairings=None, fileName='CompatibilityMapInfo.py')

Make compatibility info for converting fromModel to toModel. elementPairings is a list of (oldGuid, newGuid) pairs that map elements from the two models. Note that several old guids can map to a single new guid and vice versa.

ccpnmodel.ccpncore.memops.scripts.xmlio.CompatibilityGen.makeUpgrade(fromVersionTag, toVersionTag, toTopPackage=None, modelPortal=None, includePackageNames=(), excludePackageNames=(), infoFileName=None)

Make upgrade or downgrade map code from fromVersion to toVersion Will look for the models in ccpnmodel.versionDir and place the compatibility code in e.g. ccpncore/memops/format/compatibility/upgrade/v_2_0_3/MapInfo.py ccpncore/memops/format/compatibility/downgrade/v_2_2_1/MapInfo.py

ccpnmodel.ccpncore.memops.scripts.xmlio.CompatibilityGen.versionFromDir(topDir)

Get current version string for directory tree rooted in topDir

ccpnmodel.ccpncore.memops.scripts.xmlio.PyXmlMapWrite module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.xmlio.PyXmlMapWrite.PyXmlMapWrite(**kw)

Bases: ccpnmodel.ccpncore.memops.scripts.core.PyLanguage.PyLanguage, ccpnmodel.ccpncore.memops.scripts.core.PyType.PyType, ccpnmodel.ccpncore.memops.scripts.xmlio.XmlMapWrite.XmlMapWrite

addDefaultValues(dictName, elemMap, elem)

write default values. NB individual languages may choose to skip some of the more difficult ones. The value is compared with the stored value in XmlIo, look there for exact format.

addXmlClassCreation(dictName, clazz, package=None)

Write info for creation of new class

addXmlStringFunctions(dictName, typeCode)

Write info for conversion to and from string Must be overridden in subclasses

endLeafPackage(package)

processing actions for end of LeafPackage

initLeafPackage(package)

write API header for package containing actual code

raiseApiError(errorMsg, obj=None, obj2=None, obj3=None)

NB obj and obj2 and obj3 must evaluate to a single Python object More specifically you can pass in a tuple, like ‘(a,b,c)’ but not a comma-separated list, like ‘a,b,c’

streamAddAll(collectionToBeAdded, collectionToBeAddedTo)

streamCallConstructor(var, constructor, parent=None, castType=None, **attrlinks)

streamConvertExolink()

streamConvertStringToValue(cnvrt, value)

streamDoCompatibility()

streamElementAttr(key)

streamElementIsSkip(doReset=True)

streamElementSetSkip(setToNone=False)

streamElementSplitText(var, cnvrt=None)

streamElementTag(state='start')

streamElementText()

streamEndElement()

streamEndParse()

streamFoundClosingTag()

streamGetValue(var, name, defaultValue=None, keyIsMandatory=False, getChildAsDict=False)

streamHaveEarlyExit()

streamIndent(increasing)

streamInitLoadingMaps()

streamNextElement()

streamNonTextToString(value)

streamObjDictKey(obj, isMetaClass)

streamOrderedCollection(var)

streamOverrideOff(var)

streamSetValue(var, name, value, useDirectSet=True)

streamStartAttributeLoop(tag, value)

streamStartElement()

streamStartFunc(funcname, params=None, docString='', returnString='', returnType=None, throwsApiError=True)

streamStartParse()

streamWrite(s)

streamWriteAttr(key, value)

streamWriteComment(comment)

streamWriteEndElement(element, newLine=True, doIndent=False)

streamWriteStartElement(element, closeElement=True, newLine=True, **attrs)

streamWriteValue(value)

writeFileHeader(package)

writeLoadFromStreamEnd()

writeLoadFromStreamHandleError()

writeLoadFromStreamMain()

writeLoadFromStreamStart()

writeSaveToStreamBody(originator, indentBySpaces=2)

ccpnmodel.ccpncore.memops.scripts.xmlio.PyXmlMapWrite.writeXmlIo(modelPortal, rootFileName=None, rootDirName=None, releaseVersion=None, **kw)

write Python XML I/O mappings and code

Only function that should be called directly by ‘make’ scripts etc.

ccpnmodel.ccpncore.memops.scripts.xmlio.XmlMapWrite module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.xmlio.XmlMapWrite.XmlMapWrite(**kw)

Bases: ccpnmodel.ccpncore.memops.scripts.core.LanguageInterface.LanguageInterface, ccpnmodel.ccpncore.memops.scripts.core.TypeInterface.TypeInterface, ccpnmodel.ccpncore.memops.metamodel.TextWriter.TextWriter, ccpnmodel.ccpncore.memops.format.xml.XmlGen.XmlGen

addDefaultValues(dictName, elemMap, elem)

write default values. NB individual languages may choose to skip some of the more difficult ones. The value is compared with the stored value in XmlIo, look there for exact format.

addXmlClassCreation(dictName, clazz, package=None)

Write info for creation of new class

addXmlStringFunctions(dictName, typeCode)

Write info for conversion to and from string Must be overridden in subclasses

codeDirName = 'xml'

endComplexDataType(clazz)

endLeafPackage(package)

processing actions for end of LeafPackage

getSaveToStreamDocString()

initLeafPackage(package)

write API header for package containing actual code

localVarNames = {'aDict': 'aDict', 'aList': 'aList', 'abstractTypes': 'abstractTypes', 'contentMap': 'contentMap', 'currentMap': 'currentMap', 'exolinks': 'exolinks', 'globalMap': 'globalMap', 'loadMaps': 'loadMaps', 'mapsByGuid': 'mapsByGuid'}

processAbstractDataType(clazz)

processAttribute(elem, inClass)

processing actions for attribute

processBranchPackage(package)

processing actions for branch package

processClass(clazz)

processing actions for body of class

processDataObjType(clazz)

processing actions for body of class

processDataType(clazz)

toStr, cnvrt, and baseType postponed, being language dependent

processElement(elemMap)

processExoLink(clazz)

processLeafPackage(package)

make data dictionaries for package containing actual code

processRole(elem, inClass)

processing actions for role

setupLeafPackage(package)

streamAddAll(collectionToBeAdded, collectionToBeAddedTo)

streamCallConstructor(var, constructor, parent=None, castType=None, **attrlinks)

streamConvertExolink()

streamConvertStringToValue(cnvrt, value)

streamDoCompatibility()

streamElementAttr(key)

streamElementCheckSkip(doReset=True)

streamElementIsSkip(doReset=True)

streamElementSetSkip(setToNone=False)

streamElementSplitText(var, cnvrt=None)

streamElementTag(state='start')

streamElementText()

streamEndElement()

streamEndParse()

streamFoundClosingTag()

streamGetValue(var, name, defaultValue=None, keyIsMandatory=False, getChildAsDict=False)

streamHaveEarlyExit()

streamIndent(increasing)

streamInitLoadingMaps()

streamNextElement()

streamNonTextToString(value)

streamObjDictKey(obj, isMetaClass)

streamOrderedCollection(var)

streamOverrideOff(var)

streamSetValue(var, name, value, useDirectSet=True)

streamStartAttributeLoop(tag, value)

streamStartElement()

streamStartFunc(funcname, params=None, docString='', returnString='', returnType=None, throwsApiError=True)

streamStartParse()

streamTextToString(value)

streamWrite(s)

streamWriteAttr(key, value)

streamWriteComment(comment)

streamWriteElement(element, value='', **attrs)

streamWriteEndElement(element, newLine=True, doIndent=False)

streamWriteStartElement(element, closeElement=True, newLine=True, **attrs)

streamWriteValue(value)

writeDelayedLoadLinks()

writeDelayedLoadLinksBody(tag)

writeGetLoadingMaps()

writeGetLoadingMapsBody()

writeLinkChildData()

writeLinkChildDataBody()

writeLoadFromStream(parser)

writeLoadFromStreamBody()

writeLoadFromStreamEnd()

writeLoadFromStreamErrorBody()

writeLoadFromStreamExtraFunctions()

writeLoadFromStreamHandleError()

writeLoadFromStreamMain()

writeLoadFromStreamStart()

writeSaveToStream(originator, indentBySpaces=2)

writeSaveToStreamBody(originator, indentBySpaces=2)