Functions¶

Warning

Any value can be set as an exif value without it matching the actual value. For example, the XResolution value of 0 can be written while the actual XResolution is 300. This can cause conflicts.

Warning

To edit exif tags and values appropriately, read official document from P167-. http://www.cipa.jp/std/documents/e/DC-008-2012_E.pdf

Note

This document is written for using Piexif on Python 3.x.

load¶

piexif.load(filename, key_is_name=False)¶

Returns exif data as a dictionary with the following keys: “0th”, “Exif”, “GPS”, “Interop”, “1st”, and “thumbnail”. All values are dictionaries except for “thumbnail” which has the value of either a JPEG as bytes or None if no thumbnail is stored in the exif data.

Parameters:	filename (str) – JPEG, WebP, or TIFF
Returns:	Exif data({“0th”:dict, “Exif”:dict, “GPS”:dict, “Interop”:dict, “1st”:dict, “thumbnail”:bytes})
Return type:	dict

exif_dict = piexif.load("foo.jpg")
thumbnail = exif_dict.pop("thumbnail")
if thumbnail is not None:
    with open("thumbnail.jpg", "wb+") as f:
        f.write(thumbnail)
for ifd_name in exif_dict:
    print("\n{0} IFD:".format(ifd_name))
    for key in exif_dict[ifd_name]:
        try:
            print(key, exif_dict[ifd_name][key][:10])
        except:
            print(key, exif_dict[ifd_name][key])

piexif.load(data)

Returns exif data as a dictionary with the following keys unless its value does not exist in the file: “0th”, “Exif”, “GPS”, “Interop”, “1st”, and “thumbnail”. All values are dictionaries except for “thumbnail” which has the value of either a JPEG as bytes or None if no thumbnail is stored in the exif data.

Parameters:	data (bytes) – JPEG, WebP, TIFF, or Exif
Returns:	Exif data({“0th”:dict, “Exif”:dict, “GPS”:dict, “Interop”:dict, “1st”:dict, “thumbnail”:bytes})
Return type:	dict

dump¶

piexif.dump(exif_dict)¶

Returns exif data as bytes.

Parameters:	exif_dict (dict) – Exif data({“0th”:0thIFD - dict, “Exif”:ExifIFD - dict, “GPS”:GPSIFD - dict, “Interop”:InteroperabilityIFD - dict, “1st”:1stIFD - dict, “thumbnail”:JPEG data - bytes})
Returns:	Exif
Return type:	bytes

import io
from PIL import Image
import piexif

o = io.BytesIO()
thumb_im = Image.open("foo.jpg")
thumb_im.thumbnail((50, 50), Image.ANTIALIAS)
thumb_im.save(o, "jpeg")
thumbnail = o.getvalue()

zeroth_ifd = {piexif.ImageIFD.Make: u"Canon",
              piexif.ImageIFD.XResolution: (96, 1),
              piexif.ImageIFD.YResolution: (96, 1),
              piexif.ImageIFD.Software: u"piexif"
              }
exif_ifd = {piexif.ExifIFD.DateTimeOriginal: u"2099:09:29 10:10:10",
            piexif.ExifIFD.LensMake: u"LensMake",
            piexif.ExifIFD.Sharpness: 65535,
            piexif.ExifIFD.LensSpecification: ((1, 1), (1, 1), (1, 1), (1, 1)),
            }
gps_ifd = {piexif.GPSIFD.GPSVersionID: (2, 0, 0, 0),
           piexif.GPSIFD.GPSAltitudeRef: 1,
           piexif.GPSIFD.GPSDateStamp: u"1999:99:99 99:99:99",
           }
first_ifd = {piexif.ImageIFD.Make: u"Canon",
             piexif.ImageIFD.XResolution: (40, 1),
             piexif.ImageIFD.YResolution: (40, 1),
             piexif.ImageIFD.Software: u"piexif"
             }

exif_dict = {"0th":zeroth_ifd, "Exif":exif_ifd, "GPS":gps_ifd, "1st":first_ifd, "thumbnail":thumbnail}
exif_bytes = piexif.dump(exif_dict)
im = Image.open("foo.jpg")
im.thumbnail((100, 100), Image.ANTIALIAS)
im.save("out.jpg", exif=exif_bytes)

The 0thIFD and 1stIFD dictionaries should be constructed using the properties of piexif.ImageIFD. Use the properties of piexif.ExifIFD for the ExifIFD dictionary, piexif.GPSIFD for the GPSIFD dictionary, and piexif.InteropIFD for the InteroperabilityIFD dictionary.

Note

ExifTag(34665), GPSTag(34853), and InteroperabilityTag(40965) in 0thIFD are automatically set to the appropriate values.

Note

JPEGInterchangeFormat(513), and JPEGInterchangeFormatLength(514) in 1stIFD are automatically set to the appropriate values.

Note

If the value of key ‘thumbnail’ is a dictionary, then the value for key ‘1st’ must also be a dictionary and vice versa. This is because 1stIFD stores the thumbnail’s information.

insert¶

piexif.insert(exif_bytes, filename)¶

Inserts exif into JPEG or WebP.

Parameters:	exif_bytes (bytes) – Exif as bytes filename (str) – JPEG or WebP

exif_bytes = piexif.dump(exif_dict)
piexif.insert(exif_bytes, "foo.jpg")

piexif.insert(exif_bytes, data, output)

Inserts exif into JPEG or WebP.

Parameters:	exif_bytes (bytes) – Exif as bytes data (bytes) – JPEG or WebP data output (io.BytesIO) – output data

remove¶

piexif.remove(filename)¶

Removes exif data from JPEG or WebP.

Parameters:	filename (str) – JPEG or WebP

piexif.remove("foo.jpg")

piexif.remove(data, output)

Removes exif data from JPEG or WebP.

Parameters:	data (bytes) – JPEG or WebP data output (io.BytesIO) – output data

transplant¶

piexif.transplant(filename1, filename2)¶

Copies exif data from filename1 to filename2.

Parameters:	filename1 (str) – JPEG filename2 (str) – JPEG

piexif.transplant("exif_src.jpg", "foo.jpg")

piexif.transplant(exif_src, image_src, output)

Transplant exif from exif_src to image_src.

Parameters:	exif_src (bytes) – JPEG data image_src (bytes) – JPEG data output (io.BytesIO) – output data