l.b.i.w.IBugTracker(Interface) : interface documentation

Part of lp.bugs.interfaces.webservice View In Hierarchy

A remote bug system.

Launchpadlib example: What bug tracker is used for a distro source package?

product = source_package.upstream_product
if product:
    tracker = product.bug_tracker
    if not tracker:
        project = product.project_group
        if project:
            tracker = project.bug_tracker
if tracker:
    print "%s at %s" %(tracker.bug_tracker_type, tracker.base_url)
Int id Undocumented
Attribute products The products that use this bug tracker.
Attribute latestwatches The last 10 watches created.
Attribute imported_bug_messages Bug messages that have been imported from this bug tracker.
Attribute multi_product This bug tracker tracks multiple remote products.
Attribute watches_ready_to_check The set of bug watches that are scheduled to be checked.
Attribute watches_with_unpushed_comments The set of bug watches that have unpushed comments.
Attribute watches_needing_update The set of bug watches that need updating.
Method getBugFilingAndSearchLinks Return the bug filing and search links for the tracker.
Method getBugsWatching Get the bugs watching the given remote bug in this bug tracker.
Method getLinkedPersonByName Return the IBugTrackerPerson for a given name on a bugtracker.
Method linkPersonToSelf Link a Person to the BugTracker using a given name.
Method ensurePersonForSelf Return the correct IPerson for a given name on a bugtracker.
Method destroySelf Delete this bug tracker.
Method resetWatches Reset the next_check times of this BugTracker's `BugWatch`es.
Method addRemoteComponentGroup Adds a new component group to the bug tracker
Method getAllRemoteComponentGroups Return collection of all component groups for this bug tracker
Method getRemoteComponentGroup Retrieve a given component group registered with the bug tracker.
Method getRemoteComponentForDistroSourcePackageName Returns the component linked to this source package, if any.
Method getRelatedPillars Returns the `IProduct`s and `IProjectGroup`s that use this tracker.
id =
Undocumented
products =
The products that use this bug tracker.
latestwatches =
The last 10 watches created.
imported_bug_messages =
Bug messages that have been imported from this bug tracker.
multi_product =
This bug tracker tracks multiple remote products.
watches_ready_to_check =
The set of bug watches that are scheduled to be checked.
watches_with_unpushed_comments =
The set of bug watches that have unpushed comments.
watches_needing_update =
The set of bug watches that need updating.
def getBugFilingAndSearchLinks(remote_product, summary=None, description=None, remote_component=None):
Return the bug filing and search links for the tracker.
Parametersremote_productThe name of the product on which the bug is to be filed or searched for.
summaryThe string with which to pre-filly the summary field of the upstream bug tracker's search and bug filing forms.
descriptionThe string with which to pre-filly the description field of the upstream bug tracker's bug filing form.
remote_componentThe name of the component on which the bug is to be filed or search for.
ReturnsA dict of the absolute URL of the bug filing form and the search form for remote_product on the remote tracker, in the form {'bug_filing_url': foo, 'search_url': bar}. If either or both of the URLs is unavailable for the current BugTrackerType the relevant values in the dict will be set to None. If the bug tracker requires a remote_product but None is passed, None will be returned for both values in the dict.
def getBugsWatching(remotebug):
Get the bugs watching the given remote bug in this bug tracker.
def getLinkedPersonByName(name):
Return the IBugTrackerPerson for a given name on a bugtracker.
ParametersnameThe name of the person on the bugtracker in bugtracker.
Returnsan IBugTrackerPerson.
def linkPersonToSelf(name, person):
Link a Person to the BugTracker using a given name.
ParametersnameThe name used for person on bugtracker.
personThe IPerson to link to bugtracker.
ReturnsAn IBugTrackerPerson.
RaisesBugTrackerPersonAlreadyExistsIf name has already been used to link a person to bugtracker.
def ensurePersonForSelf(display_name, email, rationale, creation_comment):
Return the correct IPerson for a given name on a bugtracker.
ParametersbugtrackerThe IBugTracker for which we should have a given Person.
display_nameThe name of the Person on bugtracker.
emailThe Person's email address if available. If email is supplied a Person will be created or retrieved using that email address and no IBugTrackerPerson records will be created.
rationaleThe PersonCreationRationale used to create a new IPerson for this name and bugtracker, if necessary.
creation_commentThe creation comment for the IPerson if one is created.
def destroySelf():
Delete this bug tracker.
def resetWatches(new_next_check=None):
Reset the next_check times of this BugTracker's `BugWatch`es.

:param new_next_check: If specified, contains the datetime to
    which to set the BugWatches' next_check times.  If not
    specified, the watches' next_check times will be set to a
    point between now and 24 hours hence.
@operation_parameters(TextLine(u'The name of the remote component group', True))
@operation_returns_entry(Interface)
@export_write_operation()
def addRemoteComponentGroup(component_group_name):
Adds a new component group to the bug tracker
@export_read_operation()
@operation_returns_collection_of(Interface)
def getAllRemoteComponentGroups():
Return collection of all component groups for this bug tracker
@operation_parameters(TextLine(u'The name of the remote component group', True))
@operation_returns_entry(Interface)
@export_read_operation()
def getRemoteComponentGroup(component_group_name):
Retrieve a given component group registered with the bug tracker.
Parameterscomponent_group_nameName of the component group to retrieve.
@operation_parameters(TextLine(u'The distribution for the source package', True), TextLine(u'The source package name', True))
@operation_returns_entry(Interface)
@export_read_operation()
@operation_for_version('devel')
def getRemoteComponentForDistroSourcePackageName(distribution, sourcepackagename):
Returns the component linked to this source package, if any.

If no components have been linked, returns value of None.

def getRelatedPillars(user=None):
Returns the `IProduct`s and `IProjectGroup`s that use this tracker.
        
API Documentation for Launchpad, generated by pydoctor at 2020-08-04 00:00:04.