l.c.m.b.GenericBranchCollection : class documentation

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

Known subclasses: lp.code.model.branchcollection.AnonymousBranchCollection, lp.code.model.branchcollection.VisibleBranchCollection

See IBranchCollection.
Method __init__ Construct a GenericBranchCollection.
Method count See IBranchCollection.
Method is_empty See IBranchCollection.
Method ownerCounts See IBranchCollection.
Method store Undocumented
Static Method preloadVisibleStackedOnBranches Preload the chains of stacked on branches related to the given list
Static Method preloadDataForBranches Preload branches' cached associated targets, product series, and
Method getBranches See IBranchCollection.
Method getBranchIds See IBranchCollection.
Method getMergeProposals See IBranchCollection.
Method getMergeProposalsForPerson See IBranchCollection.
Method getMergeProposalsForReviewer See IBranchCollection.
Method getExtendedRevisionDetails See IBranchCollection.
Method getTeamsWithBranches See IBranchCollection.
Method inProduct See IBranchCollection.
Method inProjectGroup See IBranchCollection.
Method inDistribution See IBranchCollection.
Method inDistroSeries See IBranchCollection.
Method inDistributionSourcePackage See IBranchCollection.
Method officialBranches See IBranchCollection
Method inSourcePackage See IBranchCollection.
Method isJunk See IBranchCollection.
Method isPrivate See IBranchCollection.
Method isExclusive See IBranchCollection.
Method isSeries See IBranchCollection.
Method ownedBy See IBranchCollection.
Method ownedByTeamMember See IBranchCollection.
Method registeredBy See IBranchCollection.
Method search See IBranchCollection.
Method scanned See IBranchCollection.
Method subscribedBy See IBranchCollection.
Method targetedBy See IBranchCollection.
Method linkedToBugs See IBranchCollection.
Method visibleByUser See IBranchCollection.
Method withBranchType Undocumented
Method withLifecycleStatus See IBranchCollection.
Method modifiedSince See IBranchCollection.
Method scannedSince See IBranchCollection.
Method withIds See IBranchCollection.
Method _filterBy Return a subset of this collection, filtered by 'expressions'.
Method _getBranchSelect Return a Storm 'Select' for columns in this collection.
Method _getBranchExpressions Return the where expressions for this collection.
Method _getBranchVisibilityExpression Return the where clauses for visibility.
Static Method _convertListingSortToOrderBy Compute a value to pass to order_by on a collection of branches.
Method _naiveGetMergeProposals Undocumented
Method _scopedGetMergeProposals Undocumented
Method _getExactMatch Undocumented
def __init__(self, store=None, branch_filter_expressions=None, tables=None, asymmetric_filter_expressions=None, asymmetric_tables=None):
Construct a GenericBranchCollection.
ParametersstoreThe store to look in for branches. If not specified, use the default store.
branch_filter_expressionsA list of Storm expressions to restrict the branches in the collection. If unspecified, then there will be no restrictions on the result set. That is, all branches in the store will be in the collection.
tablesA dict of Storm tables to the Join expression. If an expression in branch_filter_expressions refers to a table, then that table must be in this list.
asymmetric_filter_expressionsAs per branch_filter_expressions but only applies to one side of reflexive joins.
asymmetric_tablesAs per tables, for asymmetric_filter_expressions.
def count(self):
See IBranchCollection.
def is_empty(self):
See IBranchCollection.
def ownerCounts(self):
See IBranchCollection.
@property
def store(self):
Undocumented
def _filterBy(self, expressions, table=None, join=None, symmetric=True):
Return a subset of this collection, filtered by 'expressions'.
ParameterssymmetricIf True this filter will apply to both sides of merge proposal lookups and any other lookups that join Branch back onto Branch.
def _getBranchSelect(self, columns=(Branch.id,)):
Return a Storm 'Select' for columns in this collection.
def _getBranchExpressions(self):
Return the where expressions for this collection.
def _getBranchVisibilityExpression(self, branch_class=None):
Return the where clauses for visibility.
@staticmethod
def preloadVisibleStackedOnBranches(branches, user=None):
Preload the chains of stacked on branches related to the given list of branches. Only the branches visible for the given user are preloaded/returned.
@staticmethod
def preloadDataForBranches(branches):
Preload branches' cached associated targets, product series, and suite source packages.
@staticmethod
def _convertListingSortToOrderBy(sort_by):
Compute a value to pass to order_by on a collection of branches.
Parameterssort_byan item from the BranchListingSort enumeration.
def getBranches(self, find_expr=Branch, eager_load=False, sort_by=None):
See IBranchCollection.
def getBranchIds(self):
See IBranchCollection.
def getMergeProposals(self, statuses=None, for_branches=None, target_branch=None, prerequisite_branch=None, merged_revnos=None, merged_revision=None, eager_load=False):
See IBranchCollection.
def _naiveGetMergeProposals(self, statuses=None, for_branches=None, target_branch=None, prerequisite_branch=None, merged_revnos=None, merged_revision=None, eager_load=False):
Undocumented
def _scopedGetMergeProposals(self, statuses, eager_load=False):
Undocumented
def getMergeProposalsForPerson(self, person, status=None, eager_load=False):
See IBranchCollection.
def getMergeProposalsForReviewer(self, reviewer, status=None):
See IBranchCollection.
def getExtendedRevisionDetails(self, user, revisions):
See IBranchCollection.
def getTeamsWithBranches(self, person):
See IBranchCollection.
def inProduct(self, product):
See IBranchCollection.
def inProjectGroup(self, projectgroup):
See IBranchCollection.
def inDistribution(self, distribution):
See IBranchCollection.
def inDistroSeries(self, distro_series):
See IBranchCollection.
def inDistributionSourcePackage(self, distro_source_package):
See IBranchCollection.
def officialBranches(self, pocket=None):
See IBranchCollection
def inSourcePackage(self, source_package):
See IBranchCollection.
def isJunk(self):
See IBranchCollection.
def isPrivate(self):
See IBranchCollection.
def isExclusive(self):
See IBranchCollection.
def isSeries(self):
See IBranchCollection.
def ownedBy(self, person):
See IBranchCollection.
def ownedByTeamMember(self, person):
See IBranchCollection.
def registeredBy(self, person):
See IBranchCollection.
def _getExactMatch(self, term):
Undocumented
def search(self, term):
See IBranchCollection.
def scanned(self):
See IBranchCollection.
def subscribedBy(self, person):
See IBranchCollection.
def targetedBy(self, person, since=None):
See IBranchCollection.
def linkedToBugs(self, bugs):
See IBranchCollection.
def visibleByUser(self, person):
See IBranchCollection.
def withBranchType(self, *branch_types):
Undocumented
def withLifecycleStatus(self, *statuses):
See IBranchCollection.
def modifiedSince(self, epoch):
See IBranchCollection.
def scannedSince(self, epoch):
See IBranchCollection.
def withIds(self, *branch_ids):
See IBranchCollection.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.