pyjen.plugins.sectionedview module

Primitives for working on Jenkins views of type ‘SectionedView’

class pyjen.plugins.sectionedview.ListViewSection(node)[source]

Bases: pyjen.utils.plugin_base.PluginBase

One of several ‘section’ types defined for a sectioned view

Represents sections of type ‘ListView’

Parameters:node (ElementTree.Element) – XML node defining the settings for a ListView section
include_regex[source]

regular filter for jobs to be shown in this section

Return type:str
type = 'hudson.plugins.sectioned__view.ListViewSection'
class pyjen.plugins.sectionedview.SectionedView(controller, jenkins_master)[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

Parameters:
  • controller (DataRequester) – class capable of handling common HTTP IO requests sent by this object to the Jenkins REST API
  • jenkins_master (Jenkins) – Reference to Jenkins object associated with the master instance managing this job
sections[source]
Returns:a list of sections contained within this view
Return type:list of one of the ‘SectionedView’ section types
type = 'hudson.plugins.sectioned__view.SectionedView'
class pyjen.plugins.sectionedview.SectionedViewXML(xml)[source]

Bases: pyjen.utils.viewxml.ViewXML

Abstraction for operating on raw config.xml data for a Jenkins view of type ‘Sectioned View’

Parameters:xml (str) – XML string describing a sectioned view
sections[source]
Returns:a list of all ‘section’ objects contained in this view
Return type:list of section plugins associated with this view
class pyjen.plugins.sectionedview.TextSection(node)[source]

Bases: pyjen.utils.plugin_base.PluginBase

One of several ‘section’ types defined for a sectioned view

Sections of this type contain simple descriptive text

Parameters:node (ElementTree.Element) – XML node defining the settings for a ListView section
type = 'hudson.plugins.sectioned__view.TextSection'