pyjen.utils.plugin_api module

Primitives for interacting with the PyJen plugin subsystem

pyjen.utils.plugin_api.find_plugin(plugin_name)[source]

Locates the PyJen class associated with a given Jenkins plugin

Parameters

plugin_name (str) – Name of the Jenkins plugin to find the associated

Returns

reference to the PyJen plugin class associated with the given Jenkins plugin, if one exists. If one doesn’t exist, returns None.

pyjen.utils.plugin_api.get_all_plugins()[source]

Returns a list of all PyJen plugins installed on the system

Returns

0 or more PyJen plugins installed on this system

Return type

list

pyjen.utils.plugin_api.instantiate_xml_plugin(node, parent)[source]

Instantiates a PyJen XML plugin from an arbitrary XML node

Parameters
  • node (xml.etree.ElementTree.Element) – ElementTree node describing the plugin to be instantiated

  • parent (XMLPlugin) – PyJen plugin that owns the XML for the plugin being instantiated. Used for managing plugins that support nesting of other plugins

Returns

Reference to the instantiated plugin, or None if the associated plugin isn’t currently implemented in PyJen yet

Return type

XMLPlugin