l.c.i.branch : module documentation

Part of lp.code.interfaces

Branch interfaces.
Class WrongNumberOfReviewTypeArguments Raised in the webservice API if reviewers and review_types
Function get_blacklisted_hostnames Return a list of hostnames blacklisted for Branch URLs.
Class BranchURIField No class docstring; 1/2 methods documented
Function valid_branch_name Return True if the name is valid as a branch name, otherwise False.
Function branch_name_validator Return True if the name is valid, or raise a LaunchpadValidationError.
Class IBranchBatchNavigator A marker interface for registering the appropriate branch listings.
Interface IBranchPublic Public attributes for a branch.
Interface IBranchAnyone Attributes of IBranch that can be changed by launchpad.AnyPerson.
Interface IBranchView IBranch attributes that require launchpad.View permission.
Interface IBranchModerateAttributes IBranch attributes that can be edited by more than one community.
Interface IBranchModerate IBranch methods that can be edited by more than one community.
Interface IBranchEditableAttributes IBranch attributes that can be edited.
Interface IBranchEdit IBranch attributes that require launchpad.Edit permission.
Interface IBranchListingQueryOptimiser Interface for a helper utility to do efficient queries for branches.
Interface IBranchDelta The quantitative changes made to a branch that was edited or altered.
Interface IBranchCloud A utility to generate data for branch clouds.
Class BzrIdentityMixin This mixin class determines the bazaar identities.
Function user_has_special_branch_access Admins and vcs-import members have have special access.
Function get_db_branch_info Return a dict of branch info suitable for Branch.branchChanged.
def get_blacklisted_hostnames():
Return a list of hostnames blacklisted for Branch URLs.
def valid_branch_name(name):
Return True if the name is valid as a branch name, otherwise False.

The rules for what is a valid branch name are described in BRANCH_NAME_VALIDATION_ERROR_MESSAGE.

def branch_name_validator(name):
Return True if the name is valid, or raise a LaunchpadValidationError.
def user_has_special_branch_access(user, branch=None):
Admins and vcs-import members have have special access.
ParametersuserA 'Person' or None.
branchA branch or None when checking collection access.
def get_db_branch_info(stacked_on_url, last_revision_id, control_string, branch_string, repository_string):
Return a dict of branch info suitable for Branch.branchChanged.
Parametersstacked_on_urlThe URL the branch is stacked on.
last_revision_idThe branch tip revision_id.
control_stringThe control format marker as a string.
branch_stringThe branch format marker as a string.
repository_stringThe repository format marker as a string.
API Documentation for Launchpad, generated by pydoctor at 2018-08-14 00:00:04.