pyjen.changeset module

Primitives for interacting with SCM changesets

class pyjen.changeset.Changeset(api, data)[source]

Bases: object

Represents a set of SCM revisions associated with a Build of a Job.

See changeset() for details.

Parameters
  • api (JenkinsAPI) – Pre-initialized connection to the Jenkins REST API

  • data (dict) – Dictionary of data elements typically parsed from the “changeSet” node of a builds source data as provided by the Jenkins REST API.

property affected_items

details of the individual commits associated with a build

Type

list (ChangesetItem)

property has_changes

True if there are SCM changes associated with this changeset, False if not

Type

bool

property scm_type

name of the SCM tool associated with this change

Type

str

class pyjen.changeset.ChangesetItem(api, data)[source]

Bases: object

details of each SCM revision associated with a given Changeset

Parameters

data (dict) – Dictionary of attributes describing a single commit.

property affected_files

list of files modified in this commit

Type

list (str)

property author

Person who committed this change to the associated SCM

Type

User

property commit_id

the SCM ref spec associated with this specific change

Type

str

property message

SCM commit message associated with this change

Type

str