added ensure_ascii flag

kennedy behrman · kennedy behrman · commit c8e3bb9efa6f · 2011-07-27T11:24:26.000-07:00
diff --git a/README.mdown b/README.mdown
@@ -13,7 +13,6 @@ For Python 2.6 and higher, we will use the built-in json module... but installin
 
 ## Known Issues
 
-Does not yet support the new summarize method from the summary_grouping branch.
 
 
 
@@ -31,7 +30,7 @@ Shotgun provides a simple Python-based API for accessing Shotgun and integrating
 - Python v2.4 - v2.7. (We do have plans to eventually support Python 3)
 
 ## Installing
-To use Shotgun's Python API module, you need to place it in one of the directories specified by the environment variable PYTHONPATH. For more information on PYTHONPATH and using modules in Python, see http://docs.python.org/tutorial/modules.html
+To use Shotgun's Python API module, you need to place the package shotgun_api3 in one of the directories specified by the environment variable PYTHONPATH. For more information on PYTHONPATH and using modules in Python, see http://docs.python.org/tutorial/modules.html
 
 ## Documentation
 Tutorials and detailed documentation about the Python API are available on the [Shotgun Support website](https://support.shotgunsoftware.com/forums/48807-developer-api-info). 
@@ -42,10 +41,23 @@ Some useful direct links within this section are below:
 * [Reference: Data Types](https://github.com/shotgunsoftware/python-api/wiki/Reference%3A-Data-Types)
 * [Reference: Filter Syntax](https://github.com/shotgunsoftware/python-api/wiki/Reference%3A-Filter-Syntax)
 
+## Tests
+Integration and unit tests are provided.
+- test_client and tests_unit mock server interaction and do not require a shotgun instance to be available.
+- test_api and test_api_long do require a shotgun instance, with a script key available for the tests. These tests rely on a tests/config file, which can be created by renaming example_config and supplying the server and script user values. The tests will set up test data on the server based on the data set forth in the config. This data will be manipulated by the tests, and should not be used for other purposes.
+- To run all of the tests, use the shell script run-tests. This script require nose to be installed.
+
 ## Changelog
 (Note that many of these items may be specific to the XML-RPC version of the API and may not apply to the Python JSON API)  
   
 
+**v3.0.8 - 2011 July 27**
+  
+  + summarize available in json api
+  + refactored single file into package
+  + tests added (Thanks to Aaron Morton https://github.com/amorton)
+  + added ensure_ascii parameter, insuring results are ascii
+
 **v3.0.6 - 2010 Jan 25**
  
   + optimization: don't request paging_info unless required (and server support is available)
diff --git a/shotgun_api3/shotgun.py b/shotgun_api3/shotgun.py
@@ -60,7 +60,7 @@
 
 # ----------------------------------------------------------------------------
 # Version
-__version__ = "3.1a1"
+__version__ = "3.0.8"
 
 # ----------------------------------------------------------------------------
 # Errors
@@ -189,6 +189,7 @@ def __init__(self,
                  api_key, 
                  convert_datetimes_to_utc=True,
                  http_proxy=None,
+                 ensure_ascii=True,
                  connect=True):
         """Initialises a new instance of the Shotgun client.
         
@@ -216,7 +217,6 @@ def __init__(self,
         self.config.script_name = script_name
         self.config.convert_datetimes_to_utc = convert_datetimes_to_utc
         self.config.proxy_info = http_proxy
-        
         self._connection = None
         
         base_url = (base_url or "").lower()
@@ -241,6 +241,9 @@ def __init__(self,
             self.config.proxy_server, proxy_port = proxy_netloc.split(":", 1)
             self.config.proxy_port = int(proxy_port or 8080)
             
+        if ensure_ascii:
+            self._json_loads = self._json_loads_ascii
+        
         self.client_caps = ClientCapabilities()
         self._server_caps = None
         #test to ensure the the server supports the json API
@@ -1045,12 +1048,39 @@ def _decode_response(self, headers, body):
             
         ct = (headers.get("content-type") or "application/json").lower()
         
-        if ct.startswith("application/json") or \
-            ct.startswith("text/javascript"):
-            return json.loads(body)
-            
+        if ct.startswith("application/json") or ct.startswith("text/javascript"):
+            return self._json_loads(body)
         return body
 
+    def _json_loads(self, body):
+        return json.loads(body)
+
+    def _json_loads_ascii(self, body):
+        '''See http://stackoverflow.com/questions/956867'''
+        def _decode_list(lst):
+            newlist = []
+            for i in lst:
+                if isinstance(i, unicode):
+                    i = i.encode('utf-8')
+                elif isinstance(i, list):
+                    i = _decode_list(i)
+                newlist.append(i)
+            return newlist
+
+        def _decode_dict(dct):
+            newdict = {}
+            for k, v in dct.iteritems():
+                if isinstance(k, unicode):
+                    k = k.encode('utf-8')
+                if isinstance(v, unicode):
+                    v = v.encode('utf-8')
+                elif isinstance(v, list):
+                    v = _decode_list(v)
+                newdict[k] = v
+            return newdict
+        return json.loads(body, object_hook=_decode_dict)
+
+
     def _response_errors(self, sg_response):
         """Raises any API errors specified in the response.
         
@@ -1280,13 +1310,7 @@ def _dict_to_list(self, d, key_name="field_name", value_name="value"):
             for k,v in (d or {}).iteritems()
         ]
 
-
-
-
-
-
-
-# ----------------------------------------------------------------------------
+ 
 # Helpers from the previous API, left as is. 
 
 # Based on http://code.activestate.com/recipes/146306/
diff --git a/tests/base.py b/tests/base.py
@@ -186,6 +186,12 @@ def _setup_db(self, config):
                 'project':self.project}
         self.shot = _find_or_create_entity(self.sg, 'Shot', data, keys)
 
+        keys = ['project','user']
+        data = {'project':self.project,
+                'user':self.human_user,
+                'content':'anything'}
+        self.note = _find_or_create_entity(self.sg, 'Note', data, keys)
+
 
 class SgTestConfig(object):
     '''Reads test config and holds values'''
diff --git a/tests/example_config b/tests/example_config
@@ -1,14 +1,5 @@
-# Example server and login information to use for tests. This file should be renamed
-# to config and the appropriate values should be added.
-#
-# The unit tests can either connect to a server or use a mock server connection.
-# When connected to a server they use the entity id's listed below to add, 
-# update and delete values. They also add, update and delete schema fields.    
-# 
-# For more details see the test_client.py file.
-
-[TEST_RUN_OPTIONS]
-mock:True
+# Example server and login information to use for tests which require a live server.
+# This file should be renamed to config and the appropriate values should be added.
 
 [SERVER_INFO]
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -14,6 +14,8 @@
 class TestShotgunApi(base.LiveTestBase):
     def setUp(self):
         super(TestShotgunApi, self).setUp()
+        # give note unicode content
+        self.sg.update('Note', self.note['id'], {'content':u'La Pe\xf1a'})
         
     def test_info(self):
         """Called info"""
@@ -174,3 +176,33 @@ def test_simple_summary(self):
         assert(result['groups'][0]['summaries'])
         assert(result['summaries'])
 
+    def test_ensure_ascii(self):
+        '''test_ensure_ascii tests ensure_unicode flag.'''
+        sg_ascii = api.Shotgun(self.config.server_url, 
+                              self.config.script_name, 
+                              self.config.api_key, 
+                              ensure_ascii=True)
+
+        result = sg_ascii.find_one('Note', [['id','is',self.note['id']]], fields=['content'])
+        self.assertFalse(_has_unicode(result))
+
+
+    def test_ensure_unicode(self):
+        '''test_ensure_unicode tests ensure_unicode flag.'''
+        sg_unicode = api.Shotgun(self.config.server_url, 
+                              self.config.script_name, 
+                              self.config.api_key, 
+                              ensure_ascii=False)
+        result = sg_unicode.find_one('Note', [['id','is',self.note['id']]], fields=['content'])
+        print result
+        self.assertTrue(_has_unicode(result))
+
+def _has_unicode(data):
+    for k, v in data.items():
+        if (isinstance(k, unicode)):
+            return True
+        if (isinstance(v, unicode)):
+            return True
+    return False
+
+
