Diff for "API/launchpadlib"

Not logged in - Log In / Register

Differences between revisions 23 and 80 (spanning 57 versions)
Revision 23 as of 2008-08-15 22:00:13
Size: 13714
Editor: leonardr
Comment:
Revision 80 as of 2021-10-07 16:05:43
Size: 25309
Editor: cjwatson
Comment: python3-launchpadlib, and remove outdated advice on installing from branches
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
~-[[FrontPage|Launchpad Help]] > [[API]] > Examples -~

||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>||
Line 11: Line 15:
with Launchpad's web service: for that, see the web service reference
documentation (external link forthcoming).
with Launchpad's web service: for that, see the [[http://launchpad.net/+apidoc/|web service reference documentation]]. Check out the [[API/Examples|API examples page]] if you would like to see more sample code.
Line 19: Line 22:

One part of Launchpad is exposed through the web service, but not
supported by the current version of launchpadlib:

 * Uploaded files, such as bug attachments


As new features and capabilities are added to the web service, you'll be able to access most of them without having to update your copy of launchpadlib. You _will_ have to upgrade launchpadlib to get new client-side features (like support for uploaded files). The Launchpad team will put out an announcement whenever a server-side change means you should upgrade launchpadlib.
 * The project registry
 * Hosted files, such as bug attachments and mugshots.

As new features and capabilities are added to the web service, you'll be able to access most of them without having to update your copy of launchpadlib. You ''will'' have to upgrade launchpadlib to get new client-side features (like support for uploaded files). The Launchpad team will put out an announcement whenever a server-side change means you should upgrade launchpadlib.
Line 29: Line 29:
The launchpadlib library depends on wadllib, another open-source
library released by the Launchpad team. Get a copy of the wadllib
source with bzr and install it.

{{{
  $ bzr branch lp:wadllib
  $ cd wadllib
  $ sudo ./setup.py install
}}}

Then do the same for launchpadlib.

{{{
  $ bzr branch lp:launchpadlib
  $ cd launchpadlib
  $ sudo ./setup.py install
}}}
== The launchpadlib in Ubuntu (easy to install) ==

If you have the latest version of Ubuntu then to install the launchpadlib available in the Ubuntu repositories, open a terminal and run the command:

{{{
  $ sudo apt-get install python3-launchpadlib
}}}

And you are done!

If you have an older version of Ubuntu then parts of the instructions below may not work with the version from the repositories but you should be able to install the latest version of launchpadlib manually.

== launchpad using pip ==

On any platform with a working Python and pip, you should be able to say:

{{{
  pip install launchpadlib
}}}
Line 50: Line 51:
The first step towards using Launchpad's web service is setting up
credentials for your client. Run this code in a Python session:

{{{
    from launchpadlib.launchpad import Launchpad, STAGING_SERVICE_ROOT
    launchpad = Launchpad.get_token_and_login('just testing', STAGING_SERVICE_ROOT)
}}}

The first argument is a string that identifies the web service client. We use this string to gauge client
popularity and detect buggy or inefficient clients. Here, though, we're just testing.

The second argument is the URL to the web service. Here, we're using STAGING_SERVICE_ROOT, which is "https://api.staging.launchpad.net/beta/". These examples run against the staging data, so that we don't change real data when we're just trying to see how launchpadlib works.

Once you're ready to write a launchpadlib program that changes real data, you can replace
STAGING_SERVICE_ROOT with EDGE_SERVICE_ROOT.

You'll see a message like this:

