lp.bugs.interfaces.webservice.IBugTracker : API documentation

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.

def getBugFilingAndSearchLinks(remote_product, summary=None, description=None, remote_component=None):

Return the bug filing and search links for the tracker.

Parameters	remote_product	The name of the product on which the bug is to be filed or searched for.
	summary	The string with which to pre-filly the summary field of the upstream bug tracker's search and bug filing forms.
	description	The string with which to pre-filly the description field of the upstream bug tracker's bug filing form.
	remote_component	The name of the component on which the bug is to be filed or search for.
Returns	A 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 getLinkedPersonByName(name):

Return the IBugTrackerPerson for a given name on a bugtracker.

Parameters	name	The name of the person on the bugtracker in `bugtracker`.
Returns	an `IBugTrackerPerson`.

def linkPersonToSelf(name, person):

Link a Person to the BugTracker using a given name.

Parameters	name	The name used for person on bugtracker.
	person	The `IPerson` to link to bugtracker.
Returns	An `IBugTrackerPerson`.
Raises	BugTrackerPersonAlreadyExists	If `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.

Parameters	bugtracker	The `IBugTracker` for which we should have a given Person.
	display_name	The name of the Person on `bugtracker`.
	email	The 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.
	rationale	The `PersonCreationRationale` used to create a new `IPerson` for this `name` and `bugtracker`, if necessary.
	creation_comment	The creation comment for the `IPerson` if one is created.

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 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.

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