l.c.b.b.BranchMergeProposalListingItem : class documentation

Part of lp.code.browser.branchmergeproposallisting View In Hierarchy

A branch merge proposal that knows summary values for comments.
Method __init__ Undocumented
Method vote_summary_items A generator of votes.
Method vote_type_count The number of vote types used on this proposal.
Method comment_count The number of comments (that aren't votes).
Method has_no_activity True if no votes and no comments.
Method reviewer_vote A vote from the specified reviewer.
Method sort_key The value to order by.
def __init__(self, branch_merge_proposal, summary, proposal_reviewer, vote_references=None):
Undocumented
@property
def vote_summary_items(self):
A generator of votes.

This is iterated over in TAL, and provides a items that are dict's for simple TAL traversal.

The dicts contain the name and title of the enumerated vote type, the count of those votes and the reviewers whose latest review is of that type.

@property
def vote_type_count(self):
The number of vote types used on this proposal.
@property
def comment_count(self):
The number of comments (that aren't votes).
@property
def has_no_activity(self):
True if no votes and no comments.
@property
def reviewer_vote(self):
A vote from the specified reviewer.
@property
def sort_key(self):
The value to order by.

This defaults to date_review_requested, but there are occasions where this is not set if the proposal went directly from work in progress to approved. In this case the date_reviewed is used.

The value is always not None as proposals in needs review state will always have date_review_requested set, and approved proposals will always have date_reviewed set. These are the only two states that are shown in the active reviews page, so they can always be sorted on.

API Documentation for Launchpad, generated by pydoctor at 2020-02-19 00:00:13.