l.c.i.b.IBranchMergeProposalGetter(Interface) : interface documentation

Part of lp.code.interfaces.branchmergeproposal View In Hierarchy

Utility for getting BranchMergeProposals.
Method get Return the BranchMergeProposal with specified id.
Method getProposalsForContext Return BranchMergeProposals associated with the context.
Method getProposalsForParticipant Return BranchMergeProposals associated with the context.
Method getVotesForProposals Return a dict containing a mapping of proposals to vote references.
Method getVoteSummariesForProposals Return the vote summaries for the proposals.
def get(id):
Return the BranchMergeProposal with specified id.
def getProposalsForContext(context, status=None, visible_by_user=None):
Return BranchMergeProposals associated with the context.
ParameterscontextEither an IPerson or IProduct.
statusAn iterable of queue_status of the proposals to return. If None is specified, all the proposals of all possible states are returned.
visible_by_userIf a person is not supplied, only merge proposals based on public branches are returned. If a person is supplied, merge proposals based on both public branches, and the private branches that the person is entitled to see are returned. Private branches are only visible to the owner and subscribers of the branch, and to LP admins.
RaisesBadBranchMergeProposalSearchContextIf the context is not understood.
def getProposalsForParticipant(participant, status=None, visible_by_user=None):
Return BranchMergeProposals associated with the context.
ParametersparticipantAn IPerson that is participating in the merge proposal, either a reviewer or reviewee.
statusAn iterable of queue_status of the proposals to return. If None is specified, all the proposals of all possible states are returned.
visible_by_userIf a person is not supplied, only merge proposals based on public branches are returned. If a person is supplied, merge proposals based on both public branches, and the private branches that the person is entitled to see are returned. Private branches are only visible to the owner and subscribers of the branch, and to LP admins.
def getVotesForProposals(proposals):
Return a dict containing a mapping of proposals to vote references.

The values of the dict are lists of CodeReviewVoteReference objects.

def getVoteSummariesForProposals(proposals):
Return the vote summaries for the proposals.

A vote summary is a dict has a 'comment_count' and may also have values for each of the CodeReviewVote enumerated values.

ReturnsA dict keyed on the proposals.
API Documentation for Launchpad, generated by pydoctor at 2019-02-24 00:00:04.