Improved consistency of XMP handling

Author: radarhere

Tests/test_file_jpeg.py

@@ -943,6 +943,7 @@ def test_getxmp(self) -> None:
                 ):
                     assert im.getxmp() == {}
             else:
+                assert "xmp" in im.info
                 xmp = im.getxmp()
 
                 description = xmp["xmpmeta"]["RDF"]["Description"]

Tests/test_file_png.py

@@ -683,6 +683,7 @@ def test_getxmp(self) -> None:
                 ):
                     assert im.getxmp() == {}
             else:
+                assert "xmp" in im.info
                 xmp = im.getxmp()
 
                 description = xmp["xmpmeta"]["RDF"]["Description"]

Tests/test_file_tiff.py

@@ -759,6 +759,7 @@ def test_getxmp(self) -> None:
                 ):
                     assert im.getxmp() == {}
             else:
+                assert "xmp" in im.info
                 xmp = im.getxmp()
 
                 description = xmp["xmpmeta"]["RDF"]["Description"]

Tests/test_file_webp_metadata.py

@@ -129,6 +129,7 @@ def test_getxmp() -> None:
             ):
                 assert im.getxmp() == {}
         else:
+            assert "xmp" in im.info
             assert (
                 im.getxmp()["xmpmeta"]["xmptk"]
                 == "Adobe XMP Core 5.3-c011 66.145661, 2012/02/06-14:56:27        "

Tests/test_image.py

@@ -897,6 +897,10 @@ def test_exif_hide_offsets(self) -> None:
                     assert tag not in exif.get_ifd(0x8769)
                 assert exif.get_ifd(0xA005)
 
+    def test_empty_xmp(self) -> None:
+        with Image.open("Tests/images/hopper.gif") as im:
+            assert im.getxmp() == {}
+
     @pytest.mark.parametrize("size", ((1, 0), (0, 1), (0, 0)))
     def test_zero_tobytes(self, size: tuple[int, int]) -> None:
         im = Image.new("RGB", size)

docs/reference/Image.rst

@@ -197,6 +197,7 @@ This helps to get the bounding box coordinates of the input image::
 .. automethod:: PIL.Image.Image.getpalette
 .. automethod:: PIL.Image.Image.getpixel
 .. automethod:: PIL.Image.Image.getprojection
+.. automethod:: PIL.Image.Image.getxmp
 .. automethod:: PIL.Image.Image.histogram
 .. automethod:: PIL.Image.Image.paste
 .. automethod:: PIL.Image.Image.point

src/PIL/Image.py

@@ -1439,7 +1439,14 @@ def getextrema(self) -> tuple[float, float] | tuple[tuple[int, int], ...]:
             return tuple(self.im.getband(i).getextrema() for i in range(self.im.bands))
         return self.im.getextrema()
 
-    def _getxmp(self, xmp_tags):
+    def getxmp(self):
+        """
+        Returns a dictionary containing the XMP tags.
+        Requires defusedxml to be installed.
+
+        :returns: XMP tags in a dictionary.
+        """
+
         def get_name(tag):
             return re.sub("^{[^}]+}", "", tag)
 
@@ -1466,9 +1473,10 @@ def get_value(element):
         if ElementTree is None:
             warnings.warn("XMP data cannot be read without defusedxml dependency")
             return {}
-        else:
-            root = ElementTree.fromstring(xmp_tags)
-            return {get_name(root.tag): get_value(root)}
+        if "xmp" not in self.info:
+            return {}
+        root = ElementTree.fromstring(self.info["xmp"])
+        return {get_name(root.tag): get_value(root)}
 
     def getexif(self) -> Exif:
         """

src/PIL/ImageOps.py

@@ -714,9 +714,8 @@ def exif_transpose(image: Image.Image, *, in_place: bool = False) -> Image.Image
                     r'tiff:Orientation="([0-9])"',
                     r"<tiff:Orientation>([0-9])</tiff:Orientation>",
                 ):
-                    exif_image.info["XML:com.adobe.xmp"] = re.sub(
-                        pattern, "", exif_image.info["XML:com.adobe.xmp"]
-                    )
+                    for k in ("xmp", "XML:com.adobe.xmp"):
+                        exif_image.info[k] = re.sub(pattern, "", exif_image.info[k])
         if not in_place:
             return transposed_image
     elif not in_place:

src/PIL/JpegImagePlugin.py

@@ -94,6 +94,8 @@ def APP(self, marker):
         else:
             self.info["exif"] = s
             self._exif_offset = self.fp.tell() - n + 6
+    elif marker == 0xFFE1 and s[:29] == b"http://ns.adobe.com/xap/1.0/\x00":
+        self.info["xmp"] = s.split(b"\x00")[1]
     elif marker == 0xFFE2 and s[:5] == b"FPXR\0":
         # extract FlashPix information (incomplete)
         self.info["flashpix"] = s  # FIXME: value will change
@@ -499,21 +501,6 @@ def _getexif(self):
     def _getmp(self):
         return _getmp(self)
 
-    def getxmp(self):
-        """
-        Returns a dictionary containing the XMP tags.
-        Requires defusedxml to be installed.
-
-        :returns: XMP tags in a dictionary.
-        """
-
-        for segment, content in self.applist:
-            if segment == "APP1":
-                marker, xmp_tags = content.split(b"\x00")[:2]
-                if marker == b"http://ns.adobe.com/xap/1.0/":
-                    return self._getxmp(xmp_tags)
-        return {}
-
 
 def _getexif(self):
     if "exif" not in self.info:

src/PIL/PngImagePlugin.py

@@ -615,6 +615,8 @@ def chunk_iTXt(self, pos: int, length: int) -> bytes:
             return s
 
         self.im_info[k] = self.im_text[k] = iTXt(v, lang, tk)
+        if k == "XML:com.adobe.xmp":
+            self.im_info["xmp"] = self.im_info[k]
         self.check_text_memory(len(v))
 
         return s
@@ -1032,19 +1034,6 @@ def getexif(self):
 
         return super().getexif()
 
-    def getxmp(self):
-        """
-        Returns a dictionary containing the XMP tags.
-        Requires defusedxml to be installed.
-
-        :returns: XMP tags in a dictionary.
-        """
-        return (
-            self._getxmp(self.info["XML:com.adobe.xmp"])
-            if "XML:com.adobe.xmp" in self.info
-            else {}
-        )
-
 
 # --------------------------------------------------------------------
 # PNG writer