ccpnmodel.ccpncore.memops.scripts.core package

Submodules

ccpnmodel.ccpncore.memops.scripts.core.FileModelAdapt module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.FileModelAdapt.FileModelAdapt

Bases: ccpnmodel.ccpncore.memops.scripts.core.ModelAdapt.ModelAdapt

Python-specific version of ModelAdapt

ccpnmodel.ccpncore.memops.scripts.core.LanguageInterface module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.LanguageInterface.LanguageInterface

Bases: object

addAllCollection(var, collection, isUnique, isOrdered, varType=None)

addAllList(var, collection, varType=None)

addCollection(var, collection, isUnique, isOrdered, varType=None)

addList(var, collection, varType=None)

arithmetic(expression1, op, expression2)

boolean(expression)

breakLoop()

callFunc(func, obj=None, params=None, doWrite=True)

callKwFunc(func, obj=None, params=None, setVarTo=None, kwDict={})

call function with keyword-value parameters. kwDict keys are assumed to be strings, kwDict values are assumed to be printable as given (hint - use toLiteral for literals). the result is set to setVarTo, unless this is None

NB for languages that do not accept keyword-value parameters, the information is passed in a dictionary variable that is put last on the variable list. callKwFunc will only work for functions that have this behaviour.

castVar(castType, var)

catchException(exception=None, exceptionVar='ex')

collectionIsEmpty(collection, isUnique, isOrdered, varType=None)

collectionIsNotEmpty(collection, isUnique, isOrdered, varType=None)

collectionNotNoneAndNotEmpty(collection, isUnique, isOrdered, varType=None)

NBNB TBD do we need this and the following?

comparison(expression1, func, expression2)

concatenateCollection(newCollection, isUnique, isOrdered, varType=None, *collections)

concatenateList(newCollection, varType=None, *collections)

constructorFuncname(clazz)

continueLoop()

countInCollection(var, collection, isUnique, isOrdered, varType=None)

countInList(var, collection, varType=None)

currentTime()

defineVar(var, varType)

dictIsEmpty(dictVar)

dictIsNotEmpty(dictVar)

elseIf(condition=None)

endBlock()

endFunc()

endIf()

endIndexLoop()

endLoop()

endTry()

endWhile()

equals(expression1, expression2)

exceptionClass(exception=None)

finaliseException()

funcDeclaration(op)

getByIndexInCollection(index, collection, isUnique, isOrdered, varType=None)

get value by index. Works only on ordered collections. Returns an expression

getByIndexInList(index, collection, varType=None)

getClass(var)

Get class of object passed in. Expression

getClassname(var)

Get string class name of object passed in. Expression

getCollection(var, collection, isUnique, isOrdered, varType=None)

getDictEntry(dictVar, key, castType=None, defaultValue=None, keyIsMandatory=False)

getDictKeys(dictVar)

set dict keys as collection or iterable NB must be valid as initValue to newCollection

getDictValues(dictVar)

set dict values as collection or iterable NB must be valid as initValue to newCollection

getDocString(op, inClass=None)

getFuncParams(op, defineFunc=True)

get parameters as list of strings. If defineFunc get strings for function definition. Else get strings for function calls, assuming you use same variable names as the definition. This second form is used e.g. to call constructors in factory functions.

getList(var, collection, varType=None)

getListSlice(collection, lo=0, hi=None, varType=None)

getOpValueType(op)

getReturnType(op)

getThrowsTypes(op)

inEnumeration(value, enumeration)

incrementInteger(var)

indexInCollection(var, collection, isUnique, isOrdered, varType=None)

expression giving index of var in collection. Must work on ordered collections as well as any unordered collections that are implemented as sequences.

indexInList(var, collection, varType=None)

isInCollection(var, collection, isUnique, isOrdered, varType=None)

isInList(var, collection, varType=None)

isInstance(var, className)

Boolean - is (string) var an instance of (string) clazz?

keyIsInDict(dictVar, key)

lenCollection(collection, isUnique, isOrdered, varType=None)

lenDict(dictVar)

lenList(collection, varType=None)

