Merge lp:~leonardr/launchpadlib/delay-http-requests into lp:launchpadlib

[Leonard Richardson]

This branch makes launchpadlib use the new performance optimization introduced by https://code.edge.launchpad.net/~leonardr/lazr.restfulclient/shim-objects/. Basically, if you write launchpad.bugs[1] we can now delay the GET to "/bugs/1" until you actually need some data from that bug. If you're invoking a named operation on the bug, the GET doesn't need to happen at all.

Since it's pretty common for scripts to look up an object in a top-level collection and immediately invoke a named operation on it, this has a good chance of giving a modest performance boost to any given script.

The one top-level collection that doesn't have this feature is the collection of users. Without making that GET request, there's no way to know whether launchpad.user['foo'] is a 'person' or a 'team' type object, so I punted.

[Henning Eggers (henninge)]

Thanks!

review: Approve (code)

=== modified file 'setup.py'
--- setup.py	2010-02-15 16:34:26 +0000
+++ setup.py	2010-06-16 19:58:22 +0000
@@ -60,7 +60,7 @@
     license='LGPL v3',
     install_requires=[
         'httplib2',
-        'lazr.restfulclient>=0.9.11',
+        'lazr.restfulclient>=0.9.18',
         'lazr.uri',
         'oauth',
         'setuptools',

=== modified file 'src/launchpadlib/NEWS.txt'
--- src/launchpadlib/NEWS.txt	2010-04-06 19:54:35 +0000
+++ src/launchpadlib/NEWS.txt	2010-06-16 19:58:22 +0000
@@ -2,6 +2,12 @@
 NEWS for launchpadlib
 =====================
 
+1.6.1 (2010-06-16)
+==================
+
+- Added an optimization that lets launchpadlib avoid making an HTTP
+  request in some situations.
+
 1.6.0 (2010-04-07)
 ==================
 

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2010-04-06 19:54:35 +0000
+++ src/launchpadlib/__init__.py	2010-06-16 19:58:22 +0000
@@ -14,4 +14,4 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with launchpadlib. If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = '1.6.0'
+__version__ = '1.6.1'

=== modified file 'src/launchpadlib/docs/toplevel.txt'
--- src/launchpadlib/docs/toplevel.txt	2009-04-16 19:30:01 +0000
+++ src/launchpadlib/docs/toplevel.txt	2010-06-16 19:58:22 +0000
@@ -1,31 +1,71 @@
 The launchpad web service's top-level collections provide access to
 Launchpad-wide objects like projects and people.
 
+    >>> import httplib2
+    >>> httplib2.debuglevel = 1
+
     >>> from launchpadlib.testing.helpers import salgado_with_full_permissions
     >>> launchpad = salgado_with_full_permissions.login()
+    connect: ...
+    ...
 
 It's possible to do key-based lookups on the top-level
 collections. The bug collection does lookups by bug ID.
 
-    >>> launchpad.bugs[1].id
+    >>> bug = launchpad.bugs[1]
+
+For most top-level collections, simply looking up an object will not
+trigger an HTTP request. The HTTP request happens when you try to
+access one of the object's properties.
+
+    >>> print bug.id
+    send: 'GET /.../bugs/1 ...'
+    ...
     1
 
-The person collection does lookups by a person's Launchpad name.
-
-    >>> launchpad.people['salgado'].name
-    u'salgado'
-
-The project collection does lookups by project name.
-
-    >>> launchpad.projects['firefox'].name
-    u'firefox'
+Let's look at some more collections. The project collection does
+lookups by project name.
+
+    >>> project = launchpad.projects['firefox']
+    >>> print project.name
+    send: 'GET /.../firefox ...'
+    ...
+    firefox
 
 The project group collection does lookups by project group name.
 
-    >>> launchpad.project_groups['firefox'].name
-    u'firefox'
+    >>> group = launchpad.project_groups['gnome']
+    >>> print group.name
+    send: 'GET /.../gnome ...'
+    ...
+    gnome
 
 The distribution collection does lookups by distribution name.
 
-    >>> launchpad.distributions['ubuntu'].name
-    u'ubuntu'
+    >>> distribution = launchpad.distributions['ubuntu']
+    >>> print distribution.name
+    send: 'GET /.../ubuntu ...'
+    ...
+    ubuntu
+
+The person collection does lookups by a person's Launchpad
+name. Looking up a person from the top-level collection of people
+*does* trigger an HTTP request, since there's no other way to tell
+whether a given person should be represented by a 'person' object or a
+'team' object.
+
+    >>> person = launchpad.people['salgado']
+    send: 'GET /.../~salgado ...'
+    ...
+    >>> print person.name
+    salgado
+
+    >>> team = launchpad.people['rosetta-admins']
+    send: 'GET /1.0/~rosetta-admins ...'
+    ...
+    >>> print team.name
+    rosetta-admins
+
+Cleanup.
+
+    >>> httplib2.debuglevel = None

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2010-03-24 16:09:40 +0000
+++ src/launchpadlib/launchpad.py	2010-06-16 19:58:22 +0000
@@ -47,6 +47,11 @@
         """Transform a username into the URL to a person resource."""
         return str(self._root._root_uri.ensureSlash()) + '~' + str(key)
 
+    # The only way to determine whether a string corresponds to a
+    # person or a team object is to ask the server, so looking up an
+    # entry from the PersonSet always requires making an HTTP request.
+    collection_of = None
+
 
 class BugSet(CollectionWithKeyBasedLookup):
     """A custom subclass capable of bug lookup by bug ID."""
@@ -55,6 +60,8 @@
         """Transform a bug ID into the URL to a bug resource."""
         return str(self._root._root_uri.ensureSlash()) + 'bugs/' + str(key)
 
+    collection_of = 'bug'
+
 
 class PillarSet(CollectionWithKeyBasedLookup):
     """A custom subclass capable of lookup by pillar name.
@@ -66,6 +73,28 @@
         """Transform a project name into the URL to a project resource."""
         return str(self._root._root_uri.ensureSlash()) + str(key)
 
+    # The subclasses for projects, project groups, and distributions
+    # all define this property differently.
+    collection_of = None
+
+
+class ProjectSet(PillarSet):
+    """A custom subclass for accessing the collection of projects."""
+
+    collection_of = 'project'
+
+
+class ProjectGroupSet(PillarSet):
+    """A custom subclass for accessing the collection of project groups."""
+
+    collection_of = 'project_group'
+
+
+class DistributionSet(PillarSet):
+    """A custom subclass for accessing the collection of project groups."""
+
+    collection_of = 'distribution'
+
 
 class Launchpad(ServiceRoot):
     """Root Launchpad API class.
@@ -78,11 +107,11 @@
 
     RESOURCE_TYPE_CLASSES = {
             'bugs': BugSet,
-            'distributions': PillarSet,
+            'distributions': DistributionSet,
             'HostedFile': HostedFile,
             'people': PersonSet,
-            'project_groups': PillarSet,
-            'projects': PillarSet,
+            'project_groups': ProjectGroupSet,
+            'projects': ProjectSet,
             }
 
     def __init__(self, credentials, service_root=uris.STAGING_SERVICE_ROOT,