Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved flexibility of XMP parsing #7274

Merged
merged 4 commits into from Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added Tests/images/xmp_no_prefix.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Tests/images/xmp_padded.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions Tests/test_file_jpeg.py
Expand Up @@ -898,6 +898,22 @@ def test_getxmp(self):
with Image.open("Tests/images/hopper.jpg") as im:
assert im.getxmp() == {}

def test_getxmp_no_prefix(self):
with Image.open("Tests/images/xmp_no_prefix.jpg") as im:
if ElementTree is None:
with pytest.warns(UserWarning):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there a UserWarning?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ElementTree is None if defusedxml is unavailable, triggering this warning.

Pillow/src/PIL/Image.py

Lines 1410 to 1411 in 1e7dcd3

if ElementTree is None:
warnings.warn("XMP data cannot be read without defusedxml dependency")

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, let's also add a match= to pytest.warns to make it a bit clearer (this and the other one).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, done, and I've added it to other locations as well.

assert im.getxmp() == {}
else:
assert im.getxmp() == {"xmpmeta": {"key": "value"}}

def test_getxmp_padded(self):
with Image.open("Tests/images/xmp_padded.jpg") as im:
if ElementTree is None:
with pytest.warns(UserWarning):
assert im.getxmp() == {}
else:
assert im.getxmp() == {"xmpmeta": None}

@pytest.mark.timeout(timeout=1)
def test_eof(self):
# Even though this decoder never says that it is finished
Expand Down
2 changes: 1 addition & 1 deletion src/PIL/Image.py
Expand Up @@ -1380,7 +1380,7 @@ def getextrema(self):

def _getxmp(self, xmp_tags):
def get_name(tag):
return tag.split("}")[1]
return re.sub("^{[^}]+}", "", tag)

def get_value(element):
value = {get_name(k): v for k, v in element.attrib.items()}
Expand Down
2 changes: 1 addition & 1 deletion src/PIL/JpegImagePlugin.py
Expand Up @@ -496,7 +496,7 @@ def getxmp(self):

for segment, content in self.applist:
if segment == "APP1":
marker, xmp_tags = content.rsplit(b"\x00", 1)
marker, xmp_tags = content.split(b"\x00")[:2]
if marker == b"http://ns.adobe.com/xap/1.0/":
return self._getxmp(xmp_tags)
return {}
Expand Down