l.c.m.b.RevisionsAddedJob(BranchJobDerived) : class documentation

Part of lp.code.model.branchjob View In Hierarchy

A job for sending emails about added revisions.
Class Method create Undocumented
Method __init__ Undocumented
Method bzr_branch Undocumented
Method last_scanned_id Undocumented
Method last_revision_id Undocumented
Method from_address Undocumented
Method iterAddedMainline Iterate through revisions added to the mainline.
Method generateDiffs Determine whether to generate diffs.
Method run Send all the emails about all the added revisions.
Method getDiffForRevisions Generate the diff between from_revision_id and to_revision_id.
Method getMailerForRevision Return a BranchMailer for a revision.
Method getMergedRevisionIDs Determine which revisions were merged by this revision.
Method getAuthors Determine authors of the revisions merged by this revision.
Method findRelatedBMP Find merge proposals related to the revision-ids and branch.
Method getRevisionMessage Return the log message for a revision.

Inherited from BranchJobDerived:

Method __repr__ Undocumented
Method __eq__ Undocumented
Method __ne__ Undocumented
Class Method iterReady See IRevisionMailJobSource.
Class Method get Return the instance of this class whose key is supplied.
Method getOopsVars See IRunnableJob.
Method getErrorRecipients Return a list of email-ids to notify about user errors.

Inherited from BaseRunnableJob (via BranchJobDerived):

Method __lt__ Undocumented
Method getOopsRecipients Return a list of email-ids to notify about oopses.
Method getOperationDescription Undocumented
Method getOopsMailController Return a MailController for notifying people about oopses.
Method getUserErrorMailController Return a MailController for notifying about user errors.
Method notifyOops Report this oops.
Method notifyUserError See IRunnableJob.
Method makeOopsReport Generate an OOPS report using the given OOPS configuration.
Method acquireLease Undocumented
Method taskId Return a task ID that gives a clue what this job is about.
Method runViaCelery Request that this job be run via celery.
Method getDBClass Undocumented
Method celeryCommitHook Hook function to call when a commit completes.
Method celeryRunOnCommit Configure transaction so that commit runs this job via Celery.
Method queue See IJob.

Inherited from BaseRunnableJobSource (via BranchJobDerived, BaseRunnableJob):

Static Method contextManager Undocumented
@classmethod
def create(cls, branch, last_scanned_id, last_revision_id, from_address):
Undocumented
def __init__(self, context):
Undocumented
@property
def bzr_branch(self):
Undocumented
@property
def last_scanned_id(self):
Undocumented
@property
def last_revision_id(self):
Undocumented
@property
def from_address(self):
Undocumented
def iterAddedMainline(self):
Iterate through revisions added to the mainline.
def generateDiffs(self):
Determine whether to generate diffs.
def run(self):
Send all the emails about all the added revisions.
def getDiffForRevisions(self, from_revision_id, to_revision_id):
Generate the diff between from_revision_id and to_revision_id.
def getMailerForRevision(self, revision, revno, generate_diff):
Return a BranchMailer for a revision.
ParametersrevisionA bzr revision.
revnoThe revno of the revision in this branch.
generate_diffsIf true, generate a diff for the revision.
def getMergedRevisionIDs(self, revision_id, graph):
Determine which revisions were merged by this revision.
Parametersrevision_idID of the revision to examine.
grapha bzrlib.graph.Graph.
Returnsa set of revision IDs.
def getAuthors(self, revision_ids, graph):
Determine authors of the revisions merged by this revision.

Ghost revisions are skipped. :param revision_ids: The revision to examine. :return: a set of author commit-ids

def findRelatedBMP(self, revision_ids):
Find merge proposals related to the revision-ids and branch.

Only proposals whose source branch last-scanned-id is in the set of revision-ids and whose target_branch is the BranchJob branch are returned.

Only return the most recent proposal for any given source branch.

Parametersrevision_idsA list of revision-ids to look for.
include_supersededIf true, include merge proposals that are superseded in the results.
def getRevisionMessage(self, revision_id, revno):
Return the log message for a revision.
Parametersrevision_idThe revision-id of the revision.
revnoThe revno of the revision in the branch.
ReturnsThe log message entered for this revision.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.