BugList - tutorial

This is still work in progress

General workflow

This is how to use python-launchpad-bugs to get a list of bugs

   1 >>> from launchpadbugs.connector import ConnectBugList
   2 >>> BugList = ConnectBugList() # using the html mode
   3 >>> bl = BugList("https://bugs.launchpad.net/ubuntu/+source/bughelper/+bugs")

If you need a faster method to fetch the bug list but can abdicate additional information like status and importance of a bugreport it is possible to use the text mode of launchpad:

   2 >>> BugList = ConnectBugList("text") # using the text mode

In some cases, e.g. if the resulting lists should contain private bugreports, authentication is necessary

   4 >>> BugList.authentication="cookie.txt" #for text-based mozilla cookie files   or
   5 >>> BugList.authentication="cookie.sql" #for sql mozilla cookie files

It is also possible to do authentication via email-login and password. Note: This takes much longer than using cookie files, therefore python-launchpad-bugs provides a method to save the resulting cookie into a file

   7 >>> BugList.authentication={"email": "login@email.com", "passwort": "YourPassword"}
   8 >>> BugList.connection.save_cookie("/home/markus/.lpcookie")

There are currently different versions of launchpad, the stable bugs.launchpad.net and the testing environment bugs.edge.launchpad.net. Sometimes it makes sense to explicitly choose one of these versions to work with. In python-launchpad-bugs it is possible to define which version to use.

   1 >>> from launchpadbugs.lpconstants import HTTPCONNECTION
   2 >>> BugList.set_connection_mode(HTTPCONNECTION.MODE.EDGE) # or
   3 >>> BugList.set_connection_mode(HTTPCONNECTION.MODE.STABLE)

Bug list objects

BugList objects are set-like objects, each member is an instance of LPBugInfo.

   1 >>> bl
   2 <BugList https://bugs.launchpad.net/ubuntu/+source/bughelper/+bugs>
   3 >>> print bl
   4 BugList([<BugInfo 129341>,<BugInfo 88102>,<BugInfo 150887>])
   5 >>> len(bl)
   6 3

LPBugInfo

A LPBugInfo object has this attribute:

   1 >>> b = bl.pop()
   2 >>> b
   3 <BugInfo 239007>
   4 >>> print b
   5 [Bug 239007 : Confirmed/Undecided]
   6 >>> int(b)
   7 239007

Adding some (upstream) bugs to the set

It is easy to merge two BugList-objects

   1 >>> bl
   2 <BugList https://bugs.launchpad.net/ubuntu/+source/bughelper/+bugs>
   3 >>> bl += BugList("https://bugs.launchpad.net/bughelper/+bugs")
   4 >>> len(bl)
   5 14

Filtering bug lists

With python-launchpad-bugs 0.3 there is a new way of filtering bug lists. First of all: there are two different ways of filtering

• Filtering while fetching the list
• Filtering the actual object

The way mentioned by the last item can easily be done by using python's buildin filter() function and does not change the actual object.BR In contrast the first way is irreversible. It is possible to use URL-based filter options (options provided by advanced-search of launchpad) or functions to filter elements. This functions take an element of the bug list as the only argument and return either False or an instance of LPBugInfo or LPBug. If False is returned the related element is filtered out of the list.

As a very basic example let's have a look at all bugs in the bughelper project which have an even bugnumber and which importance is either "Medium" or "Low"

   1 >>> from launchpadbugs.basebuglistfilter import URLBugListFilter
   2 >>> bug_filter = URLBugListFilter()
   3 >>> bug_filter.add_option("importance", ("Medium", "Low"))
   4 >>> bug_filter.functions.append(lambda x: not int(x) % 2 and x)
   5 >>> bl =  BugList(bug_filter("https://bugs.launchpad.net/bughelper/+bugs"))
   6 >>> print bl
   7 BugList([<BugInfo 131378>,<BugInfo 88102>])

Sorting the list of bugs

LPBugList objects do also have a .sort(<key>) method which returns a sorted list. <key> could be nr, status or importance with an optional leading - for reverse order.

   1 >>> bl =  BugList("https://bugs.launchpad.net/ubuntu/+source/bughelper/+bugs")
   2 >>> print [str(i) for i in bl]
   3 ['[Bug 239007 : Confirmed/Undecided]', '[Bug 129341 : New/Wishlist]', '[Bug 88102 : Confirmed/Undecided]', '[Bug 150887 : In Progress/Wishlist]']
   4 >>> print [str(i) for i in bl.sort("-status")]
   5 ['[Bug 129341 : New/Wishlist]', '[Bug 239007 : Confirmed/Undecided]', '[Bug 88102 : Confirmed/Undecided]', '[Bug 150887 : In Progress/Wishlist]']

Raised Exeptions

If the url given as an argument to the buglist is not valid in launchpad a LaunchpadURLError-Error will be raised

   1 >>> from launchpadbugs.exceptions import LaunchpadURLError
   2 >>> try:
   3 ...     bl =  BugList("https://bugs.launchpad.net/ubuntu/+source/bughelpcxcxcver/+bugs")
   4 ... except LaunchpadURLError, e:
   5 ...     print e
   6 ... 
   7     * message: Page not found
   8     * url: https://bugs.launchpad.net/ubuntu/+source/bughelpcxcxcver/+bugs

New to python-launchpad-bugs 0.3 is that this types of errors always return the url in question.

More on custom filter functions

Another new feature of python-launchpad-bugs 0.3 are filter functions which are able to stop the entire fetching process. Let's say

Go Back to [:BugHelper/Dev].BR CategoryBugHelper