fix issue where passing None as parameter to a query would fail (#8)

Author: thrau

tests/integration/test_pipes.py

@@ -126,6 +126,15 @@ def test_query_with_params(self, client):
         response = client.api.pipes.query("simple_pipe", parameters={"key": "does not exist"})
         assert response.data == []
 
+        # test with none parameters
+        response = client.api.pipes.query("simple_pipe", parameters={"key": None})
+        # simple check to make sure it returned all items
+        assert [(record["key"], record["value"]) for record in response.data] == [
+            ("foo", "bar"),
+            ("baz", "ed"),
+            ("foo", "bar2"),
+        ]
+
     def test_query_with_sql(self, client):
         client.api.events.send(
             "simple",

tests/integration/test_query.py

@@ -58,6 +58,19 @@ def test_query_pipe_parameters(self, client):
         assert response.rows == 1
         assert response.statistics["rows_read"] == 2
 
+    def test_query_pipe_with_none_parameters(self, client):
+        response = client.api.query.query(
+            "SELECT key, value FROM simple_pipe ORDER BY key ASC", parameters={"key": None}
+        )
+
+        assert response.data == [{"key": "baz", "value": "ed"}, {"key": "foo", "value": "bar"}]
+        assert response.meta == [
+            {"name": "key", "type": "String"},
+            {"name": "value", "type": "String"},
+        ]
+        assert response.rows == 2
+        assert response.statistics["rows_read"] == 2
+
     def test_query_pipeline_json(self, client):
         response = client.api.query.query(
             "SELECT * FROM _ ORDER BY `key` ASC", pipeline="simple_kv"

verdin/__init__.py

@@ -1,3 +1,3 @@
 name = "verdin"
 
-__version__ = "0.5.1"
+__version__ = "0.5.2"

verdin/api/pipes.py

@@ -230,7 +230,7 @@ def query(
         self,
         name: str,
         query: str = None,
-        parameters: dict[str, str] = None,
+        parameters: dict[str, str | None] = None,
         format: PipeOutputFormat = "json",
     ) -> QueryPipeResponse | QueryPipeJsonResponse | QueryPipeNdjsonResponse | QueryPipeCsvResponse:
         """
@@ -256,6 +256,8 @@ def query(
         # this limit is around 8kb, so if it's too large, we use a POST request instead.
         qsize = 1  # include the "?" character
         for k, v in params.items():
+            if v is None:
+                continue
             qsize += len(k) + len(v) + 2  # include the ``&`` and ``=`` character
 
         if qsize > 8192:

verdin/api/query.py

@@ -161,7 +161,7 @@ def query(
         self,
         query: str,
         pipeline: str = None,
-        parameters: dict[str, str] = None,
+        parameters: dict[str, str | None] = None,
         output_format_json_quote_64bit_integers: bool = False,
         output_format_json_quote_denormals: bool = False,
         output_format_parquet_string_as_string: bool = False,
@@ -216,6 +216,8 @@ def query(
         # this limit is around 8kb, so if it's too large, we use a POST request instead.
         qsize = 1  # include the "?" character
         for k, v in data.items():
+            if v is None:
+                continue
             qsize += len(k) + len(v) + 2  # include the ``&`` and ``=`` character
 
         if qsize > 8192 or parameters:

verdin/test/container.py

@@ -8,6 +8,8 @@
 
 
 class TinybirdLocalContainer:
+    # TODO: easier configuration of compatibility mode
+
     def __init__(self, cwd: str = None):
         """
         Creates a new TinybirdLocalContainer instance.