chore: bump httpx to 0.24.1 (#277)

* fix: use new httpx parameter encoding in tests

httpx changed how it formats query parameters in 0.24.0 - see here
https://github.com/encode/httpx/blob/master/CHANGELOG.md#0240-6th-april-2023

* chore: bump version

* 'Refactored by Sourcery' (#280)

Co-authored-by: Sourcery AI <>

---------

Co-authored-by: [email protected] <[email protected]>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: 3 people

poetry.lock

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__version__ = "0.10.7"
+__version__ = "0.10.8"
 
 from httpx import Timeout
 

postgrest/__init__.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "postgrest"
-version = "0.10.7"
+version = "0.10.8"
 description = "PostgREST client for Python. This library provides an ORM interface to PostgREST."
 authors = ["Lương Quang Mạnh <[email protected]>", "Joel Lee <[email protected]>", "Anand"]
 homepage = "https://github.com/supabase-community/postgrest-py"
@@ -19,7 +19,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
-httpx = "^0.23.0"
+httpx = "^0.24.0"
 deprecation = "^2.1.0"
 pydantic = ">=2.1.0,<3.0"
 strenum = "^0.4.9"

pyproject.toml

@@ -48,7 +48,7 @@ def test_filter_special_characters(
 ):
     builder = filter_request_builder.filter(col_name, "eq", "val")
 
-    assert str(builder.params) == expected_query_prefix + "=eq.val"
+    assert str(builder.params) == f"{expected_query_prefix}=eq.val"
 
 
 def test_multivalued_param(filter_request_builder):
@@ -78,7 +78,7 @@ def test_contains_dictionary(filter_request_builder):
     builder = filter_request_builder.contains("x", {"a": "b"})
 
     # {"a":"b"}
-    assert str(builder.params) == "x=cs.%7B%22a%22%3A+%22b%22%7D"
+    assert str(builder.params) == "x=cs.%7B%22a%22%3A%20%22b%22%7D"
 
 
 def test_contains_any_item(filter_request_builder):
@@ -91,12 +91,12 @@ def test_contains_any_item(filter_request_builder):
 def test_contains_in_list(filter_request_builder):
     builder = filter_request_builder.contains("x", '[{"a": "b"}]')
 
-    # [{"a":+"b"}] (the + represents the space)
-    assert str(builder.params) == "x=cs.%5B%7B%22a%22%3A+%22b%22%7D%5D"
+    # [{"a":%20"b"}] (the %20 represents the space)
+    assert str(builder.params) == "x=cs.%5B%7B%22a%22%3A%20%22b%22%7D%5D"
 
 
 def test_contained_by_mixed_items(filter_request_builder):
     builder = filter_request_builder.contained_by("x", ["a", '["b", "c"]'])
 
-    # {a,["b",+"c"]}
-    assert str(builder.params) == "x=cd.%7Ba%2C%5B%22b%22%2C+%22c%22%5D%7D"
+    # {a,["b",%20"c"]}
+    assert str(builder.params) == "x=cd.%7Ba%2C%5B%22b%22%2C%20%22c%22%5D%7D"

tests/_async/test_filter_request_builder.py

@@ -124,7 +124,7 @@ def test_text_search(self, request_builder: AsyncRequestBuilder):
                 "config": "english",
             },
         )
-        assert "catchphrase=plfts%28english%29.%27fat%27+%26+%27cat%27" in str(
+        assert "catchphrase=plfts%28english%29.%27fat%27%20%26%20%27cat%27" in str(
             builder.params
         )
 

tests/_async/test_request_builder.py

@@ -48,7 +48,7 @@ def test_filter_special_characters(
 ):
     builder = filter_request_builder.filter(col_name, "eq", "val")
 
-    assert str(builder.params) == expected_query_prefix + "=eq.val"
+    assert str(builder.params) == f"{expected_query_prefix}=eq.val"
 
 
 def test_multivalued_param(filter_request_builder):
@@ -78,7 +78,7 @@ def test_contains_dictionary(filter_request_builder):
     builder = filter_request_builder.contains("x", {"a": "b"})
 
     # {"a":"b"}
-    assert str(builder.params) == "x=cs.%7B%22a%22%3A+%22b%22%7D"
+    assert str(builder.params) == "x=cs.%7B%22a%22%3A%20%22b%22%7D"
 
 
 def test_contains_any_item(filter_request_builder):
@@ -91,12 +91,12 @@ def test_contains_any_item(filter_request_builder):
 def test_contains_in_list(filter_request_builder):
     builder = filter_request_builder.contains("x", '[{"a": "b"}]')
 
-    # [{"a":+"b"}] (the + represents the space)
-    assert str(builder.params) == "x=cs.%5B%7B%22a%22%3A+%22b%22%7D%5D"
+    # [{"a":%20"b"}] (the %20 represents the space)
+    assert str(builder.params) == "x=cs.%5B%7B%22a%22%3A%20%22b%22%7D%5D"
 
 
 def test_contained_by_mixed_items(filter_request_builder):
     builder = filter_request_builder.contained_by("x", ["a", '["b", "c"]'])
 
-    # {a,["b",+"c"]}
-    assert str(builder.params) == "x=cd.%7Ba%2C%5B%22b%22%2C+%22c%22%5D%7D"
+    # {a,["b",%20"c"]}
+    assert str(builder.params) == "x=cd.%7Ba%2C%5B%22b%22%2C%20%22c%22%5D%7D"

tests/_sync/test_filter_request_builder.py

@@ -124,11 +124,28 @@ def test_text_search(self, request_builder: SyncRequestBuilder):
                 "config": "english",
             },
         )
-        assert "catchphrase=plfts%28english%29.%27fat%27+%26+%27cat%27" in str(
+        assert "catchphrase=plfts%28english%29.%27fat%27%20%26%20%27cat%27" in str(
             builder.params
         )
 
 
+class TestExplain:
+    def test_explain_plain(self, request_builder: SyncRequestBuilder):
+        builder = request_builder.select("*").explain()
+        assert builder.params["select"] == "*"
+        assert "application/vnd.pgrst.plan+" in str(builder.headers.get("accept"))
+
+    def test_explain_options(self, request_builder: SyncRequestBuilder):
+        builder = request_builder.select("*").explain(
+            format="json", analyze=True, verbose=True, buffers=True, wal=True
+        )
+        assert builder.params["select"] == "*"
+        assert "application/vnd.pgrst.plan+json" in str(builder.headers.get("accept"))
+        assert 'options="analyze|verbose|buffers|wal;' in str(
+            builder.headers.get("accept")
+        )
+
+
 @pytest.fixture
 def api_response_with_error() -> Dict[str, Any]:
     return {