{{{
 The authorization page
 (https://staging.launchpad.net/+authorize-token?oauth_token=xxxxxxxxx)
 should be opening in your browser. After you have authorized this
 program to access Launchpad on your behalf you should come back here
 and press <Enter> to finish the authentication process.
}}}

Your web browser will open to a page at launchpad.net. You'll be asked
to login to Launchpad, and grant some level of access to your new
credentials. The level of access you choose will determine how much you
can do through launchpadlib with these credentials. This lets your users
delegate a portion of their Launchpad permissions to your program,
without having to trust it completely.

Once you grant access, hit Enter within your Python session. You'll
get back a Launchpad object. Now you can access the web service.

Here's some code that retrieves a bug from Launchpad and prints its
title.
The first step towards using Launchpad's web service is to choose a cache directory. The documents you retrieve from Launchpad will be stored here, which will save you a lot of time. Run this code in a Python session, substituting an appropriate directory on your computer:

{{{
    cachedir = "/home/me/.launchpadlib/cache/"
}}}

The next step is to set up credentials for your client. For quick read-only access to Launchpad data, you can get anonymous access. Otherwise, you'll need to authenticate with Launchpad using OAuth.

== Anonymous access ==

The `Launchpad.login_anonymously()` method will give you automatic read-only access to public Launchpad data.

{{{
    from launchpadlib.launchpad import Launchpad
    launchpad = Launchpad.login_anonymously('just testing', 'production', cachedir, version='devel')
}}}

The first argument to `Launchpad.login_anonymously()` is a string that identifies the web service client. We use this string to gauge client popularity and detect buggy or inefficient clients. Here, though, we're just testing.

The second argument tells launchpadlib which Launchpad instance to run against. Here, we're using `production`, which is mapped to the web service root on the production Launchpad server: "https://api.launchpad.net/". Anonymous access cannot change the Launchpad dataset, so there's no concern about a bad test program accidentally overwriting data. (If you want to play it safe, you could use 'staging' instead - though staging is sometimes down for extended periods.)

The `version` argument specifies the API version to use. For historical reasons the default is `'1.0'`, and you may want to use this in certain special circumstances, but in most cases you should use `'devel'` so that you get a reasonably complete and current interface.

The `login_anonymously()` method automatically negotiates a read-only credential with Launchpad. You can use your `Launchpad` object right away.
Line 91: Line 78:
    print bug_one.title     print(bug_one.title)
Line 95: Line 82:
Before proceeding further, save your credentials so that you don't
have to do the get_token_and_login dance again the next time you need
to access the web service.

{{{
    launchpad.credentials.save(file("some-file.txt", "w"))
}}}

Let's create a new Launchpad object from saved credentials right now.
You'll get an error if you try to modify the dataset, access private data, or access objects like `launchpad.me` which assume a particular user is logged in.

Note that `login_anonymously()` is only available in launchpadlib starting in version 1.5.4.

== Authenticated access ==

To get read-write access to Launchpad, or to see a user's private
data, you'll need to get an OAuth credential for that user. If you're
writing an application that the user will run on their own computer,
this is easy: just call the `Launchpad.login_with()` method.

This method takes two important arguments: the name of your
application, and the name of the Launchpad server you want to run
against. The default server name is 'staging', so that you don't
destroy data by accident while developing. When you do a release, you
can change this to 'production'.

{{{
    from launchpadlib.launchpad import Launchpad
    launchpad = Launchpad.login_with('My Application', 'staging', version='devel')
}}}


''If this code complains that 'staging' isn't a URL, then you're not running the most up-to-date launchpadlib. You can replace 'staging' with `launchpadlib.launchpad.STAGING_SERVICE_ROOT` to make it work in Ubuntu 9.10's launchpadlib.''

If you have an existing desktop-wide Launchpad credential,
launchpadlib will find it and use it. If there's no existing desktop
credential (because you've never used a launchpadlib application on
this computer, or because you had a credential that expired),
launchpadlib will guide you through authorizing a new credential, as
seen [[API/ThirdPartyIntegration|here]].

There's one other important argument to `login_with()`. You can pass
in a callback function as `credential_save_failed`. That function will
be invoked if a desktop credential can't be created--either because
the end-user refused to perform the authorization, or because there
was a problem storing the credential after authorization.

{{{
    import sys
    from launchpadlib.launchpad import Launchpad

    def no_credential():
        print("Can't proceed without Launchpad credential.")
 sys.exit()

    launchpad = Launchpad.login_with(
        'My Application', 'staging', credential_save_failed=no_credential, version='devel')
}}}

== Authenticated access for website integration ==

Things are a little more difficult if you want to integrate
Launchpad's functionality into your own website. You can't call
`Launchpad.login_with()`, because that will open up a web browser on
your webserver--not on your user's computer.

Instead, you create a `Credentials` object identifying your website
and call `get_request_token()` to ask Launchpad for a request
token. Be sure to pass in the name of the Launchpad server you want to
use (probably "production" as `web_root`.
Line 107: Line 146:
    credentials = Credentials()
    credentials.load(open("some-file.txt"))
    launchpad = Launchpad(credentials, STAGING_SERVICE_ROOT)

    bug_one = launchpad.bugs[1]
    print bug_one.title
    # Microsoft has a majority market share
}}}
    credentials = Credentials("my website")
    request_token_info = credentials.get_request_token(web_root="production")
}}}

You'll get back a string that looks like
'https://launchpad.net/+authorize-token?oauth_token=...' This is the
URL your end-user needs to visit in order to authorize your token.

At this point, you should redirect your user to that URL. Then, start
periodically calling `exchange_request_token_for_access_token()`:

{{{
    from lazr.restfulclient.errors import HTTPError
    complete = False
    while not complete:
        try:
            credentials.exchange_request_token_for_access_token(
         web_root="production")
      complete = True
        except HTTPError:
     # The user hasn't authorized the token yet.
}}}

Once `exchange_request_token_for_access_token()` successfully
executes, an authorized access token will be present in
`credentials.access_token`. You can then pass the `Credentials` object
into the `Launchpad` constructor.

{{{
    from launchpadlib.launchpad import Launchpad
    launchpad = Launchpad(credentials, service_root="production")
}}}

You might have noticed that system is pretty hacky. It hasn't gotten
much attention, because we don't know of any third-party websites that
are integrating Launchpad functionality in a way that requires OAuth
tokens.
Line 121: Line 188:
 * lp_attributes: Data fields of this object. You can read from these might be able to write to some of them.
 * lp_collections: List of launchpad objects associated with this object.
 * lp_entries: Other Launchpad objects associated with this one.
 * lp_operations: The names of Launchpad methods you can call on the object.

