crud, SQL: implement order, group, limit and offset in get() request

DataSource/MySQL/leapidatasource.py

@@ -42,7 +42,8 @@ class LeDataSourceSQL(DummyDatasource):
     # @todo this only works with LeObject.get(), LeClass.get() and LeType.get()
     # @todo for speed get rid of all_to_dicts
     # @todo filters: all use cases are not implemented
-    def select(self, target_cls, field_list, filters, rel_filters=None):
+    # @todo group: mosql does not permit direction in group_by clause, it should, so for now we don't use direction in group clause
+    def select(self, target_cls, field_list, filters, rel_filters=None, order=None, group=None, limit=None, offset=None):
 
         joins = []
         # it is a LeObject, query only on main table
@@ -61,10 +62,20 @@ class LeDataSourceSQL(DummyDatasource):
             joins = [left_join(class_table, {main_lodel_id:class_lodel_id})]
             fields = [(main_table, common_fields), (class_table, main_class.fieldlist())]
 
-        # prefix column name in field list
+        # prefix column name in fields list
         prefixed_field_list = [self.datasource_utils.find_prefix(name, fields) for name in field_list]
 
-        # @todo implement that
+        kwargs = {}
+        if group:
+            kwargs['group_by'] = (self.datasource_utils.find_prefix(column, fields) for column, direction in group)
+        if order:
+            kwargs['order_by'] = (self.datasource_utils.find_prefix(column, fields) + ' ' + direction for column, direction in order)
+        if limit:
+            kwargs['limit'] = limit
+        if offset:
+            kwargs['offset'] = offset
+
+       # @todo implement that
         #if rel_filters is not None and len(rel_filters) > 0:
             #rel_filters = self._prepare_rel_filters(rel_filters)
             #for rel_filter in rel_filters:
@@ -78,7 +89,7 @@ class LeDataSourceSQL(DummyDatasource):
 
         # prefix filters'' column names, and prepare dict for mosql where {(fieldname, op): value}
         wheres = {(self.datasource_utils.find_prefix(name, fields), op):value for name,op,value in filters}
-        query = select(main_table, select=prefixed_field_list, where=wheres, joins=joins)
+        query = select(main_table, select=prefixed_field_list, where=wheres, joins=joins, **kwargs)
         #print ('SQL', query)
 
         # Executing the query

DataSource/dummy/leapidatasource.py

@@ -10,13 +10,17 @@ class DummyDatasource(object):
         self.module = module
         self.conn_args = conn_args
         self.conn_kargs = conn_kargs
-    
+
     ## @brief select lodel editorial components given filters
     # @param target_cls LeCrud(class) : The component class concerned by the insert (a LeCrud child class (not instance !) )
     # @param filters list : List of filters (see @ref leobject_filters )
     # @param rel_filters list : List of relationnal filters (see @ref leobject_filters )
+    # @param group list of tupple: List of column to group together.  group = [('titre', 'ASC'), ]
+    # @param order list of tupple : List of column to order.  order = [('titre', 'ASC'), ]
+    # @param limit int : Number of row to be returned
+    # @param offset int : Used with limit to choose the start row
     # @return a list of LeCrud child classes
-    def select(self, target_cls, field_list, filters, rel_filters):
+    def select(self, target_cls, field_list, filters, rel_filters=None, order=None, group=None, limit=None, offset=0):
         pass
 
     ## @brief delete lodel editorial components given filters

leapi/leclass.py

@@ -37,6 +37,6 @@ class _LeClass(_LeObject):
         return cls.fieldtypes().keys()
 
     @classmethod
-    def get(cls, query_filters, field_list = None):
+    def get(cls, query_filters, field_list=None, order=None, group=None, limit=None, offset=0):
         query_filters.append(('class_id', '=', cls._class_id))
-        return super().get(query_filters, field_list)
+        return super().get(query_filters, field_list, order=order, group=group, limit=limit, offset=offset)

leapi/lecrud.py

@@ -257,7 +257,7 @@ class _LeCrud(object):
     # @return A list of lodel editorial components instance
     # @todo think about LeObject and LeClass instanciation (partial instanciation, etc)
     @classmethod
-    def get(cls, query_filters, field_list = None, order = None, groups = None, limit = None, offset = 0):
+    def get(cls, query_filters, field_list=None, order=None, group=None, limit=None, offset=0):
         if field_list is None or len(field_list) == 0:
             #default field_list
             field_list = cls.fieldlist()
@@ -268,20 +268,16 @@ class _LeCrud(object):
         filters, relational_filters = cls._prepare_filters(query_filters)
         
         #preparing order
-        if order is None:
-            order = []
-        else:
-            order = self._prepare_order_fields(order)
+        if order:
+            order = cls._prepare_order_fields(order)
             if isinstance(order, Exception):
                 raise order #can be buffered and raised later, but _prepare_filters raise when fails
 
-        #preparing groups
-        if groups is None:
-            groups = []
-        else:
-            groups = cls._order_fields(groups)
-            if isinstance(groups, Exception):
-                raise groups # can also be buffered and raised later
+        #preparing group
+        if group:
+            group = cls._prepare_order_fields(group)
+            if isinstance(group, Exception):
+                raise group # can also be buffered and raised later
 
         #checking limit and offset values
         if not (limit is None):
@@ -292,7 +288,7 @@ class _LeCrud(object):
                 raise ValueError("Invalid offset given : %d"%offset)
 
         #Fetching editorial components from datasource
-        results = cls._datasource.select(cls, field_list, filters, relational_filters, order, groups, limit, offset)
+        results = cls._datasource.select(cls, field_list, filters, relational_filters, order=order, group=group, limit=limit, offset=offset)
 
         return results
 

leapi/test/test_lecrud.py

@@ -299,7 +299,7 @@ class LeCrudTestCase(TestCase):
 
         for callcls, field_list, filters, fl_ds, filters_ds, rfilters_ds in args:
             callcls.get(filters, field_list)
-            dsmock.assert_called_with(callcls, fl_ds, filters_ds, rfilters_ds, [], [], None, 0)
+            dsmock.assert_called_with(callcls, fl_ds, filters_ds, rfilters_ds, order=None, group=None, limit=None, offset=0)
             dsmock.reset_mock()
     
     #