From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Sun, 18 Sep 2022 23:36:35 +0000 (+0100)
Subject: feat: extend signature of Dumper.dump() to allow returning None
X-Git-Tag: 3.2.0~20^2~8
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5f3ea2a0662571d7012469acae63231b7ccadbd5;p=thirdparty%2Fpsycopg.git

feat: extend signature of Dumper.dump() to allow returning None
---

diff --git a/psycopg/psycopg/abc.py b/psycopg/psycopg/abc.py
index 480fc064c..11e10b161 100644
--- a/psycopg/psycopg/abc.py
+++ b/psycopg/psycopg/abc.py
@@ -62,7 +62,7 @@ class WaitFunc(Protocol):
 
 # Adaptation types
 
-DumpFunc: TypeAlias = Callable[[Any], Buffer]
+DumpFunc: TypeAlias = Callable[[Any], Optional[Buffer]]
 LoadFunc: TypeAlias = Callable[[Buffer], Any]
 
 
@@ -110,7 +110,7 @@ class Dumper(Protocol):
 
     def __init__(self, cls: type, context: Optional[AdaptContext] = None): ...
 
-    def dump(self, obj: Any) -> Buffer:
+    def dump(self, obj: Any) -> Optional[Buffer]:
         """Convert the object `!obj` to PostgreSQL representation.
 
         :param obj: the object to convert.
diff --git a/psycopg/psycopg/adapt.py b/psycopg/psycopg/adapt.py
index 7d6a191d8..4b33fbb67 100644
--- a/psycopg/psycopg/adapt.py
+++ b/psycopg/psycopg/adapt.py
@@ -46,7 +46,7 @@ class Dumper(abc.Dumper, ABC):
         )
 
     @abstractmethod
-    def dump(self, obj: Any) -> Buffer: ...
+    def dump(self, obj: Any) -> Optional[Buffer]: ...
 
     def quote(self, obj: Any) -> Buffer:
         """