vsgen.register module

This module provides a simple register utility for VSGenerate objects.

class vsgen.register.VSGRegisterCommand(logname, registerables)

Bases: object

The VSGRegisterCommand class presents a simple command object to execute the register methods of a collection of VSGRegisterable objects.

execute()

Executes the command.

class vsgen.register.VSGRegisterable

Bases: object

An interface class defining methods necessary for VSGRegisterable

lower(value)

Converts a value to lower case in a way compatible with Python2 and Python 3.

Parameters:value (object) – The value to convert. Returns:The value as lower case text.

register()

Interface method to ‘register’ the object.

text(value)

Converts a value to text in a way compatible with Python2 and Python 3.

Parameters:value (object) – The value to convert. Returns:The value as text.

upper(value)

Converts a value to upper case text in a way compatible with Python2 and Python 3.

Parameters:value (object) – The value to convert. Returns:The value as upper case text.