Merge lp:~leonardr/launchpadlib/shim-users into lp:launchpadlib

[Leonard Richardson]

This branch takes advantage of the functionality provided by https://code.edge.launchpad.net/~leonardr/lazr.restfulclient/server-takes-precedence/+merge/28059 to make the top-level collection of people use shim objects. This will save an HTTP request or two in many launchpadlib scripts.

[Gary Poster (gary)]

Thank you

review: Approve

=== modified file 'setup.py'
--- setup.py	2010-06-16 19:48:04 +0000
+++ setup.py	2010-06-21 15:38:24 +0000
@@ -60,7 +60,7 @@
     license='LGPL v3',
     install_requires=[
         'httplib2',
-        'lazr.restfulclient>=0.9.18',
+        'lazr.restfulclient>=0.9.19',
         'lazr.uri',
         'oauth',
         'setuptools',

=== modified file 'src/launchpadlib/NEWS.txt'
--- src/launchpadlib/NEWS.txt	2010-06-16 19:48:04 +0000
+++ src/launchpadlib/NEWS.txt	2010-06-21 15:38:24 +0000
@@ -2,6 +2,12 @@
 NEWS for launchpadlib
 =====================
 
+1.6.2 (2010-06-21)
+==================
+
+- Extended the optimization from version 1.6.1 to apply to Launchpad's
+  top-level collection of people.
+
 1.6.1 (2010-06-16)
 ==================
 

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2010-06-16 19:48:04 +0000
+++ src/launchpadlib/__init__.py	2010-06-21 15:38:24 +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.1'
+__version__ = '1.6.2'

=== modified file 'src/launchpadlib/docs/toplevel.txt'
--- src/launchpadlib/docs/toplevel.txt	2010-06-16 19:48:04 +0000
+++ src/launchpadlib/docs/toplevel.txt	2010-06-21 15:38:24 +0000
@@ -49,23 +49,63 @@
     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.
+name.
 
     >>> person = launchpad.people['salgado']
-    send: 'GET /.../~salgado ...'
-    ...
     >>> print person.name
+    send: 'GET /.../~salgado ...'
+    ...
     salgado
 
     >>> team = launchpad.people['rosetta-admins']
+    >>> print team.name
     send: 'GET /1.0/~rosetta-admins ...'
     ...
-    >>> print team.name
     rosetta-admins
 
+How does launchpadlib know that 'salgado' is a person and
+'rosetta-admins' is a team?
+
+    >>> print person.resource_type_link
+    http://.../1.0/#person
+    >>> 'default_membership_period' in person.lp_attributes
+    False
+
+    >>> print team.resource_type_link
+    http://.../1.0/#team
+    >>> 'default_membership_period' in team.lp_attributes
+    True
+
+The truth is that it doesn't know, not before making that HTTP
+request. Until the HTTP request is made, launchpadlib assumes
+everything in launchpad.people[] is a team (since a team has strictly
+more capabilities than a person).
+
+    >>> person2 = launchpad.people['salgado']
+    >>> 'default_membership_period' in person2.lp_attributes
+    True
+
+But accessing any attribute of an object--even trying to see what kind
+of object 'salgado' is--will trigger the HTTP request that will
+determine that 'salgado' is actually a person.
+
+    >>> print person2.resource_type_link
+    send: 'GET /.../~salgado ...'
+    ...
+    http://.../1.0/#person
+
+    >>> 'default_membership_period' in person2.lp_attributes
+    False
+
+Accessing an attribute of an object that might be a team will trigger
+the HTTP request, and then cause an error if the object turns out not
+to be a team.
+
+    >>> person3 = launchpad.people['salgado']
+    >>> person3.default_membership_period
+    Traceback (most recent call last):
+    AttributeError: 'Entry' object has no attribute 'default_membership_period'
+
 Cleanup.
 
     >>> httplib2.debuglevel = None

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2010-06-16 19:48:04 +0000
+++ src/launchpadlib/launchpad.py	2010-06-21 15:38:24 +0000
@@ -50,7 +50,7 @@
     # 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
+    collection_of = 'team'
 
 
 class BugSet(CollectionWithKeyBasedLookup):