Merge lp:~openerp-dev/openobject-server/trunk-check-ids-thu into lp:openobject-server

[Vo Minh Thu]

[lp:~openerp-dev/openobject-server/trunk-check-ids-thu]

4827. By Vo Minh Thu on 2013-05-06

[MERGE] merged trunk.

Unmerged revisions

4827. By Vo Minh Thu on 2013-05-06

[MERGE] merged trunk.

4826. By Vo Minh Thu on 2013-03-15

[REF] orm: added a deprecation warning helper for IDs check.

4825. By Vo Minh Thu on 2013-03-14

[REF] orm: deprecation warning when passing a single ID to read().

=== modified file 'openerp/addons/base/res/res_users.py'
--- openerp/addons/base/res/res_users.py	2013-04-04 13:07:04 +0000
+++ openerp/addons/base/res/res_users.py	2013-05-06 13:13:33 +0000
@@ -256,6 +256,8 @@
     SELF_READABLE_FIELDS = ['signature', 'company_id', 'login', 'email', 'name', 'image', 'image_medium', 'image_small', 'lang', 'tz', 'tz_offset', 'groups_id', 'partner_id', '__last_update']
 
     def read(self, cr, uid, ids, fields=None, context=None, load='_classic_read'):
+        openerp.conf.deprecation.check_single_id(self, 'read', ids, _logger)
+
         def override_password(o):
             if 'password' in o and ('id' not in o or o['id'] != uid):
                 o['password'] = '********'
@@ -280,6 +282,7 @@
         return result
 
     def write(self, cr, uid, ids, values, context=None):
+        openerp.conf.deprecation.check_single_id(self, 'write', ids, _logger)
         if not hasattr(ids, '__iter__'):
             ids = [ids]
         if ids == [uid]:

=== modified file 'openerp/conf/deprecation.py'
--- openerp/conf/deprecation.py	2013-03-27 16:40:45 +0000
+++ openerp/conf/deprecation.py	2013-05-06 13:13:33 +0000
@@ -37,6 +37,27 @@
 # Change to False around 2013.02.
 open_openerp_namespace = False
 
+# If True the old behavior of allowing a single ID to the orm methods is kept
+# but a warning is dieplayed in the logs. Otherwise raise an exception.
+# Introduced around 2013.03.
+allow_single_id = True
+
+def check_single_id(model, method, ids, logger):
+    if isinstance(ids, (int, long)):
+        if allow_single_id:
+            logger.warning('Passing a single ID to %s.%s() is deprecated.\n%s', model._name, method, get_caller(up=3))
+        else:
+            raise TypeError, 'Cannot pass a single ID to %s.%s().' % (model._name, method)
+
+def get_caller(up=2):
+    import inspect
+    try:
+        frame,filename,line_number,function_name,lines,index=\
+            inspect.getouterframes(inspect.currentframe())[up]
+        return "Called in %s() at %s:%s." % (function_name, filename, line_number)
+    except Exception, e:
+        return "Called in an unknown location, probably inside a safe_eval()."
+
 # If True, openerp.netsvc.LocalService() can be used to lookup reports or to
 # access openerp.workflow.
 # Introduced around 2013.03.

=== modified file 'openerp/osv/orm.py'
--- openerp/osv/orm.py	2013-04-22 09:36:55 +0000
+++ openerp/osv/orm.py	2013-05-06 13:13:33 +0000
@@ -3599,16 +3599,13 @@
 
         self.check_access_rights(cr, user, 'read')
         fields = self.check_field_access_rights(cr, user, 'read', fields)
-        if isinstance(ids, (int, long)):
-            select = [ids]
-        else:
-            select = ids
-        select = map(lambda x: isinstance(x, dict) and x['id'] or x, select)
-        result = self._read_flat(cr, user, select, fields, context, load)
-
-        if isinstance(ids, (int, long)):
+        openerp.conf.deprecation.check_single_id(self, 'read', ids, _logger)
+        if isinstance(ids, (int, long)):
+            result = self._read_flat(cr, user, [ids], fields, context, load)
             return result and result[0] or False
-        return result
+        else:
+            result = self._read_flat(cr, user, ids, fields, context, load)
+            return result
 
     def _read_flat(self, cr, user, ids, fields_to_read, context=None, load='_classic_read'):
         if not context:
@@ -4105,6 +4102,7 @@
 
         if not context:
             context = {}
+        openerp.conf.deprecation.check_single_id(self, 'write', ids, _logger)
         if not ids:
             return True
         if isinstance(ids, (int, long)):