Skip to content

Commit

Permalink
Merge pull request #4455 from radarhere/jpeg_comment
Browse files Browse the repository at this point in the history
Add JPEG comment to info dictionary
  • Loading branch information
hugovk authored Mar 6, 2020
2 parents e9a6149 + e41cfad commit 64c84aa
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Tests/test_file_jpeg.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ def test_app(self):
)
assert len(im.applist) == 2

assert im.info["comment"] == b"File written by Adobe Photoshop\xa8 4.0\x00"

def test_cmyk(self):
# Test CMYK handling. Thanks to Tim and Charlie for test data,
# Michael for getting me to look one more time.
Expand Down
5 changes: 5 additions & 0 deletions docs/handbook/image-file-formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,11 @@ The :py:meth:`~PIL.Image.Image.open` method may set the following
**exif**
Raw EXIF data from the image.

**comment**
A comment about the image.

.. versionadded:: 7.1.0


The :py:meth:`~PIL.Image.Image.save` method supports the following options:

Expand Down
9 changes: 9 additions & 0 deletions docs/releasenotes/7.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ been resolved.
im = Image.open("hopper.jpg")
im.save("out.jpg", quality=0)
API Additions
=============

Reading JPEG comments
^^^^^^^^^^^^^^^^^^^^^

When opening a JPEG image, the comment may now be read into
:py:attr:`~PIL.Image.Image.info`.

Other Changes
=============

Expand Down
1 change: 1 addition & 0 deletions src/PIL/JpegImagePlugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ def COM(self, marker):
n = i16(self.fp.read(2)) - 2
s = ImageFile._safe_read(self.fp, n)

self.info["comment"] = s
self.app["COM"] = s # compatibility
self.applist.append(("COM", s))

Expand Down

0 comments on commit 64c84aa

Please sign in to comment.