lenString(string)

listIsEmpty(collection, varType=None)

listIsNotEmpty(collection, varType=None)

listNotNoneAndNotEmpty(collection, varType=None)

logicalOp(expression1, op, expression2)

negate(condition)

newCollection(collection, isUnique, isOrdered, varType=None, initValues=None, isFrozen=False, needDeclType=False, useAdd=False)

make new collection, possibly initialising it.

• collection is the variable name to set the new collection to.

If collection is set, newCollection code will set the variable. If collection is None an expression will be returned.

• if initValues if a string expression the new collection will be

initialised from this string expression at runtime.

. If initValues is a collection of literals the code will initialise

the new collection to these values. NB this requires collection != None

• if isFrozen the new collection will be frozen.

• if initValuesObject is True, initValues represents an object rather than a collection

• useAdd is a Java hack

newDict(dictVar=None, keyType=None, valueType=None, needDeclType=False)

if dictVar is None returns expression, else write statement

newList(collection, varType=None, initValues=None, isFrozen=False, needDeclType=False)

newStack(stack, varType=None, initValues=None, needDeclType=False)

noStatement()

optionalValue(var, collection, defaultVar, isUnique, isOrdered, varType=None)

peekStack(stack, var=None, varType=None, castType=None)

popCollection(var, collection, isUnique, isOrdered, varType=None, castType=None)

popList(var, collection, varType=None, castType=None)

popStack(stack, var=None, varType=None, castType=None, doWrite=True)

printMessage(message, *objs)

pushStack(stack, var)

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

removeCollection(var, collection, isUnique, isOrdered, varType=None)

removeDictEntry(dictVar, key)

removeList(var, collection, varType=None)

replaceInCollection(oldvar, newvar, collection, isUnique, isOrdered, varType=None)

replace oldVar with newvar in collection. Will raise appropriate error if oldvar not present If the result breaks uniqueness or type constraints the collection is left unmodified and an error is raised.

replaceInList(oldvar, newvar, collection, varType=None)

reraiseException(exceptionVar='exc', exceptionClass=None)

returnStatement(value=None)

reverseList(collection)

setByIndexInCollection(indexvar, var, collection, isUnique, isOrdered, varType=None)

set value by index of var in collection. Must work on ordered collections as well as any unordered collections that are implemented as sequences.

setByIndexInList(indexvar, var, collection, varType=None)

setDictEntry(dictVar, key, value)

setVar(var, value, varType=None, castType=None)

stackIsEmpty(stack)

stackIsNotEmpty(stack)

stackSize(stack)

startBlock()

startFunc(funcname, params=None, docString=None, returnType=None, throwsTypes=None)

startIf(condition)

startIndexLoop(iVar, nVar, isReversed=False)

startLoop(var, collection, isUnique, isOrdered, varType=None)

startLoopOverDictKeys(dictVar, keyVar, varType=None)

startTry()

startWhile(condition)

stringIsNotEmpty(val)

stringReplace(val, stringToMatch, stringToReplace)

stringSlice(val, fromStart=0, fromEnd=None)

subtractIntegers(var1, var2)

toLiteral(value)

String representation of ‘value’ that will work as a literal in an expression. For languages that makes the distinction this will be an ‘object’ rather than a ‘raw’ literal. NB for objects that have no equivalent literal, behaviour is unpredictable

valueNotNoneAndIfCollectionNotEmpty(value, isUnique, isOrdered, varType=None)

NBNB TBD do we need this and the preceding?

valueNotNoneAndIfListNotEmpty(value, varType=None)

ccpnmodel.ccpncore.memops.scripts.core.ModelAdapt module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.ModelAdapt.ModelAdapt

Bases: ccpnmodel.ccpncore.memops.metamodel.ModelTraverse.ModelTraverse

This class processes and modifies an input model, specifically adding operations that are absent in the basic model but needed for generation. Assumes that basic model is valid. All additions in this file are independent of language, implementation and task. May be overridden in subclasses to handle specific changes.

addClassOperations(inClass)

Add operations not linked to an element (e.g. init, delete, checkValid)