{{{
   print sorted(bug_one.lp_attributes)
 * `lp_attributes`: Data fields of this object. You can read from these might be able to write to some of them.
 * `lp_collections`: List of launchpad objects associated with this object.
 * `lp_entries`: Other Launchpad objects associated with this one.
 * `lp_operations`: The names of Launchpad methods you can call on the object.

{{{
   print(sorted(bug_one.lp_attributes))
Line 129: Line 196:
   print sorted(bug_one.lp_operations)    print(sorted(bug_one.lp_operations))
Line 133: Line 200:
If you need more detailed help, you can look the object up in [[http://people.ubuntu.com/~flacoste/launchpad-api-doc.html|the reference documentation]]. First, find out the type of the object.

{{{
    print repr(bug_one)
If you need more detailed help, you can look the object up in [[http://launchpad.net/+apidoc|the reference documentation]]. First, find out the type of the object.

{{{
    print(repr(bug_one))
Line 140: Line 207:
This is a 'bug' type object. Now you use the type of the object as an anchor into the reference documentation. To find out the capabilities of this object and what data is stored inside it, you'd visit http://people.ubuntu.com/~flacoste/launchpad-api-doc.html#bug. This is a 'bug' type object. Now you use the type of the object as an anchor
into the reference documentation. To find out the capabilities of this object
and what data is stored inside it, you'd visit https://launchpad.net/+apidoc#bug.
Line 152: Line 221:
of Launchpad. Currently there are two of these attributes,
launchpad.bugs, launchpad.people, and launchpad.me. You've already seen
launchpad.bugs. launchpad.me is an alias for your own user account.
of Launchpad. These are:

 * `.bugs`: All the bugs in Launchpad
 * `.people`: All the people in Launchpad
 * `.me`: You
 * `.distributions`: All the distributions in Launchpad
 * `.projects`: All the projects in Launchpad
 * `.project_groups`: All the project groups in Launchpad

As a super special secret, `distributions`, `projects` and `project_groups` are all actually the same thing.
Line 158: Line 234:
    print me.name     print(me.name)
Line 162: Line 238:
The launchpad.people attribute gives you access to other people who use The `launchpad.people` attribute gives you access to other people who use
Line 169: Line 245:
    print salgado.display_name     print(salgado.display_name)
Line 178: Line 254:
    print salgado.display_name     print(salgado.display_name)
Line 186: Line 262:
        print person.name         print(person.name)
Line 195: Line 271:

== Entries ==
Note that, unlike typical Python methods, these methods--`find()` and `getByEmail()`--don't support positional arguments, only keyword arguments. You can't call `people.find("salgado")`; it has to be `people.find(text="salgado")`.
 

= Entries =
Line 207: Line 285:
'name' and 'display_name' are facts about people.

{{{
    print salgado.name
`name` and `display_name` are facts about people.

{{{
    print(salgado.name)
Line 213: Line 291:
    print salgado.display_name     print(salgado.display_name)
Line 217: Line 295:
'private' and 'description' are facts about bugs.

{{{
    print bug_one.private
`private` and `description` are facts about bugs.

{{{
    print(bug_one.private)
Line 223: Line 301:
    print bug_one.description     print(bug_one.description)
Line 229: Line 307:
Every entry has a 'self_link' attribute. You can treat this as a
permanent ID for the entry. If your program needs to keep track of
Launchpad objects across multiple runs, a simple way to do it is to
keep track of the self_links.

{{{
    print salgado.self_link
    # https://api.staging.launchpad.net/beta/~salgado

    bug_one.self_link
    # https://api.staging.launchpad.net/beta/bugs/1
}}}
Line 243: Line 309:
an attribute 'owner', but the owner of a bug is a person, with an attribute `owner`, but the owner of a bug is a person, with
Line 248: Line 314:
    print repr(owner)     print(repr(owner))
Line 250: Line 316:
    print owner.name     print(owner.name)
Line 252: Line 318:
    print owner.display_name     print(owner.display_name)
Line 257: Line 323:
the data back to the server. the data back to the server using `lp_save()`.
Line 264: Line 330:
    print people['my-user-name'].display_name     print(people['my-user-name'].display_name)
Line 269: Line 335:
operation on the Launchpad side, but using a launchpadlib Credentials operation on the Launchpad side, but using a launchpadlib `Credentials`
Line 272: Line 338:
change the dataset through launchpadlib.

Some entries also support special operations--see the reference
documentation for details. A bugtask entry supports an operation called "transitionToAssignee".
This operation takes a single argument called "assignee", which should be a Launchpad person.
Here it is in action.

{{{
    task = list(bug_one.bug_tasks)[0]
    old_assignee = task.assignee
    print old_assignee
    # <team at https://api.staging.launchpad.net/beta/~compscibuntu-bugs>
    task.transitionToAssignee(assignee=me)
    print task.owner.display_name
    # A user who edits through the Launchpad web service.
}}}


== Collections ==
change data through launchpadlib.


== self_link: the permanent ID ==

Every entry has a `self_link` attribute. You can treat this as a
permanent ID for the entry. If your program needs to keep track of
Launchpad objects across multiple runs, a simple way to do it is to
keep track of the `self_link`s.

{{{
    print(salgado.self_link)
    # https://api.staging.launchpad.net/beta/~salgado

    bug_one.self_link
    # https://api.staging.launchpad.net/beta/bugs/1
}}}

== web_link: the link to the Launchpad website ==

Most of the entries published by the web service correspond to pages on the Launchpad website. You can get the website URL of an entry with the `web_link` attribute:

{{{
    print(salgado.web_link)
    # https://staging.launchpad.net/~salgado

    bug_one.web_link
    # https://bugs.staging.launchpad.net/bugs/1
}}}

Some entries don't correspond to any page on the Launchpad website: these entries won't have a `web_link`.

== Named operations ==

Entries can support special operations just like collections, but again note that, these methods don't support positional arguments, only keyword arguments.


= Errors =

When the Launchpad web service encounters an error, it sends back an error message to launchpadlib, which raises an HTTPError exception. You'll see information about the HTTP request that caused the error, and the server-side error message. Depending on the error, you may be able to recover or change your code and try again.

If you're using an old version of launchpadlib, the HTTPError may not be this helpful. To see the server-side error message, you'll need to print out the .content of the HTTPError exception.

{{{
#!python
try:
    failing_thing()
except HTTPError as http_error:
    print(http_error.content)
}}}


= Collections =
Line 298: Line 398:
        print person.name
}}}

That's a collection of 'people'-type entries. You can iterate over a
        print(person.name)
}}}

That's a collection of `people`-type entries. You can iterate over a
Line 310: Line 410:
    print len(tasks)     print(len(tasks))
Line 313: Line 413:
        print task.bug_target_display_name         print(task.bug_target_display_name)
Line 321: Line 421:
collection of two 'language' entries. collection of two `language` entries.
Line 325: Line 425:
        print language.self_link         print(language.self_link)
Line 344: Line 444:
        print bug.description             print(bug.description)
Line 372: Line 472:

= Hosted files =

Launchpad stores some data in the form of binary files. A good example
is people's mugshots. With launchpadlib, you can read and write these
binary files programatically.

If you have a launchpadlib reference to one of these hosted files, you
can read its data by calling the `open()` method and treating the result
as an open filehandle.

{{{
    mugshot = launchpad.me.mugshot
    mugshot_handle = mugshot.open()
    mugshot_handle.read()
    # [binary data]
    mugshot_handle.content_type
    # 'image/jpeg'
    mugshot_handle.last_modified
    # 'Wed, 12 Mar 2008 21:47:05 GMT'
}}}

You'll get an error if the file doesn't exist: for instance, if a
person doesn't have a mugshot.

{{{
    launchpad.people['has-no-mugshot'].mugshot
    # *** HTTPError: HTTP Error 404: Not Found
}}}

To create or overwrite a file, open the hosted file object for
write. You'll need to provide the access mode ("w"), the MIME type
of the file you're sending to Launchpad, and the filename you want to
give it on the server side.

{{{
    with mugshot.open("w", "image/jpeg", "my-image.jpg") as mugshot_handle:
        mugshot_handle.write("image data goes here")
}}}

If there's something wrong--maybe you provide a file of the wrong
type--you'll get an `HTTPError` with a status code of 400. The `content`
attribute will contain an error message.

{{{
    print(http_error.content)
    # This image is not exactly 192x192 pixels in size.

    print(http_error.content)
    # The file uploaded was not recognized as an image; please
    # check it and retry.
}}}


= Persistent references to Launchpad objects =

Every entry and collection has a unique ID: its URL. You can get this unique ID by calling `str()` on the object.

{{{
    print(str(bug_one))
    # https://api.staging.launchpad.net/beta/bugs/1
}}}

If you need to keep track of Launchpad objects over time, or pass references to Launchpad objects to other programs, use these strings. If you've got one of these strings, you can turn it into the corresponding Launchpad object by calling `launchpad.load()`.

{{{
    bug_one = launchpad.load("https://api.staging.launchpad.net/beta/bugs/1")
    print(bug_one.title)
    Microsoft has a majority market share
}}}

You're bookmarking the Launchpad objects and coming back to them later, just like you'd bookmark pages in your web browser.


= Three things to make your client faster =

1. '''Use the latest launchpadlib.''' (The versions in the current Ubuntu release should be fine; otherwise run from the branch or the latest tarball.)

2. '''Profile:'''

{{{
    import httplib2
    httplib2.debuglevel = 1
}}}

3. '''Fetch objects only once:'''

Don't do this:

{{{
    if bug.person is not None:
        print(bug.person.name)
}}}

instead

{{{
    p = bug.person
    if p is not None:
        print(p.name)
}}}

(From [[http://blog.launchpad.net/api/three-tips-for-faster-launchpadlib-api-clients|the blog]]).
Line 377: Line 581:

= See also =

 * [[http://launchpad.net/+apidoc/|web service reference documentation]] for a list of all objects, operations, etc

= launchpadlib API compatibility =

The API compatibility of the launchpadlib Python library has not always been maintained as well as an author of a program using it would hope.

== >= 1.5.5 (>= Ubuntu Lucid Lynx) ==
Version 1.5.5 added the support for accessing various different versions of the remote web-service API (at the time of writing, these versions are known as "beta", "1.0" and "devel"). Whilst the new `version` parameters were compatibly added, there was an incompatible change to the URLs that launchpadlib would accept as `service_root` parameters:
 * launchpadlib 1.5.4 and earlier '''requires''' URLs of the form `https://api.launchpad.net/beta/`
 * launchpadlib 1.5.5 and later '''requires''' URLs of the form `https://api.launchpad.net/`

and either will break in non-obvious ways if you give it the wrong form.

== 1.8.0 (no Ubuntu release) ==
Version 1.8.0 changed things, which 1.9.0 then changed again. And, it never went into any final Ubuntu release. Probably best to just pretend it doesn't exist.

== >= 1.9.0 (>= Ubuntu Natty Narwhal) ==
Version 1.9.x's changes versus 1.6.x include a major refactor of how authentication tokens are obtained. Notable consequences:
 * Different kinds of tokens are obtained, and they are stored differently by default (in GNOME keyring or similar technologies instead of files), meaning it's highly unlikely that tokens stored by launchpadlib 1.6.x will be noticed by 1.9.x, so users will have to re-authorize.
 * Most of the methods by which a `Launchpad` object is obtained have changed significantly: ''(Note, positional parameter indices referred to below are 1-based)''

'''Launchpad.__init__:'''
 * Parameters `authorization_engine` and `credential_store` inserted at position 2. '''It is no longer safe to call `Launchpad.__init__` with positional parameters beyond the first in compatible applications!'''

'''Launchpad.login:'''
 * Method is now deprecated.
 * Five new parameters inserted at position 8. Mitigating factor: the only parameter after this was `version`, which was probably being passed as a keyword argument anyway.

'''Launchpad.get_token_and_login:'''
 * Method is now deprecated.
 * Parameter 6 renamed from `authorizer_class` to `authorization_engine`.
 * Parameters `credential_store` and `credential_save_failed` inserted at position 9. Mitigating factor: the only parameter after this was `version`, which was probably being passed as a keyword argument anyway.

'''Launchpad.login_with:'''
 * Positional parameter 1 changed from `consumer_name` to `application_name` to attempt to force common use-cases to acquire a desktop integration rather than consumer-specific token without code changes.
 * Parameter 6 renamed from `authorizer_class` to `authorization_engine`.
 * New parameter `consumer_name` appended to replace the incarnation removed at position 1. (But it does not actually work - see https://launchpad.net/bugs/755313)
 * New parameters `credential_save_failed` and `credential_store` appended.

Launchpad Help > API > Examples

launchpadlib

launchpadlib is an open-source Python library that lets you treat the HTTP resources published by Launchpad's web service as Python objects responding to a standard set of commands. With launchpadlib you can integrate your applications into Launchpad without knowing a lot about HTTP client programming.

This document shows how to use a Python client to read and write Launchpad's data using the launchpadlib library. It doesn't cover the HTTP requests and responses that go back and forth behind the scenes: for that, see the "hacking" document. This document also doesn't cover the full range of what's possible with Launchpad's web service: for that, see the web service reference documentation. Check out the API examples page if you would like to see more sample code.

Launchpad's web service currently exposes the following major parts of Launchpad:

  • People and teams
  • Team memberships
  • Bugs and bugtasks
  • The project registry
  • Hosted files, such as bug attachments and mugshots.

As new features and capabilities are added to the web service, you'll be able to access most of them without having to update your copy of launchpadlib. You will have to upgrade launchpadlib to get new client-side features (like support for uploaded files). The Launchpad team will put out an announcement whenever a server-side change means you should upgrade launchpadlib.

Installation

The launchpadlib in Ubuntu (easy to install)

If you have the latest version of Ubuntu then to install the launchpadlib available in the Ubuntu repositories, open a terminal and run the command:

  $ sudo apt-get install python3-launchpadlib

And you are done!

If you have an older version of Ubuntu then parts of the instructions below may not work with the version from the repositories but you should be able to install the latest version of launchpadlib manually.

launchpad using pip

On any platform with a working Python and pip, you should be able to say:

  pip install launchpadlib

Getting started

The first step towards using Launchpad's web service is to choose a cache directory. The documents you retrieve from Launchpad will be stored here, which will save you a lot of time. Run this code in a Python session, substituting an appropriate directory on your computer:

    cachedir = "/home/me/.launchpadlib/cache/"

The next step is to set up credentials for your client. For quick read-only access to Launchpad data, you can get anonymous access. Otherwise, you'll need to authenticate with Launchpad using OAuth.

Anonymous access

The Launchpad.login_anonymously() method will give you automatic read-only access to public Launchpad data.

    from launchpadlib.launchpad import Launchpad
    launchpad = Launchpad.login_anonymously('just testing', 'production', cachedir, version='devel')

The first argument to Launchpad.login_anonymously() is a string that identifies the web service client. We use this string to gauge client popularity and detect buggy or inefficient clients. Here, though, we're just testing.

The second argument tells launchpadlib which Launchpad instance to run against. Here, we're using production, which is mapped to the web service root on the production Launchpad server: "https://api.launchpad.net/". Anonymous access cannot change the Launchpad dataset, so there's no concern about a bad test program accidentally overwriting data. (If you want to play it safe, you could use 'staging' instead - though staging is sometimes down for extended periods.)

The version argument specifies the API version to use. For historical reasons the default is '1.0', and you may want to use this in certain special circumstances, but in most cases you should use 'devel' so that you get a reasonably complete and current interface.

The login_anonymously() method automatically negotiates a read-only credential with Launchpad. You can use your Launchpad object right away.

    bug_one = launchpad.bugs[1]
    print(bug_one.title)
    # Microsoft has a majority market share

You'll get an error if you try to modify the dataset, access private data, or access objects like launchpad.me which assume a particular user is logged in.

Note that login_anonymously() is only available in launchpadlib starting in version 1.5.4.

Authenticated access

To get read-write access to Launchpad, or to see a user's private data, you'll need to get an OAuth credential for that user. If you're writing an application that the user will run on their own computer, this is easy: just call the Launchpad.login_with() method.

This method takes two important arguments: the name of your application, and the name of the Launchpad server you want to run against. The default server name is 'staging', so that you don't destroy data by accident while developing. When you do a release, you can change this to 'production'.

    from launchpadlib.launchpad import Launchpad
    launchpad = Launchpad.login_with('My Application', 'staging', version='devel')

If this code complains that 'staging' isn't a URL, then you're not running the most up-to-date launchpadlib. You can replace 'staging' with launchpadlib.launchpad.STAGING_SERVICE_ROOT to make it work in Ubuntu 9.10's launchpadlib.

If you have an existing desktop-wide Launchpad credential, launchpadlib will find it and use it. If there's no existing desktop credential (because you've never used a launchpadlib application on this computer, or because you had a credential that expired), launchpadlib will guide you through authorizing a new credential, as seen here.

There's one other important argument to login_with(). You can pass in a callback function as credential_save_failed. That function will be invoked if a desktop credential can't be created--either because the end-user refused to perform the authorization, or because there was a problem storing the credential after authorization.

    import sys
    from launchpadlib.launchpad import Launchpad

    def no_credential():
        print("Can't proceed without Launchpad credential.")
        sys.exit()

    launchpad = Launchpad.login_with(
        'My Application', 'staging', credential_save_failed=no_credential, version='devel')

Authenticated access for website integration

Things are a little more difficult if you want to integrate Launchpad's functionality into your own website. You can't call Launchpad.login_with(), because that will open up a web browser on your webserver--not on your user's computer.

Instead, you create a Credentials object identifying your website and call get_request_token() to ask Launchpad for a request token. Be sure to pass in the name of the Launchpad server you want to use (probably "production" as web_root.

    from launchpadlib.credentials import Credentials
    credentials = Credentials("my website")
    request_token_info = credentials.get_request_token(web_root="production")

You'll get back a string that looks like 'https://launchpad.net/+authorize-token?oauth_token=...' This is the URL your end-user needs to visit in order to authorize your token.

At this point, you should redirect your user to that URL. Then, start periodically calling exchange_request_token_for_access_token():

    from lazr.restfulclient.errors import HTTPError
    complete = False
    while not complete:
        try:
            credentials.exchange_request_token_for_access_token(
                web_root="production")
            complete = True
        except HTTPError:
            # The user hasn't authorized the token yet.

Once exchange_request_token_for_access_token() successfully executes, an authorized access token will be present in credentials.access_token. You can then pass the Credentials object into the Launchpad constructor.

    from launchpadlib.launchpad import Launchpad
    launchpad = Launchpad(credentials, service_root="production")

You might have noticed that system is pretty hacky. It hasn't gotten much attention, because we don't know of any third-party websites that are integrating Launchpad functionality in a way that requires OAuth tokens.

Getting help

If you don't know the capabilities of one of the objects you've got, you can call dir() on it. You'll see all of its fields and all the custom methods it supports. Unfortunately, you'll also see a bunch of launchpadlib-specific junk that you don't care about. That's why we've made available these four lists:

  • lp_attributes: Data fields of this object. You can read from these might be able to write to some of them.

  • lp_collections: List of launchpad objects associated with this object.

  • lp_entries: Other Launchpad objects associated with this one.

  • lp_operations: The names of Launchpad methods you can call on the object.

   print(sorted(bug_one.lp_attributes))
   # ['date_created', 'date_last_message', 'date_last_updated', ... 'tags', 'title']
   print(sorted(bug_one.lp_operations))
   # ['addAttachment', 'addWatch', 'subscribe', 'unsubscribe']

If you need more detailed help, you can look the object up in the reference documentation. First, find out the type of the object.

    print(repr(bug_one))
    # <bug at https://api.staging.launchpad.net/beta/bugs/1>

This is a 'bug' type object. Now you use the type of the object as an anchor into the reference documentation. To find out the capabilities of this object and what data is stored inside it, you'd visit https://launchpad.net/+apidoc#bug.

As you'll see, the reference documentation still needs some work, and it's geared more towards web service hackers than launchpadlib users, but it will tell you about all of this object's attributes and all the supported operations.

  • The "Default representation" section tells you about the available attributes.
  • The "Custom POST methods" and "Custom GET methods" sections tell you about methods the object supports other than the default methods described below. The methods take whatever parameters are listed in "Request query parameters". (You can ignore the "ws.op" parameter because you're using launchpadlib; that's just the name of the method.)

The top-level objects

The Launchpad object has attributes corresponding to the major parts of Launchpad. These are:

  • .bugs: All the bugs in Launchpad

  • .people: All the people in Launchpad

  • .me: You

  • .distributions: All the distributions in Launchpad

  • .projects: All the projects in Launchpad

  • .project_groups: All the project groups in Launchpad

As a super special secret, distributions, projects and project_groups are all actually the same thing.

    me = launchpad.me
    print(me.name)
    # This should be your user name, e.g. 'salgado'

The launchpad.people attribute gives you access to other people who use Launchpad. This code uses launchpad.people to look up the person with the Launchpad name "salgado".

    people = launchpad.people
    salgado = people['salgado']
    print(salgado.display_name)
    # Guilherme Salgado

You can search for objects in other ways. Here's another way of finding "salgado".

    salgado = people.getByEmail(email="guilherme.salgado@canonical.com")
    print(salgado.display_name)
    # Guilherme Salgado

Some searches return more than one object.

    for person in people.find(text="salgado"):
        print(person.name)
    # agustin-salgado
    # ariel-salgado
    # axel-salgado
    # bruno-salgado
    # camilosalgado
    # ...

Note that, unlike typical Python methods, these methods--find() and getByEmail()--don't support positional arguments, only keyword arguments. You can't call people.find("salgado"); it has to be people.find(text="salgado").

Entries

Bugs, people, projects, team memberships, and most other objects published through Launchpad's web service, all work pretty much the same way. We call all these objects "entries". Each corresponds to a single piece of data within Launchpad.

You can use the web service to discover various facts about an entry. The launchpadlib makes the facts available as attributes of the entry object.

name and display_name are facts about people.

    print(salgado.name)
    # salgado

    print(salgado.display_name)
    # Guilherme Salgado

private and description are facts about bugs.

    print(bug_one.private)
    # False

    print(bug_one.description)
    # Microsoft has a majority market share in the new desktop PC marketplace.
    # This is a bug, which Ubuntu is designed to fix.
    # ...

Some of an object's attributes are links to other entries. Bugs have an attribute owner, but the owner of a bug is a person, with attributes of its own.

    owner = bug_one.owner
    print(repr(owner))
    # <person at https://api.staging.launchpad.net/beta/~sabdfl>
    print(owner.name)
    # sabdfl
    print(owner.display_name)
    # Mark Shuttleworth

If you have permission, you can change an entry's attributes and write the data back to the server using lp_save().

    me = people['my-user-name']
    me.display_name = 'A user who edits through the Launchpad web service.'
    me.lp_save()

    print(people['my-user-name'].display_name)
    # A user who edits through the Launchpad web service.

Having permission means not only being authorized to perform an operation on the Launchpad side, but using a launchpadlib Credentials object that authorizes the operation. If you've set up your launchpadlib Credentials for read-only access, you won't be able to change data through launchpadlib.

self_link: the permanent ID

Every entry has a self_link attribute. You can treat this as a permanent ID for the entry. If your program needs to keep track of Launchpad objects across multiple runs, a simple way to do it is to keep track of the self_links.

    print(salgado.self_link)
    # https://api.staging.launchpad.net/beta/~salgado

    bug_one.self_link
    # https://api.staging.launchpad.net/beta/bugs/1

Most of the entries published by the web service correspond to pages on the Launchpad website. You can get the website URL of an entry with the web_link attribute:

    print(salgado.web_link)
    # https://staging.launchpad.net/~salgado

    bug_one.web_link
    # https://bugs.staging.launchpad.net/bugs/1

Some entries don't correspond to any page on the Launchpad website: these entries won't have a web_link.

Named operations

Entries can support special operations just like collections, but again note that, these methods don't support positional arguments, only keyword arguments.

Errors

When the Launchpad web service encounters an error, it sends back an error message to launchpadlib, which raises an HTTPError exception. You'll see information about the HTTP request that caused the error, and the server-side error message. Depending on the error, you may be able to recover or change your code and try again.

If you're using an old version of launchpadlib, the HTTPError may not be this helpful. To see the server-side error message, you'll need to print out the .content of the HTTPError exception.

   1 try:
   2     failing_thing()
   3 except HTTPError as http_error:
   4     print(http_error.content)

Collections

When Launchpad groups similar entries together, we call it a collection. You've already seen one collection: the list of people you get back when you call launchpad.people.find.

    for person in launchpad.people.find(text="salgado"):
        print(person.name)

That's a collection of people-type entries. You can iterate over a collection as you can any Python list.

Some of an entry's attributes are links to related collections. Bug #1 has a number of associated bug tasks, represented as a collection of 'bug task' entries.

    tasks = bug_one.bug_tasks
    print(len(tasks))
    # 17
    for task in tasks:
        print(task.bug_target_display_name)
    # Computer Science Ubuntu
    # Ichthux
    # JAK LINUX
    # ...

The person 'salgado' understands two languages, represented here as a collection of two language entries.

    for language in salgado.languages:
        print(language.self_link)
    # https://api.staging.launchpad.net/beta/+languages/en
    # https://api.staging.launchpad.net/beta/+languages/pt_BR

Because collections can be very large, it's usually a bad idea to iterate over them. Bugs generally have a manageable number of bug tasks, and people understand a manageable number of languages, but Launchpad tracks over 250,000 bugs. If you just iterate over a list, launchpadlib will just keep pulling down entries until it runs out, which might be forever (or, realistically, until your client is banned for making too many requests).

That's why we recommend you slice Launchpad's collections into Python lists, and operate on the lists. Here's code that prints descriptions for the 10 most recently filed bugs.

    bugs = launchpad.bugs[:10]
    for bug in bugs:
        print(bug.description)

For performance reasons, we've put a couple restrictions on collection slices that don't apply to slices on regular Python lists. You can only slice from the beginning of a collection, not the end.

    launchpad.bugs[-5:]
    # *** ValueError: Collection slices must have a nonnegative start point.

And your slice needs to have a definite end point: you can't slice to the end of a collection.

    bugs[10:]
    # *** ValueError: Collection slices must have a definite, nonnegative end point.

    bugs[:-5]
    # *** ValueError: Collection slices must have a definite, nonnegative end point.

On the plus side, you can include a step number with your slice, as with a normal Python list:

    every_other_bug = launchpad.bugs[0:10:2]
    len(every_other_bug)
    # 5

Hosted files

Launchpad stores some data in the form of binary files. A good example is people's mugshots. With launchpadlib, you can read and write these binary files programatically.

If you have a launchpadlib reference to one of these hosted files, you can read its data by calling the open() method and treating the result as an open filehandle.

    mugshot = launchpad.me.mugshot
    mugshot_handle = mugshot.open()
    mugshot_handle.read()
    # [binary data]
    mugshot_handle.content_type
    # 'image/jpeg'
    mugshot_handle.last_modified
    # 'Wed, 12 Mar 2008 21:47:05 GMT'

You'll get an error if the file doesn't exist: for instance, if a person doesn't have a mugshot.

    launchpad.people['has-no-mugshot'].mugshot
    # *** HTTPError: HTTP Error 404: Not Found

To create or overwrite a file, open the hosted file object for write. You'll need to provide the access mode ("w"), the MIME type of the file you're sending to Launchpad, and the filename you want to give it on the server side.

    with mugshot.open("w", "image/jpeg", "my-image.jpg") as mugshot_handle:
        mugshot_handle.write("image data goes here")

If there's something wrong--maybe you provide a file of the wrong type--you'll get an HTTPError with a status code of 400. The content attribute will contain an error message.

    print(http_error.content)
    # This image is not exactly 192x192 pixels in size.

    print(http_error.content)
    # The file uploaded was not recognized as an image; please
    # check it and retry.

Persistent references to Launchpad objects

Every entry and collection has a unique ID: its URL. You can get this unique ID by calling str() on the object.

    print(str(bug_one))
    # https://api.staging.launchpad.net/beta/bugs/1

If you need to keep track of Launchpad objects over time, or pass references to Launchpad objects to other programs, use these strings. If you've got one of these strings, you can turn it into the corresponding Launchpad object by calling launchpad.load().

    bug_one = launchpad.load("https://api.staging.launchpad.net/beta/bugs/1")
    print(bug_one.title)
    Microsoft has a majority market share

You're bookmarking the Launchpad objects and coming back to them later, just like you'd bookmark pages in your web browser.

Three things to make your client faster

1. Use the latest launchpadlib. (The versions in the current Ubuntu release should be fine; otherwise run from the branch or the latest tarball.)

2. Profile:

    import httplib2
    httplib2.debuglevel = 1

3. Fetch objects only once:

Don't do this:

    if bug.person is not None:
        print(bug.person.name)

instead

    p = bug.person
    if p is not None:
        print(p.name)

(From the blog).

Planned improvements

launchpadlib still has deficiencies. We track bugs in the launchpadlib bug tracker (https://bugs.launchpad.net/launchpadlib) and will be working to improve launchpadlib throughout the limited beta.

See also

launchpadlib API compatibility

The API compatibility of the launchpadlib Python library has not always been maintained as well as an author of a program using it would hope.

>= 1.5.5 (>= Ubuntu Lucid Lynx)

Version 1.5.5 added the support for accessing various different versions of the remote web-service API (at the time of writing, these versions are known as "beta", "1.0" and "devel"). Whilst the new version parameters were compatibly added, there was an incompatible change to the URLs that launchpadlib would accept as service_root parameters:

  • launchpadlib 1.5.4 and earlier requires URLs of the form https://api.launchpad.net/beta/

  • launchpadlib 1.5.5 and later requires URLs of the form https://api.launchpad.net/

and either will break in non-obvious ways if you give it the wrong form.

1.8.0 (no Ubuntu release)

Version 1.8.0 changed things, which 1.9.0 then changed again. And, it never went into any final Ubuntu release. Probably best to just pretend it doesn't exist.

>= 1.9.0 (>= Ubuntu Natty Narwhal)

Version 1.9.x's changes versus 1.6.x include a major refactor of how authentication tokens are obtained. Notable consequences:

  • Different kinds of tokens are obtained, and they are stored differently by default (in GNOME keyring or similar technologies instead of files), meaning it's highly unlikely that tokens stored by launchpadlib 1.6.x will be noticed by 1.9.x, so users will have to re-authorize.
  • Most of the methods by which a Launchpad object is obtained have changed significantly: (Note, positional parameter indices referred to below are 1-based)

Launchpad.init:

  • Parameters authorization_engine and credential_store inserted at position 2. It is no longer safe to call Launchpad.__init__ with positional parameters beyond the first in compatible applications!

Launchpad.login:

  • Method is now deprecated.
  • Five new parameters inserted at position 8. Mitigating factor: the only parameter after this was version, which was probably being passed as a keyword argument anyway.

Launchpad.get_token_and_login:

  • Method is now deprecated.
  • Parameter 6 renamed from authorizer_class to authorization_engine.

  • Parameters credential_store and credential_save_failed inserted at position 9. Mitigating factor: the only parameter after this was version, which was probably being passed as a keyword argument anyway.

Launchpad.login_with:

  • Positional parameter 1 changed from consumer_name to application_name to attempt to force common use-cases to acquire a desktop integration rather than consumer-specific token without code changes.

  • Parameter 6 renamed from authorizer_class to authorization_engine.

  • New parameter consumer_name appended to replace the incarnation removed at position 1. (But it does not actually work - see https://launchpad.net/bugs/755313)

  • New parameters credential_save_failed and credential_store appended.

API/launchpadlib (last edited 2021-10-07 16:05:43 by cjwatson)