ccpnmodel.ccpncore.memops.scripts package

Subpackages

Submodules

ccpnmodel.ccpncore.memops.scripts.importAllPython module

Module Documentation here

ccpnmodel.ccpncore.memops.scripts.makeAllPython module

Module Documentation here

ccpnmodel.ccpncore.memops.scripts.makeDocs module

Module Documentation here

ccpnmodel.ccpncore.memops.scripts.makeDocs.makeApiDoc(modelPortal, rootDirName=None, rootFileName=None, releaseVersion=None, ignoreModules=None)[source]

Generate all python relevant code for a version - rootDirName: topmost directory to write to (defaults to current cvsroot) - rootFileName: file/dir name for root package (defaults to ‘RootPackage’) - releaseVersion: release version object (defaults to ‘unknown’)

ccpnmodel.ccpncore.memops.scripts.makeDocs.makeSphinxDoc()[source]

Generate Sphinx documentation’)

ccpnmodel.ccpncore.memops.scripts.makeHandCodeList module

Module Documentation here

ccpnmodel.ccpncore.memops.scripts.makeHandCodeList.main()[source]
ccpnmodel.ccpncore.memops.scripts.makeHandCodeList.outputCodeStubs(fp, elem, codeStubs, name)[source]
ccpnmodel.ccpncore.memops.scripts.makeHandCodeList.outputConstraints(fp, elem)[source]

ccpnmodel.ccpncore.memops.scripts.makePython module

Module Documentation here

ccpnmodel.ccpncore.memops.scripts.makePython.getModelPortal(dataModelVersion=None, includePackageNames=None, excludePackageNames=None)[source]

get adapted ModelPortal

  • dataModelVersion object of version to generate(default: current)

  • includePackageNames: package qualified names to generate from; only leaf package names should be put in includePackageNames.

  • excludePackageNames: qualified names of packages that will be ignored together with their contents.

ccpnmodel.ccpncore.memops.scripts.makePython.makePython(modelPortal, rootDirName=None, rootFileName=None, releaseVersion=None, ignoreModules=None)[source]

Generate all python relevant code for a version - rootDirName: topmost directory to write to (defaults to current cvsroot) - rootFileName: file/dir name for root package (defaults to ‘RootPackage’) - releaseVersion: release version object (defaults to ‘unknown’)

ccpnmodel.ccpncore.memops.scripts.makePythonArgs module

Module Documentation here

Set flags from command line arguments e.g.

--single-input-parameter

to show these warnings (default)

--ignore-single-input-parameter

to ignore these warnings

--all

show all warnings (default)

--ignore-all

ignore all warnings (defined in list)

current warnings supported:

single-input-parameter start-with-upper-case start-with-lower-case dissimilar-to-name elementpairings-not-found elementpairings-found does-not-descend-from

ccpnmodel.ccpncore.memops.scripts.makePythonArgs.getArgument(arg)[source]

Return the state of a given argument Raise an error if the argument does not exist

ccpnmodel.ccpncore.memops.scripts.makePythonArgs.setMakeArguments()[source]

Read the command line arguments - series of flags to enable/disable warnings