Support for versioned @query type

faunadb/__init__.py

@@ -3,3 +3,4 @@
 __author__ = "Fauna, Inc"
 __license__ = "MPL 2.0"
 __copyright__ = "2020 Fauna, Inc"
+__api_version__ = "3"

faunadb/client.py

@@ -7,13 +7,12 @@
 from requests.auth import HTTPBasicAuth
 from requests.adapters import HTTPAdapter
 
+from faunadb import __api_version__
 from faunadb.errors import _get_or_raise, FaunaError, UnexpectedError
 from faunadb.query import _wrap
 from faunadb.request_result import RequestResult
 from faunadb._json import parse_json_or_none, to_json
 
-API_VERSION = "3"
-
 class _LastTxnTime(object):
   """Wraps tracking the last transaction time supplied from the database."""
   def __init__(self):
@@ -138,7 +137,7 @@ def __init__(
         "Accept-Encoding": "gzip",
         "Content-Type": "application/json;charset=utf-8",
         "X-Fauna-Driver": "python",
-        "X-FaunaDB-API-Version": API_VERSION
+        "X-FaunaDB-API-Version": __api_version__
       })
       if self._query_timeout_ms is not None:
         self.session.headers["X-Query-Timeout"] = str(self._query_timeout_ms)

faunadb/objects.py

@@ -7,6 +7,7 @@
 from iso8601 import parse_date
 from faunadb.deprecated import deprecated
 from faunadb.query import _Expr
+from faunadb import __api_version__
 
 class Ref(_Expr):
   """
@@ -170,6 +171,16 @@ class Query(_Expr):
   See the `docs <https://app.fauna.com/documentation/reference/queryapi#special-type>`__.
   """
 
+  def __init__(self, value):
+    """
+    :param value:
+      If an api_version key is not defined, `faunadb.__api_version__` is used.
+    """
+    if isinstance(value, dict):
+      if not "api_version" in value:
+        value["api_version"] =  __api_version__
+    super(Query, self).__init__(value)
+
   def to_fauna_json(self):
     return {"@query": self.value}
 

tests/test_deserialization.py

@@ -1,6 +1,7 @@
 from unittest import TestCase
 from iso8601 import parse_date
 
+from faunadb import __api_version__
 from faunadb.objects import Ref, SetRef, FaunaTime, Query, Native
 from faunadb._json import parse_json
 
@@ -47,7 +48,14 @@ def test_bytes(self):
     self.assertJson('{"@bytes":"AQID"}', bytearray(b'\x01\x02\x03'))
 
   def test_query(self):
+    self.assertJson('{"@query": {"api_version": "3", "lambda": "x", "expr": {"var": "x"}}}',
+                    Query({"api_version":"3", "lambda": "x", "expr": {"var": "x"}}))
     self.assertJson('{"@query": {"lambda": "x", "expr": {"var": "x"}}}',
+                    Query({"api_version": "3", "lambda": "x", "expr": {"var": "x"}}))
+    self.assertJson('{"@query":  {"lambda": "x", "expr": {"var": "x"}}}',
+                    Query({"lambda": "x", "expr": {"var": "x"}}))
+    self.assertJson('{"@query":  {"api_version":"%s", "lambda": "x", "expr": {"var": "x"}}}'
+                    %(__api_version__),
                     Query({"lambda": "x", "expr": {"var": "x"}}))
 
   def test_string(self):

tests/test_query.py

@@ -3,7 +3,7 @@
 from time import sleep
 
 from faunadb.errors import BadRequest, NotFound
-from faunadb.objects import FaunaTime, Ref, SetRef, _Expr, Native
+from faunadb.objects import FaunaTime, Ref, SetRef, _Expr, Native, Query
 from faunadb import query
 from tests.helpers import FaunaTestCase
 
@@ -60,6 +60,14 @@ def _assert_bad_query(self, q):
   def test_abort(self):
     self._assert_bad_query(query.abort("aborting"))
 
+  def test_query(self):
+    body = self._q(query.query(lambda a, b: query.concat([a, b], "/")))
+    bodyEchoed = self._q(body)
+
+    self.assertEqual(body, bodyEchoed)
+    self.assertEqual(body, Query({"api_version":"3", "lambda": ["a", "b"], "expr": {"concat": [{"var": "a"}, {"var": "b"}], "separator": "/"}}))
+
+
   def test_at(self):
     document = self._create(n=1)
     ref = document["ref"]

tests/test_serialization.py

@@ -3,7 +3,7 @@
 from unittest import TestCase
 import iso8601
 
-from faunadb import query
+from faunadb import query, __api_version__
 from faunadb.objects import Ref, SetRef, FaunaTime, Query, Native
 from faunadb._json import to_json
 
@@ -44,8 +44,11 @@ def test_bytes(self):
       self.assertJson(b'\x01\x02\x03', '{"@bytes":"AQID"}')
 
   def test_query(self):
-    self.assertJson(Query({"lambda": "x", "expr": {"var": "x"}}),
-                    '{"@query":{"expr":{"var":"x"},"lambda":"x"}}')
+    expected1 = '{"@query":{"api_version":"%s","expr":{"var":"x"},"lambda":"x"}}'%(
+        __api_version__)
+    self.assertJson(Query({"lambda": "x", "expr": {"var": "x"}}), expected1)
+    self.assertJson(Query({"api_version": "2.12", "lambda": "x", "expr": {"var": "x"}}),
+                    '{"@query":{"api_version":"2.12","expr":{"var":"x"},"lambda":"x"}}')
 
   #region Basic forms