Add return_paging_info support, release candidate for wrapper 3.0.6

Author: mattdaw

shotgun_api3.py

@@ -32,7 +32,7 @@
 # https://support.shotgunsoftware.com/forums/48807-developer-api-info
 # ---------------------------------------------------------------------------------------------
 
-__version__="3.0.5"
+__version__="3.0.6"
 
 # ---------------------------------------------------------------------------------------------
 # SUMMARY
@@ -58,6 +58,9 @@
 # CHANGELOG
 # ---------------------------------------------------------------------------------------------
 """
++v3.0.6 - 2010 Jan 25
+ + optimization: don't request paging_info unless required (and server support is available)
+
 +v3.0.5 - 2010 Dec 20
  + officially remove support for old api3_preview controller
  + find(): allow requesting a specific page of results instead of returning them all at once
@@ -192,11 +195,28 @@ def __init__(self, base_url, script_name, api_key, convert_datetimes_to_utc=True
 
 self._api3=ShotgunCRUD(server_options)
 
+self.server_info=self._api3.info()
+self._determine_features()
+
 self.local_path_string=None
 self.platform=self._determine_platform()
 ifself.platform:
 self.local_path_string="local_path_%s"% (self.platform)
 
+def_determine_features(self):
+self.supports_paging_info=False
+
+ifself.server_info.has_key('version'):
+v=self.server_info['version']
+else:
+return
+
+ifv[0] ==2andv[1] ==3andv[2] >=4:
+self.supports_paging_info=True
+elifv[0] >=2andv[1] >=4:
+self.supports_paging_info=True
+
+
 def_determine_platform(self):
 s=platform.system().lower()
 ifsin ['windows','linux','darwin']:
@@ -365,6 +385,9 @@ def find(self, entity_type, filters, fields=None, order=None, filter_operator=No
 "paging":{"entities_per_page": self.records_per_page, "current_page": 1}
  }
 
+ifself.supports_paging_info:
+req["return_paging_info"] =True
+
 iforder:
 req['sorts'] = []
 forsortinorder:
@@ -377,15 +400,24 @@ def find(self, entity_type, filters, fields=None, order=None, filter_operator=No
 
 iftype(limit) !=intorlimit<0:
 raiseValueError("find() 'limit' parameter must be a positive integer")
-elif (limitandlimit>0andlimit<self.records_per_page):
+elif (limitandlimit>0andlimit<=self.records_per_page):
 req["paging"]["entities_per_page"] =limit
+
+# If page isn't set and the limit doesn't require pagination, then trigger the
+# faster code path.
+ifpage==0:
+page=1
 
 records= []
 
 # if page is specified, then only return the page of records requested
 iftype(page) !=intorpage<0:
 raiseValueError("find() 'page' parameter must be a positive integer")
 elifpage!=0:
+# No paging_info needed, so optimize it out.
+ifself.supports_paging_info:
+req["return_paging_info"] =False
+
 req["paging"]["current_page"] =page
 resp=self._api3.read(req)
 results=resp["results"]["entities"]
@@ -683,6 +715,14 @@ def callable(*args, **kwargs):
 returnself.meta_caller(attr, *args, **kwargs)
 returncallable
 
+definfo(self):
+try:
+server_info=self.__sg.info()
+except:
+server_info={}
+
+returnserver_info
+
 defmeta_caller(self, attr, *args, **kwargs):
 try:
 returneval(