addDataObjTypeOperations(inClass)

Add operations not linked to an element (e.g. init, checkValid)

addGetters(elem, inClass)

select, and find or create ‘get’ functions

addModifiers(elem, inClass)

select, and find or create modifiers (set, add, remove)

addOperationExceptions(op, inClass)

NBNB TBD add exceptions raised

addParentLink(clazz)

Add element and getter for parent link (synonym for the real one) Must be treated as special case later.

addRoleOperations(elem, inClass)

select, and find or create operations specific for roles or DataObjType attrs (findFirst, findAll, new)

checkOpForDerived(elem, inClass, opType)

verify existence of op for derived element and check the op.

checkOpParameter(par, inClass, params)

check an existing operation parameter conforms to the rules.

checkOperation(op, opData, inClass, opSubType=None)

check an existing operation conforms to the rules, and adds missing information (target, parameters) where it can be deduced from context.

endClass(clazz)

processing actions for end of class

endComplexDataType(complexDataType)

processing actions for end of complexDataType

endDataObjType(dataObjType)

processing actions for end of class

getOpData(target, opType, inClass=None)

Get opData for opType, taking special cases into account

getOpDocumentation(opData, inClass, opSubType=None, copyElemDoc=True)

get documentation for generated operation

getOperationName(target, opType, opSubType=None)

get name of operation - NB does not use actual operation object, which may not exist yet

Note that opSubType!=None is used as an operation name suffix. If subOp is found and contains a ‘suffix’ item, this will be used instead.

initClass(complexDataType)

processing actions for start of complexDataType

initComplexDataType(complexDataType)

processing actions for start of complexDataType

initDataObjType(complexDataType)

processing actions for start of complexDataType

makeOperations(target, opType, inClass, elem=None)

get existing operation and check it, or create a new one Some error checking and bookkeeping for existing operations

NB elem passed in separately for the ‘new’ operations, where it is the childRole pointing to the class to create. Otherwise it is set equal to the target.

newElement(clazz, **params)

make new element of class clazz using parameter dict params Sets isImplicit to True and the Guid to a dummy value, if not already set.

newOpParameter(op, inClass, params)

Delegate Operation parameter creation to appropriate function

newOperation(opData, inClass, opSubType=None)

create a new operation

opDocTemplate = '%s for %s'

opParameterData(parData, op)

Delegate Operation parameter creation to appropriate function

parDocTemplate = ' the %s'

parDocumentation(parData)

make documentation for generated parameter

preprocessModel()

pre-process model - handle multiple inheritance and select implementation-dependent classes

processAttribute(elem, inClass)

processing actions for attribute

processClass(clazz)

processing actions for class

processDataObjType(dataObjType)

processing actions for class

processModel()

top function that does all actions. Only function that should be called from outside the module.

processOperation(op, inClass)

processing actions for operation

processRole(elem, inClass)

processing actions for role

sortAttributes(clazz)

sort attributes within clazz

sortOperations(elem)

sort operations within class by name

sortRoles(clazz)

sort roles within clazz

stdOpParameterData(parData)

stdOperationData(opData, opSubType=None)

get data describing a normal operation for checking or creation

ccpnmodel.ccpncore.memops.scripts.core.PyFileModelAdapt module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.PyFileModelAdapt.PyFileModelAdapt(**kw)

Bases: ccpnmodel.ccpncore.memops.scripts.core.PyModelAdapt.PyModelAdapt, ccpnmodel.ccpncore.memops.scripts.core.FileModelAdapt.FileModelAdapt

Python-specific version of ModelAdapt

ccpnmodel.ccpncore.memops.scripts.core.PyFileModelAdapt.processModel(modelPortal, **kw)

process model to adapt it for Python

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

ccpnmodel.ccpncore.memops.scripts.core.PyLanguage module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.PyLanguage.PyLanguage

Bases: ccpnmodel.ccpncore.memops.scripts.core.LanguageInterface.LanguageInterface, ccpnmodel.ccpncore.memops.metamodel.TextWriter.TextWriter, object

