etr  4.0-pre
Public Member Functions | Static Public Attributes | List of all members
etr.plugin.PluginRegister Class Reference

Plugin register containing types but not instances of plugins. More...

Public Member Functions

def register_plugin (cls, name, plugin_cls)
 Registers a plugin with name and type-class plugin_cls More...
 
def register_step (cls, name, step, method)
 Register a step method method for plugin with name name and step step. More...
 
def register_options (cls, name, func)
 Register function to be called to add options. More...
 
def get_registered_options (cls)
 Returns option methods registered by plugins. More...
 
def get_registered_classes (cls)
 Returns registered plugin classes, sorted by their order. More...
 

Static Public Attributes

list plugin_cls = []
 
dictionary plugin_steps = {}
 
list plugin_opts = []
 

Detailed Description

Plugin register containing types but not instances of plugins.

Member Function Documentation

◆ get_registered_classes()

def etr.plugin.PluginRegister.get_registered_classes (   cls)

Returns registered plugin classes, sorted by their order.

Low value = lower sorting index

◆ get_registered_options()

def etr.plugin.PluginRegister.get_registered_options (   cls)

Returns option methods registered by plugins.

◆ register_options()

def etr.plugin.PluginRegister.register_options (   cls,
  name,
  func 
)

Register function to be called to add options.

◆ register_plugin()

def etr.plugin.PluginRegister.register_plugin (   cls,
  name,
  plugin_cls 
)

Registers a plugin with name and type-class plugin_cls

◆ register_step()

def etr.plugin.PluginRegister.register_step (   cls,
  name,
  step,
  method 
)

Register a step method method for plugin with name name and step step.

Member Data Documentation

◆ plugin_cls

list etr.plugin.PluginRegister.plugin_cls = []
static

◆ plugin_opts

list etr.plugin.PluginRegister.plugin_opts = []
static

◆ plugin_steps

dictionary etr.plugin.PluginRegister.plugin_steps = {}
static

The documentation for this class was generated from the following file: