Skip to main content

Library to extract Exif information from digital camera image files.

Project description

BSD-3-clause PyPi BSD-3-clause Checked with mypy Tests

Easy to use Python module to extract Exif metadata from digital image files.

Pure Python, lightweight, no dependencies.

Supported formats: TIFF, JPEG, PNG, Webp, HEIC

Compatibility

EXIF.py is tested and officially supported on Python 3.7 to 3.13

Installation

Stable Version

The recommended process is to install the PyPI package, as it allows easily staying up to date:

$ pip install exifread

See the pip documentation for more info.

EXIF.py is mature software and strives for stability.

Development Version

After cloning the repo, use the provided Makefile:

make venv install-all

Which will create a virtual environment and install development dependencies.

Usage

Command line

Some examples:

EXIF.py image1.jpg
EXIF.py -dc image1.jpg image2.tiff
find ~/Pictures -name "*.jpg" -o -name "*.tiff" | xargs EXIF.py

Show command line options:

EXIF.py -h

Python Script

import exifread

# Open image file for reading (must be in binary mode)
with open(file_path, "rb") as file_handle:

    # Return Exif tags
    tags = exifread.process_file(file_handle)

Note: To use this library in your project as a Git submodule, you should:

from <submodule_folder> import exifread

Returned tags will be a dictionary mapping names of Exif tags to their values in the file named by file_path. You can process the tags as you wish. In particular, you can iterate through all the tags with:

for tag, value in tags.items():
    if tag not in ('JPEGThumbnail', 'TIFFThumbnail', 'Filename', 'EXIF MakerNote'):
        print(f"Key: {tag}, value {value}")

An if statement is used to avoid printing out a few of the tags that tend to be long or boring.

The tags dictionary will include keys for all of the usual Exif tags, and will also include keys for Makernotes used by some cameras, for which we have a good specification.

Note that the dictionary keys are the IFD name followed by the tag name. For example:

'EXIF DateTimeOriginal', 'Image Orientation', 'MakerNote FocusMode'

Tag Descriptions

Tags are divided into these main categories:

  • Image: information related to the main image (IFD0 of the Exif data).

  • Thumbnail: information related to the thumbnail image, if present (IFD1 of the Exif data).

  • EXIF: Exif information (sub-IFD).

  • GPS: GPS information (sub-IFD).

  • Interoperability: Interoperability information (sub-IFD).

  • MakerNote: Manufacturer specific information. There are no official published references for these tags.

Processing Options

These options can be used both in command line mode and within a script.

Faster Processing

Don’t process makernote tags, don’t extract the thumbnail image (if any).

Pass the -q or --quick command line arguments, or as:

tags = exifread.process_file(file_handle, details=False)

To process makernotes only, without extracting the thumbnail image (if any):

tags = exifread.process_file(file_handle, details=True, extract_thumbnail=False)

To extract the thumbnail image (if any), without processing makernotes:

tags = exifread.process_file(file_handle, details=False, extract_thumbnail=True)

Stop at a Given Tag

To stop processing the file after a specified tag is retrieved.

Pass the -t TAG or --stop-tag TAG argument, or as:

tags = exifread.process_file(file_handle, stop_tag='TAG')

where TAG is a valid tag name, ex 'DateTimeOriginal'.

The two above options are useful to speed up processing of large numbers of files.

Strict Processing

Return an error on invalid tags instead of silently ignoring.

Pass the -s or --strict argument, or as:

tags = exifread.process_file(file_handle, strict=True)

Built-in Types

For easier serialization and programmatic use, this option returns a dictionary with values in built-in Python types (int, float, str, bytes, list, None) instead of IfdTag objects.

Pass the -b or --builtin argument, or as:

tags = exifread.process_file(file_handle, builtin_types=True)

For direct JSON serialization, combine this option with details=False to avoid bytes in the output:

json.dumps(exifread.process_file(file_handle, details=False, builtin_types=True))

Usage Example

This example shows how to use the library to correct the orientation of an image (using Pillow for the transformation) before e.g. displaying it.

import exifread
from PIL import Image
import logging

def _read_img_and_correct_exif_orientation(path):
    im = Image.open(path)
    tags = {}
    with open(path, "rb") as file_handle:
        tags = exifread.process_file(file_handle, details=False)

    if "Image Orientation" in tags:
        orientation = tags["Image Orientation"]
        logging.basicConfig(level=logging.DEBUG)
        logging.debug("Orientation: %s (%s)", orientation, orientation.values)
        val = orientation.values
        if 2 in val:
            val += [4, 3]
        if 5 in val:
            val += [4, 6]
        if 7 in val:
            val += [4, 8]
        if 3 in val:
            logging.debug("Rotating by 180 degrees.")
            im = im.transpose(Image.ROTATE_180)
        if 4 in val:
            logging.debug("Mirroring horizontally.")
            im = im.transpose(Image.FLIP_TOP_BOTTOM)
        if 6 in val:
            logging.debug("Rotating by 270 degrees.")
            im = im.transpose(Image.ROTATE_270)
        if 8 in val:
            logging.debug("Rotating by 90 degrees.")
            im = im.transpose(Image.ROTATE_90)
    return im

License

Copyright © 2002-2007 Gene Cash

Copyright © 2007-2025 Ianaré Sévi and contributors

A huge thanks to all the contributors over the years!

Originally written by Gene Cash & Thierry Bousch.

Available as open source under the terms of the BSD-3-Clause license.

See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exifread-3.2.0.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

exifread-3.2.0-py3-none-any.whl (53.5 kB view details)

Uploaded Python 3

File details

Details for the file exifread-3.2.0.tar.gz.

File metadata

  • Download URL: exifread-3.2.0.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for exifread-3.2.0.tar.gz
Algorithm Hash digest
SHA256 9bc3e34b2a25754a445aadd94c9af911928ef95de8c7a91f85219a8b4202c23d
MD5 f11039474397193d1b9af74cb339447e
BLAKE2b-256 b7f12184e1939b2743fec32a744475812ad6c86188d7791107a68ed5fbe91446

See more details on using hashes here.

File details

Details for the file exifread-3.2.0-py3-none-any.whl.

File metadata

  • Download URL: exifread-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 53.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for exifread-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61bf924693f89626cc36a35fc0eeb4513e6638b2f319e9a1ed83b3227492e81c
MD5 dc19095d421683439a5e1308ddb091a1
BLAKE2b-256 9baa4739d92248c6f58c737d984bef8f5c032ba0911420ebcf53378686e50552

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page