MAINT: Add deprecate_with_replacement to StreamObject.initializeFromD… (

py-pdf#2728) * MAINT: Add deprecate_with_replacement to StreamObject.initializeFromDictionary
pubpub-zz · Jun 27, 2024 · f893a6b · f893a6b
1 parent 15e3a5d
commit f893a6b
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/pypdf/generic/_data_structures.py b/pypdf/generic/_data_structures.py
@@ -903,10 +903,13 @@ def write_to_stream(
         stream.write(b"\nendstream")
 
     @staticmethod
-    def initializeFromDictionary(  # TODO: mention when to deprecate
+    def initializeFromDictionary(
         data: Dict[str, Any]
-    ) -> Union["EncodedStreamObject", "DecodedStreamObject"]:  # deprecated
-        return StreamObject.initialize_from_dictionary(data)
+    ) -> Union["EncodedStreamObject", "DecodedStreamObject"]:
+        deprecate_with_replacement(
+            "initializeFromDictionary", "initialize_from_dictionary", "5.0.0"
+        )  # pragma: no cover
+        return StreamObject.initialize_from_dictionary(data)  # pragma: no cover
 
     @staticmethod
     def initialize_from_dictionary(