addAllCollection(var, collection, isUnique, isOrdered, varType=None)

addCollection(var, collection, isUnique, isOrdered, varType=None)

arithmetic(expression1, op, expression2)

boolean(expression)

breakLoop()

callFunc(func, obj=None, params=None, doWrite=True)

call function with normal parameters

callKwFunc(func, obj=None, params=None, setVarTo=None, kwDict={})

call function with keyword-value parameters. kwDict keys are assumed to be strings, kwDict values are assumed to be printable as given (hint - use toLiteral for literals). the result is set to setVarTo, unless this is None

NB for languages that do not accept keyword-value parameters, the information is passed in a dictionary variable that is put last on the variable list. callKwFunc will only work for functions that have this behaviour.

castVar(castType, var)

catchException(exception=None, exceptionVar='ex')

collectionIsEmpty(collection, isUnique, isOrdered, varType=None)

collectionIsNotEmpty(collection, isUnique, isOrdered, varType=None)

collectionNotNoneAndNotEmpty(collection, isUnique, isOrdered, varType=None)

NBNB TBD do we need this and the following?

comparison(expression1, func, expression2)

concatenateCollection(newCollection, isUnique, isOrdered, varType=None, *collections)

constructorFuncname(clazz)

continueLoop()

countInCollection(var, collection, isUnique, isOrdered, varType=None)

createDir(dirName)

set up as recursive function (instead of using os.makedirs) as some implementations might want to do other things in each directory.

currentTime()

defineVar(var, varType)

dictIsEmpty(dictVar)

dictIsNotEmpty(dictVar)

elseIf(condition=None)

endBlock()

endFunc()

endIf()

endIndexLoop()

endLoop()

endTry()

endWhile()

equals(expression1, expression2)

exceptionClass(exception=None)

finaliseException()

funcDeclaration(op)

getByIndexInCollection(index, collection, isUnique, isOrdered, varType=None)

get value by index. Works only on ordered collections. Returns an expression

getClass(var)

Get class of object passed in. Expression

getClassname(var)

Get string class name of object passed in. Expression

getCollection(var, collection, isUnique, isOrdered, varType=None)

Get first element from ordered collection, and random element from others. Works whether modifiable or not.

getDictEntry(dictVar, key, castType=None, defaultValue=None, keyIsMandatory=False)

getDictKeys(dictVar)

set dict keys as collection or iterable NB must be valid as initValue to newCollection

getDictValues(dictVar)

set dict values as collection or iterable NB must be valid as initValue to newCollection

getDocString(op, inClass=None)

getFuncParams(op, defineFunc=True)

get parameters as list of strings. If defineFunc get strings for function definition. Else get strings for function calls, assuming you use same variable names as the definition. This second form is used e.g. to call constructors in factory functions.

getListSlice(collection, lo=0, hi=None, varType=None)

get slice out of list

getOpValueType(op)

getReturnType(op)

getThrowsTypes(op)

inEnumeration(value, enumeration)

incrementInteger(var)

indexInCollection(var, collection, isUnique, isOrdered, varType=None)

expression giving index of var in collection. Must work on ordered collections as well as any unordered collections that are implemented as sequences.

isInCollection(var, collection, isUnique, isOrdered, varType=None)

isInstance(var, className)

Boolean - is (string) var an instance of (string) clazz?

keyIsInDict(dictVar, key)

lenCollection(collection, isUnique, isOrdered, varType=None)

lenDict(dictVar)

lenString(string)

logicalOp(expression1, op, expression2)

negate(condition)

newCollection(collection, isUnique, isOrdered, varType=None, initValues=None, isFrozen=False, needDeclType=False, useAdd=False)

initValues must be a string variable name (referring to an iterable) an iterable of literals, or None

newDict(dictVar=None, keyType=None, valueType=None, needDeclType=False)

if dictVar is None returns expression, else write statement

newStack(stack, varType=None, initValues=None, needDeclType=False)

noStatement()

optionalValue(var, collection, defaultVar, isUnique, isOrdered, varType=None)

peekStack(stack, var=None, varType=None, castType=None)

