pyjen.plugins.sectionedview module¶
Primitives for working on Jenkins views of type ‘SectionedView’
-
pyjen.plugins.sectionedview.
PluginClass
¶
-
class
pyjen.plugins.sectionedview.
SectionedView
(api)[source]¶ Bases:
pyjen.view.View
Interface to Jenkins views of type “SectionedView”
Views of this type support groupings of jobs into ‘sections’ which each have their own filters
-
add_section
(section_type, name)[source]¶ Adds a new section to the sectioned view
- Parameters
section_type (str) – name of class used to implement the new section to add
name (str) – descriptive text to appear in the title area of the section
-
static
get_jenkins_plugin_name
()[source]¶ Gets the name of the Jenkins plugin associated with this PyJen plugin
This static method is used by the PyJen plugin API to associate this class with a specific Jenkins plugin, as it is encoded in the config.xml
- Return type
str
-
sections
¶ - Returns
a list of sections contained within this view
- Return type
list
of one of the ‘SectionedView’ section types
-
-
class
pyjen.plugins.sectionedview.
SectionedViewXML
(api)[source]¶ Bases:
pyjen.utils.viewxml.ViewXML
raw config.xml parser for a Jenkins view of type ‘Sectioned View’
-
add_section
(section_type, name)[source]¶ Adds a new section to the sectioned view
- Parameters
section_type (str) – name of class used to implement the new section to add
name (str) – descriptive text to appear in the title area of the section
-
sections
¶ - Returns
a list of all ‘section’ objects contained in this view
- Return type
list
of section plugins associated with this view
-