lp.bugs.interfaces.bugwatch.IBugWatchSet : API documentation

Int	bug	Undocumented
Attribute	title	Title
Method	__getitem__	Get a BugWatch
Method	__iter__	Iterate through BugWatches for a given bug.
Method	get	Get an IBugWatch by its ID.
Method	search	Search through all the IBugWatches in the system.
Method	fromText	Create one or more BugWatch's by analysing the given text. This
Method	fromMessage	Create one or more BugWatch's by analysing the given email. The
Method	createBugWatch	Create an IBugWatch.
Method	extractBugTrackerAndBug	Extract the bug tracker and the bug number for the given URL.
Method	getBugWatchesForRemoteBug	Returns bug watches referring to the given remote bug.
Method	bulkSetError	Efficiently update the status of the given bug watches.
Method	bulkAddActivity	Efficiently add activity for the given bug watches.

def __getitem__(key):

Get a BugWatch

def __iter__():

Iterate through BugWatches for a given bug.

def get(id):

Get an IBugWatch by its ID.

Raise a NotFoundError if there is no IBugWatch matching the given id.

def search():

Search through all the IBugWatches in the system.

def fromText(text, bug, owner):

Create one or more BugWatch's by analysing the given text. This will look for reference to known or new bug tracking instances and create the relevant watches. It returns a (possibly empty) list of watches created.

def fromMessage(message, bug):

Create one or more BugWatch's by analysing the given email. The owner of the BugWatch's will be the sender of the message. It returns a (possibly empty) list of watches created.

def createBugWatch(bug, owner, bugtracker, remotebug):

Create an IBugWatch.

Unknown Field: bug	The IBug to which the watch is linked.
Unknown Field: owner	The IPerson who created the IBugWatch.
Unknown Field: bugtracker	The external IBugTracker.
Unknown Field: remotebug	A string.

def extractBugTrackerAndBug(url):

Extract the bug tracker and the bug number for the given URL.

A tuple in the form of (bugtracker, remotebug) is returned, where bugtracker is a registered IBugTracer, and remotebug is a text string.

A NoBugTrackerFound exception is raised if the base URL can be extracted, but no such bug tracker is registered in Launchpad.

If no bug tracker type can be guessed, None is returned.

def getBugWatchesForRemoteBug(remote_bug, bug_watch_ids=None):

Returns bug watches referring to the given remote bug.

Returns a set of those bug watches, optionally limited to those with IDs in bug_watch_ids, that refer to remote_bug.

Parameters	remote_bug_id	The ID of the remote bug. (type: See `IBugWatch.remotebug`.)
	bug_watch_ids	A collection of `BugWatch` IDs. (type: An iterable of int`s, or `None.)

def bulkSetError(references, last_error_type=None):

Efficiently update the status of the given bug watches.

Sets the last_error_type field as instructed, updates lastchecked to now and resets next_check to None, all in the most efficient way possible.

Parameters	references	An iterable of `IBugWatch` objects or primary keys for the same.
	last_error_type	A member of `BugWatchActivityStatus` or None.

def bulkAddActivity(references, result=BugWatchActivityStatus.SYNC_SUCCEEDED, message=None, oops_id=None):

Efficiently add activity for the given bug watches.

Add BugWatchActivity records for the given bug watches in the most efficient way possible.

Parameters	references	An iterable of `IBugWatch` objects or primary keys for the same.
	result	See `IBugWatch.addActivity`.
	message	See `IBugWatch.addActivity`.
	oops_id	See `IBugWatch.addActivity`.

l.b.i.b.IBugWatchSet(Interface) : interface documentation