Merge lp:~akretion-team/openobject-addons/trunk_addons_ref_product_available into lp:openobject-addons

[Benoit Guillot - http://www.akretion.com]

Hello,

This merge proposal refactors the method get_product_available() in the module stock.

It adds methods to prepare the where params (_get_where_params()) and the query (_get_query()) of the sql request which finds whether product is available or not.

It allows us to reuse these methods for a custom fields for example.

Unmerged revisions

8078. By Benoit Guillot - http://www.akretion.com on 2012-11-20

[REF] ref method get_product_available by adding methods to prepare the params and the query of the sql request which finds the availability of the products

=== modified file 'stock/product.py'
--- stock/product.py	2012-11-02 17:34:07 +0000
+++ stock/product.py	2012-11-22 08:49:24 +0000
@@ -195,10 +195,16 @@
         if (context.get('active_id', False)) and (context.get('active_model') == 'stock.location'):
             return _('Products: ')+self.pool.get('stock.location').browse(cr, user, context['active_id'], context).name
         return res
+    
+    def _get_where_params(self, cr, uid, ids, context=None):
+        """Prepare the list of tuples used in the sql request to get the
+           availability of the products. This method may be overridden
+           to implement custom calculation of the availability of the
+           products (making sure to call super() to establish a clean
+           extension chain).
 
-    def get_product_available(self, cr, uid, ids, context=None):
-        """ Finds whether product is available or not in particular warehouse.
-        @return: Dictionary of values
+           :param list(int) ids: list of product ids to get availability
+           :return: list of tuples
         """
         if context is None:
             context = {}
@@ -208,13 +214,7 @@
         shop_obj = self.pool.get('sale.shop')
         
         states = context.get('states',[])
-        what = context.get('what',())
-        if not ids:
-            ids = self.search(cr, uid, [])
-        res = {}.fromkeys(ids, 0.0)
-        if not ids:
-            return res
-
+        
         if context.get('shop', False):
             warehouse_id = shop_obj.read(cr, uid, int(context['shop']), ['warehouse_id'])['warehouse_id'][0]
             if warehouse_id:
@@ -243,66 +243,97 @@
             child_location_ids = location_obj.search(cr, uid, [('location_id', 'child_of', location_ids)])
             location_ids = child_location_ids or location_ids
         
-        # this will be a dictionary of the product UoM by product id
-        product2uom = {}
-        uom_ids = []
-        for product in self.read(cr, uid, ids, ['uom_id'], context=context):
-            product2uom[product['id']] = product['uom_id'][0]
-            uom_ids.append(product['uom_id'][0])
-        # this will be a dictionary of the UoM resources we need for conversion purposes, by UoM id
-        uoms_o = {}
-        for uom in self.pool.get('product.uom').browse(cr, uid, uom_ids, context=context):
-            uoms_o[uom.id] = uom
-
-        results = []
-        results2 = []
-
+        where = [tuple(location_ids),tuple(location_ids),tuple(ids),tuple(states)]
+
+        if context.get('date_filter') in ['between', 'from_date']:
+            where.append(tuple([from_date]))
+        if context.get('date_filter') in ['between', 'to_date']:
+            where.append(tuple([to_date]))
+        
+        return where
+    
+    def _get_query(self, cr, uid, what, context=None):
+        """Prepare the string query used in the sql request to get the
+           availability of the products. This method may be overridden
+           to implement custom calculation of the availability of the
+           products (making sure to call super() to establish a clean
+           extension chain).
+
+           :param str what: str to define type of location to search
+           :param list(int) ids: list of ids of products to get availability
+           :return: str
+        """
+        if context is None:
+            context = {}
+        date_query = {
+            'between': "date>=%s and date<=%s",
+            'from_date': "date>=%s",
+            'to_date': "date<=%s",
+        }
+        
+        prodlot_id = context.get('prodlot_id', False)
+
+        query = 'select sum(product_qty), product_id, product_uom '\
+            'from stock_move '\
+            'where location_id' + (what=='in' and ' NOT' or ' ') + ' IN  %s '\
+            'and location_dest_id' + (what=='out' and ' NOT' or ' ') + ' IN %s '\
+            'and product_id IN %s '\
+            '' + (prodlot_id and ('and prodlot_id = ' + str(prodlot_id)) or '') + ' '\
+            'and state IN %s ' + (date_query.get(context.get('date_filter')) or '') +' '\
+            'group by product_id,product_uom'
+        return query
+
+    def get_product_available(self, cr, uid, ids, context=None):
+        """ Finds whether product is available or not in particular warehouse.
+        @return: Dictionary of values
+        """
+        if context is None:
+            context = {}
+        
+        what = context.get('what',())
+        if not ids:
+            ids = self.search(cr, uid, [])
+        res = {}.fromkeys(ids, 0.0)
+        if not ids:
+            return res
+        
         from_date = context.get('from_date',False)
         to_date = context.get('to_date',False)
-        date_str = False
-        date_values = False
-        where = [tuple(location_ids),tuple(location_ids),tuple(ids),tuple(states)]
+        
         if from_date and to_date:
-            date_str = "date>=%s and date<=%s"
-            where.append(tuple([from_date]))
-            where.append(tuple([to_date]))
+            context['date_filter'] = 'between'
         elif from_date:
-            date_str = "date>=%s"
-            date_values = [from_date]
+            context['date_filter'] = 'from_date'
         elif to_date:
-            date_str = "date<=%s"
-            date_values = [to_date]
-
-        prodlot_id = context.get('prodlot_id', False)
-
-    # TODO: perhaps merge in one query.
-        if date_values:
-            where.append(tuple(date_values))
+            context['date_filter'] = 'to_date'
+
+        where = self._get_where_params(cr, uid, ids, context=context)
+        
+        results = []
+        results2 = []
+        # TODO: perhaps merge in one query.
         if 'in' in what:
             # all moves from a location out of the set to a location in the set
-            cr.execute(
-                'select sum(product_qty), product_id, product_uom '\
-                'from stock_move '\
-                'where location_id NOT IN %s '\
-                'and location_dest_id IN %s '\
-                'and product_id IN %s '\
-                '' + (prodlot_id and ('and prodlot_id = ' + str(prodlot_id)) or '') + ' '\
-                'and state IN %s ' + (date_str and 'and '+date_str+' ' or '') +' '\
-                'group by product_id,product_uom',tuple(where))
+            query = self._get_query(cr, uid, 'in', context=context)
+            cr.execute(query,tuple(where))
             results = cr.fetchall()
         if 'out' in what:
             # all moves from a location in the set to a location out of the set
-            cr.execute(
-                'select sum(product_qty), product_id, product_uom '\
-                'from stock_move '\
-                'where location_id IN %s '\
-                'and location_dest_id NOT IN %s '\
-                'and product_id  IN %s '\
-                '' + (prodlot_id and ('and prodlot_id = ' + str(prodlot_id)) or '') + ' '\
-                'and state in %s ' + (date_str and 'and '+date_str+' ' or '') + ' '\
-                'group by product_id,product_uom',tuple(where))
+            query = self._get_query(cr, uid, 'out', context=context)
+            cr.execute(query,tuple(where))
             results2 = cr.fetchall()
-            
+
+        # this will be a dictionary of the product UoM by product id
+        product2uom = {}
+        uom_ids = []
+        for product in self.read(cr, uid, ids, ['uom_id'], context=context):
+            product2uom[product['id']] = product['uom_id'][0]
+            uom_ids.append(product['uom_id'][0])
+        # this will be a dictionary of the UoM resources we need for conversion purposes, by UoM id
+        uoms_o = {}
+        for uom in self.pool.get('product.uom').browse(cr, uid, uom_ids, context=context):
+            uoms_o[uom.id] = uom
+        
         # Get the missing UoM resources
         uom_obj = self.pool.get('product.uom')
         uoms = map(lambda x: x[2], results) + map(lambda x: x[2], results2)