msml.generators

This module provide functions for generating names.

Functions

reset_all()

reset all here defined generators

Classes

IdentifierGenerator([prefix, suffix])

Generates identifier with a given prefix and suffx.

class msml.generators.IdentifierGenerator(prefix='', suffix='')

Bases: object

Generates identifier with a given prefix and suffx.

An instance can check, if the generated name was generated by him.

The counter starts by 1.

Parameters:

• prefix (str) – prefix string
• suffix (str) – suffix string

>>> g = IdentifierGenerator('a', 'b')
>>> g()
"a1b"
>>> a = g()
>>> a
"a2b"
>>> g.has_generated(a)
True
>>> g.has_generated('a3b')
False

has_generated(value)

checks if the value was generated by this instance

Parameters:value (str) – Returns: Return type:bool

reset()

resets the counter to zero

msml.generators.generate_identifier = msml.generators.IdentifierGenerator('id', '')

generator for converter task ids

Type:msml.generators.IdentifierGenerator

msml.generators.generate_task_id = msml.generators.IdentifierGenerator('converter_task_', '')

generator for converter task ids

Type:msml.generators.IdentifierGenerator

msml.generators.generate_variable = msml.generators.IdentifierGenerator('gen_', '_')

generator for converter task ids

Type:msml.generators.IdentifierGenerator

msml.generators.reset_all()

reset all here defined generators

Warning

This function is for testing purpose.