Merge lp:~ack/storm/resultset-get-query into lp:storm

[Alberto Donato]

This adds a get_query() method to ResultSet, returning the query and parameters that generated the resultset.
Mostly intended for debugging purpose.

[Christopher Armstrong (radix)]

[1] I think this should use the database-specific compile function to make sure that the query that is returned is exactly what will be sent to the database.

[lp:~ack/storm/resultset-get-query]

455. By Alberto Donato on 2012-11-13

Use the Connection compile function.

[Alberto Donato (ack)]

> [1] I think this should use the database-specific compile function to make
> sure that the query that is returned is exactly what will be sent to the
> database.

Done! thanks

[Christopher Armstrong (radix)]

Looks good.

review: Approve

Unmerged revisions

455. By Alberto Donato on 2012-11-13

Use the Connection compile function.

454. By Alberto Donato on 2012-11-12

Add get_query().

=== modified file 'storm/store.py'
--- storm/store.py	2012-06-12 10:00:51 +0000
+++ storm/store.py	2012-11-13 09:42:19 +0000
@@ -33,7 +33,7 @@
 from storm.expr import (
     Expr, Select, Insert, Update, Delete, Column, Count, Max, Min,
     Avg, Sum, Eq, And, Asc, Desc, compile_python, compare_columns, SQLRaw,
-    Union, Except, Intersect, Alias, SetExpr)
+    Union, Except, Intersect, Alias, SetExpr, State)
 from storm.exceptions import (
     WrongStoreError, NotFlushedError, OrderLoopError, UnorderedError,
     NotOneError, FeatureError, CompileError, LostObjectError, ClassInfoError)
@@ -1473,6 +1473,17 @@
                 result_set._where = And(result_set._where, extra_where)
         return result_set
 
+    def get_query(self):
+        """
+        Return the query associated with this L{ResultSet}.
+
+        @return: A tuple with the query and its parameters.
+        """
+        s = State()
+        query = self._store._connection.compile(self._get_select(), s)
+        params = tuple(param.get() for param in s.parameters)
+        return query, params
+
     def _set_expr(self, expr_cls, other, all=False):
         if not self._find_spec.is_compatible(other._find_spec):
             raise FeatureError("Incompatible results for set operation")
 
=== modified file 'tests/store/base.py'
--- tests/store/base.py	2012-04-06 08:19:07 +0000
+++ tests/store/base.py	2012-11-13 09:42:19 +0000
@@ -1508,6 +1508,31 @@
         self.assertEquals(sorted((foo.id, title) for (foo, title) in result),
                           [(20, u"Title 200"), (30, u"Title 100")])
 
+    def test_get_query(self):
+        """
+        L{ResultSet.get_query} returns the query associated to the
+        L{ResultSet}.
+        """
+        result = self.store.find(Bar, Bar.foo_id == Foo.id)
+        query, params = result.get_query()
+        self.assertEqual(
+            "SELECT bar.foo_id, bar.id, bar.title FROM bar, foo "
+            "WHERE bar.foo_id = foo.id",
+            query)
+        self.assertEqual((), params)
+
+    def test_get_query_with_params(self):
+        """
+        L{ResultSet.get_query} includes values for query parameters.
+        """
+        result = self.store.find(Foo, Foo.id > 3, Foo.title.like(u"foo"))
+        query, params = result.get_query()
+        self.assertEqual(
+            "SELECT foo.id, foo.title FROM foo "
+            "WHERE foo.id > ? AND foo.title LIKE ?",
+            query)
+        self.assertEqual((3, "foo"), params)
+
     def test_get_does_not_validate(self):
         def validator(object, attr, value):
             self.fail("validator called with arguments (%r, %r, %r)" %