document IptcImagePlugin deprecations

python-pillow · Dec 31, 2023 · 504c4aa · 504c4aa
1 parent c615535
commit 504c4aa
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/docs/deprecations.rst b/docs/deprecations.rst
@@ -44,6 +44,17 @@ ImageFile.raise_oserror
 error codes returned by a codec's ``decode()`` method, which ImageFile already does
 automatically.
 
+IptcImageFile helper functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 10.2.0
+
+The functions ``IptcImageFile.dump`` and ``IptcImageFile.i``, and the constant
+``IptcImageFile.PAD`` have been deprecated and will be removed in Pillow
+12.0.0 (2025-10-15). These are undocumented helper functions intended
+for internal use, so there is no replacement. They can each be replaced
+by a single line of code using builtin functions in Python.
+
 Removed features
 ----------------
 

diff --git a/docs/releasenotes/10.2.0.rst b/docs/releasenotes/10.2.0.rst
@@ -20,10 +20,14 @@ ImageFile.raise_oserror
 error codes returned by a codec's ``decode()`` method, which ImageFile already does
 automatically.
 
-TODO
-^^^^
-
-TODO
+IptcImageFile helper functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The functions ``IptcImageFile.dump`` and ``IptcImageFile.i``, and the constant
+``IptcImageFile.PAD`` have been deprecated and will be removed in Pillow
+12.0.0 (2025-10-15). These are undocumented helper functions intended
+for internal use, so there is no replacement. They can each be replaced
+by a single line of code using builtin functions in Python.
 
 API Changes
 ===========

diff --git a/src/PIL/IptcImagePlugin.py b/src/PIL/IptcImagePlugin.py
@@ -44,12 +44,14 @@ def _i8(c: int | bytes) -> int:
 
 
 def i(c, *, _internal=False):
+    """.. deprecated:: 10.2.0"""
     if not _internal:
         deprecate("IptcImagePlugin.i", 12)
     return i32((b"\0\0\0\0" + c)[-4:])
 
 
 def dump(c):
+    """.. deprecated:: 10.2.0"""
     deprecate("IptcImagePlugin.dump", 12)
     for i in c:
         print("%02x" % _i8(i), end=" ")