From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Sat, 26 Jun 2021 23:36:35 +0000 (+0100)
Subject: Give Json wrappers a dumps method
X-Git-Tag: 3.0.dev0~14^2~4
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ffef6f3e96eb821b3bf8bc57a0396c07df366a39;p=thirdparty%2Fpsycopg.git

Give Json wrappers a dumps method

In the previous model, dumping a specific json object with a specific
dumper was excessively difficult (it would have required subclassing a
wrapper and a dumper).
---

diff --git a/psycopg/psycopg/types/json.py b/psycopg/psycopg/types/json.py
index 206ca12e6..2efa147a2 100644
--- a/psycopg/psycopg/types/json.py
+++ b/psycopg/psycopg/types/json.py
@@ -52,10 +52,11 @@ def set_json_loads(loads: JsonLoadsFunction) -> None:
 
 
 class _JsonWrapper:
-    __slots__ = ("obj",)
+    __slots__ = ("obj", "_dumps")
 
-    def __init__(self, obj: Any):
+    def __init__(self, obj: Any, dumps: Optional[JsonDumpsFunction] = None):
         self.obj = obj
+        self._dumps = dumps or _dumps
 
     def __repr__(self) -> str:
         sobj = repr(self.obj)
@@ -63,6 +64,9 @@ class _JsonWrapper:
             sobj = f"{sobj[:35]} ... ({len(sobj)} chars)"
         return f"{self.__class__.__name__}({sobj})"
 
+    def dumps(self) -> str:
+        return self._dumps(self.obj)
+
 
 class Json(_JsonWrapper):
     __slots__ = ()
@@ -76,21 +80,8 @@ class _JsonDumper(Dumper):
 
     format = Format.TEXT
 
-    def __init__(self, cls: type, context: Optional[AdaptContext] = None):
-        super().__init__(cls, context)
-        self._dumps = self.get_dumps()
-
-    def get_dumps(self) -> JsonDumpsFunction:
-        r"""
-        Return a `json.dumps()`\-compatible function to serialize the object.
-
-        Subclasses can override this function to specify custom JSON
-        serialization per context.
-        """
-        return _dumps
-
     def dump(self, obj: _JsonWrapper) -> bytes:
-        return self._dumps(obj.obj).encode("utf-8")
+        return obj.dumps().encode("utf-8")
 
 
 class JsonDumper(_JsonDumper):
@@ -115,7 +106,7 @@ class JsonbBinaryDumper(JsonbDumper):
     format = Format.BINARY
 
     def dump(self, obj: _JsonWrapper) -> bytes:
-        return b"\x01" + self._dumps(obj.obj).encode("utf-8")
+        return b"\x01" + obj.dumps().encode("utf-8")
 
 
 class _JsonLoader(Loader):
diff --git a/tests/types/test_json.py b/tests/types/test_json.py
index c72bd6327..95e1983f1 100644
--- a/tests/types/test_json.py
+++ b/tests/types/test_json.py
@@ -80,23 +80,28 @@ def test_json_dump_customise(conn, wrapper, fmt_in):
         set_json_dumps(json.dumps)
 
 
+@pytest.mark.parametrize("fmt_in", [Format.AUTO, Format.TEXT, Format.BINARY])
+@pytest.mark.parametrize("wrapper", ["Json", "Jsonb"])
+def test_json_dump_customise_wrapper(conn, wrapper, fmt_in):
+    wrapper = getattr(psycopg.types.json, wrapper)
+    obj = {"foo": "bar"}
+    cur = conn.cursor()
+    cur.execute(f"select %{fmt_in}->>'baz' = 'qux'", (wrapper(obj, my_dumps),))
+    assert cur.fetchone()[0] is True
+
+
 @pytest.mark.parametrize("fmt_in", [Format.AUTO, Format.TEXT, Format.BINARY])
 @pytest.mark.parametrize("wrapper", ["Json", "Jsonb"])
 def test_json_dump_subclass(conn, wrapper, fmt_in):
-    JDumper = getattr(
-        psycopg.types.json,
-        f"{wrapper}{'Binary' if fmt_in != Format.TEXT else ''}Dumper",
-    )
     wrapper = getattr(psycopg.types.json, wrapper)
 
-    class MyJsonDumper(JDumper):
-        def get_dumps(self):
-            return my_dumps
+    class MyWrapper(wrapper):
+        def dumps(self):
+            return my_dumps(self.obj)
 
     obj = {"foo": "bar"}
     cur = conn.cursor()
-    MyJsonDumper.register(wrapper, context=cur)
-    cur.execute(f"select %{fmt_in}->>'baz' = 'qux'", (wrapper(obj),))
+    cur.execute(f"select %{fmt_in}->>'baz' = 'qux'", (MyWrapper(obj),))
     assert cur.fetchone()[0] is True