synapse.tools.utils package

Submodules

synapse.tools.utils.autodoc module

class synapse.tools.utils.autodoc.DocHelp(ctors, types, forms, props, univs)[source]

Bases: object

Helper to pre-compute all doc strings hierarchically

async synapse.tools.utils.autodoc.docConfdefs(ctor)[source]
async synapse.tools.utils.autodoc.docModel(outp, core)[source]
async synapse.tools.utils.autodoc.docStormTypes()[source]
async synapse.tools.utils.autodoc.docStormpkg(pkgpath)[source]
async synapse.tools.utils.autodoc.docStormsvc(ctor)[source]
synapse.tools.utils.autodoc.getArgParser(outp)[source]
synapse.tools.utils.autodoc.has_popts_data(props)[source]
synapse.tools.utils.autodoc.lookupedgesforform(form: str, edges: List[Tuple[Tuple[str | None, str, str | None], Dict[str, str]]]) → Dict[str, List[Tuple[Tuple[str | None, str, str | None], Dict[str, str]]]][source]
async synapse.tools.utils.autodoc.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
synapse.tools.utils.autodoc.processCtors(rst, dochelp, ctors)[source]
Parameters:
Returns:

None

synapse.tools.utils.autodoc.processFormsProps(rst, dochelp, forms, univ_names, alledges)[source]
async synapse.tools.utils.autodoc.processStormCmds(rst, pkgname, commands)[source]
Parameters:

  • rst (RstHelp)

  • pkgname (str)

  • commands (list)

Returns:

None

async synapse.tools.utils.autodoc.processStormModules(rst, pkgname, modules)[source]
synapse.tools.utils.autodoc.processTypes(rst, dochelp, types)[source]
Parameters:
Returns:

None

synapse.tools.utils.autodoc.processUnivs(rst, dochelp, univs)[source]

synapse.tools.utils.changelog module

class synapse.tools.utils.changelog.ModelDiffer(current_model: dict, reference_model: dict)[source]

Bases: object

diffModl(outp: OutPut) → dict | None[source]
async synapse.tools.utils.changelog.format(opts: Namespace, outp: OutPut)[source]
async synapse.tools.utils.changelog.gen(opts: Namespace, outp: OutPut)[source]
synapse.tools.utils.changelog.getArgParser(outp: OutPut)[source]
async synapse.tools.utils.changelog.main(argv, outp=<synapse.lib.output.OutPut object>)[source]
async synapse.tools.utils.changelog.model(opts: Namespace, outp: OutPut)[source]

synapse.tools.utils.easycert module

async synapse.tools.utils.easycert.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.utils.guid module

async synapse.tools.utils.guid.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.utils.json2mpk module

synapse.tools.utils.json2mpk.getArgParser()[source]
async synapse.tools.utils.json2mpk.main(argv, outp=<synapse.lib.output.OutPut object>)[source]

synapse.tools.utils.rstorm module

async synapse.tools.utils.rstorm.main(argv, outp=<synapse.lib.output.OutPut object>)[source]