popCollection(var, collection, isUnique, isOrdered, varType=None, castType=None)

popStack(stack, var=None, varType=None, castType=None, doWrite=True)

printMessage(*objs)

pushStack(stack, var)

raiseApiError(errorMsg, obj=None, obj2=None, obj3=None, inOp=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’

removeCollection(var, collection, isUnique, isOrdered, varType=None)

removeDictEntry(dictVar, key)

replaceInCollection(oldvar, newvar, collection, isUnique, isOrdered, varType=None)

resulting code may raise KeyError (for unique, nonordered) or ValueError (for all others)

reraiseException(exceptionVar='exc', exceptionClass=None)

returnStatement(value=None)

reverseList(collection)

setByIndexInCollection(indexvar, var, collection, isUnique, isOrdered, varType=None)

set value by index of var in collection. Must work on ordered collections as well as any unordered collections that are implemented as sequences.

setDictEntry(dictVar, key, value)

setVar(var, value, varType=None, castType=None)

stackIsEmpty(stack)

stackIsNotEmpty(stack)

stackSize(stack)

startBlock()

startFunc(funcname, params=None, docString=None, returnType=None, throwsTypes=None)

startIf(condition)

startIndexLoop(iVar, nVar, isReversed=False)

startLoop(var, collection, isUnique, isOrdered, varType=None)

startLoopOverDictKeys(dictVar, keyVar, varType=None)

startTry()

startWhile(condition)

stringIsNotEmpty(val)

stringReplace(val, stringToMatch, stringToReplace)

stringSlice(val, fromStart=0, fromEnd=None)

Slice string. Uses Python convention with positive and negative indices

subtractIntegers(var1, var2)

toLiteral(value)

String representation of ‘value’ that will work as a literal in an expression. For languages that makes the distinction this will be an ‘object’ rather than a ‘raw’ literal. NB for objects that have no equivalent literal, behaviour is unpredictable

valueNotNoneAndIfCollectionNotEmpty(value, isUnique, isOrdered, varType=None)

NBNB TBD do we need this and the preceding?

ccpnmodel.ccpncore.memops.scripts.core.PyModelAdapt module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.PyModelAdapt.PyModelAdapt

Bases: ccpnmodel.ccpncore.memops.scripts.core.ModelAdapt.ModelAdapt

Python-specific version of ModelAdapt

addClassOperations(inClass)

Add operations not linked to an element (e.g. init, delete, checkValid)

addDataObjTypeOperations(inClass)

Add operations not linked to an element (e.g. init, delete, checkValid)

addMetaClassAttr(clazz)

getOpDocumentation(opData, inClass, opSubType=None, copyElemDoc=False)

get documentation for generated operation copyElemDoc defaults to False in Python we have the element documentation on the properties

initClass(complexDataType)

processing actions for class

initComplexDataType(complexDataType)

processing actions for class

initDataObjType(complexDataType)

processing actions for class

ccpnmodel.ccpncore.memops.scripts.core.PyType module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.PyType.PyType

Bases: ccpnmodel.ccpncore.memops.scripts.core.TypeInterface.TypeInterface

collectionInterfaceType(collectionType=None)

collectionType(elementOrString=None, isUnique=None, isOrdered=None, useCollection=False)

dictInterfaceType(keyType=None, valueType=None)

elementVarType(element)

fileInterfaceType(mode='r')

implementationType(element)

interfaceType(element)

listInterfaceType(listType=None)

stackInterfaceType(stackType=None)

ccpnmodel.ccpncore.memops.scripts.core.TypeInterface module

Module Documentation here

class ccpnmodel.ccpncore.memops.scripts.core.TypeInterface.TypeInterface

Bases: object

collectionInterfaceType(collectionType=None)

collectionType(elementOrString=None, isUnique=None, isOrdered=None, useCollection=False)

dictInterfaceType(keyType=None, valueType=None)

elementVarType(element)

fileInterfaceType(mode='r')

implementationType(element)

interfaceType(element)

listInterfaceType(listType=None)

stackInterfaceType(stackType=None)