API documentation

pyexiv2

The top-level module pyexiv2.

Attributes

Description

Top-level module. All other modules are imported from pyexiv2.

Documentation

Attributes

version_info

A tuple containing the three components of the version number: major, minor, micro.

__version__

The version of the module as a string (major.minor.micro).

exiv2_version_info

A tuple containing the three components of the version number of libexiv2: major, minor, micro.

__exiv2_version__

The version of libexiv2 as a string (major.minor.micro).

pyexiv2.metadata

class pyexiv2.metadata.ImageMetadata

Instance Attributes

Instance Methods

Description

The pyexiv2.metadata.ImageMetadata is a container for all the metadata embedded in an image.

It provides convenient methods for the manipulation of EXIF, IPTC and XMP metadata embedded in image files such as JPEG and TIFF files, using Python types. It also provides access to the previews embedded in an image.

Documentation

Instanciation

class pyexiv2.metadata.ImageMetadata(filename)

Inherits: MutableMapping

Argument:

  • filename str(path of an image file)

See read()

Attributes

comment

The image comment.

dimensions

A tuple containing the width and height of the image, expressed in pixels.

exif_keys

List of the keys of the available EXIF tags.

iptc_charset

An optional character set the IPTC data is encoded in.

iptc_keys

List of the keys of the available IPTC tags.

mime_type

The mime type of the image, as a string.

previews

List of the previews available in the image, sorted by increasing size.

xmp_keys

List of the keys of the available XMP tags.

Methods

copy(other, exif=True, iptc=True, xmp=True, comment=True)

Copy the metadata to another image. The metadata in the destination is overridden. In particular, if the destination contains e.g. EXIF data and the source doesn’t, it will be erased in the destination, unless explicitly omitted.

Arguments:

  • other An instance of :class:pyexiv2.metadata.ImageMetadata, the destination metadata to copy to (it must have been read() beforehand)
  • exif (boolean) – Whether to copy the EXIF metadata
  • iptc (boolean) – Whether to copy the IPTC metadata
  • xmp (boolean) – Whether to copy the XMP metadata
  • comment (boolean) – Whether to copy the image comment
__delitem__(key)

Delete a metadata tag for a given key.

Argument:

  • key Metadata key in the dotted form familyName.groupName.tagName where familyName may be one of exif, iptc or xmp.

Raises KeyError if the tag with the given key doesn’t exist

__getitem__(key)

Get a metadata tag for a given key.

Argument:

  • key Metadata key in the dotted form familyName.groupName.tagName where familyName may be one of exif, iptc or xmp.

Raises KeyError if the tag doesn’t exist

read()

Read the metadata embedded in the associated image. It is necessary to call this method once before attempting to access the metadata (an exception will be raised if trying to access metadata before calling this method).

__setitem__(key, tag_or_value)

Set a metadata tag for a given key. If the tag was previously set, it is overwritten. As a handy shortcut, a value may be passed instead of a fully formed tag. The corresponding tag object will be instantiated.

Arguments:

  • key Metadata key in the dotted form familyName.groupName.tagName where familyName may be one of exif, iptc or xmp.
  • tag_or_value (pyexiv2.exif.ExifTag or pyexiv2.iptc.IptcTag or pyexiv2.xmp.XmpTag or any valid value type) – An instance of the corresponding family of metadata tag, or a value

Raises KeyError if the tag doesn’t exist

write(preserve_timestamps=False)

Write the metadata back to the image.

Argument:

  • preserve_timestamps (boolean) – Whether to preserve the file’s original timestamps (access time and modification time)

pyexiv2.exif

This module provides the classes ExifTag, ExifValueError and ExifThumbnail.

class pyexiv2.exif.ExifTag

Instance Attributes

Description

The ExifTag define an EXIF tag.

Documentation

Instanciation

class pyexiv2.exif.ExifTag(key, value=None, _tag=None)

An EXIF tag.

Arguments:

  • key The key of the tag in the dotted form familyName.groupName.tagName where familyName = exif.
  • value The value of the tag.

Here is a correspondance table between the EXIF types and the possible python types the value of a tag may take:

  • Ascii: datetime.datetime(), datetime.date(), str()
  • Byte, SByte: str()
  • Comment: str()
  • Long, SLong: [list of] int
  • Short, SShort: [list of] int
  • Rational, SRational: [list of] fractions.Fraction
  • Undefined: str()

Attributes

description

The description of the tag.

human_value

A (read-only) human-readable representation of the value of the tag.

key

The key of the tag in the dotted form familyName.groupName.tagName where familyName = exif.

label

The title (label) of the tag.

name

The name of the tag (this is also the third part of the key).

raw_value

The raw value of the tag as a string.

section_description

The description of the tag’s section.

section_name

The name of the tag’s section.

type

The EXIF type of the tag (one of Ascii, Byte, SByte, Comment, Short, SShort, Long, SLong, Rational, SRational, Undefined).

value

The value of the tag as a python object.

class pyexiv2.exif.ExifValueError(value, type)

Exception raised when failing to parse the value of an EXIF tag.

Arguments:

  • value The value that fails to be parsed
  • type The EXIF type of the tag
class pyexiv2.exif.ExifThumbnail

Instance Attributes

Instance Method

Description

A thumbnail image optionally embedded in the IFD1 segment of the EXIF data.

The image is either a TIFF or a JPEG image.

Documentation

Instanciation

class pyexiv2.exif.ExifThumbnail(_metadata)

Argument:

  • _metadata The ImageMetadata instance

Attributes

extension

The file extension of the preview image with a leading dot (e.g. .jpg).

mime_type

The mime type of the preview image (e.g. image/jpeg).

Methods

erase()

Delete the thumbnail from the EXIF data. Removes all Exif.Thumbnail.*, i.e. Exif IFD1 tags.

set_from_file(path)

Set the EXIF thumbnail to the JPEG image path. This sets only the Compression, JPEGInterchangeFormat and JPEGInterchangeFormatLength tags, which is not all the thumbnail EXIF information mandatory according to the EXIF standard (but it is enough to work with the thumbnail).

Argument:
  • path str(Path to a JPEG file).
write_to_file(path)

Write the thumbnail image to a file on disk. The file extension will be automatically appended to the path.

Argument:

  • path str(Path to write the thumbnail to) - without an extension.

pyexiv2.iptc

This module provides the classes IptcTag and IptcValueError.

class pyexiv2.iptc.IptcTag

Instance Attributes

Description

The IptcTag define an IPTC tag.

Documentation

Instanciation

class pyexiv2.iptc.IptcTag(key, value=None, _tag=None)

An IPTC tag.

Arguments:

  • key The key of the tag in the dotted form familyName.groupName.tagName where familyName = iptc.
  • value The value of the tag.

This tag can have several values (tags that have the repeatable property).

Here is a correspondance table between the IPTC types and the possible python types the value of a tag may take:

  • Short: int
  • String: string
  • Date: datetime.date
  • Time: datetime.time
  • Undefined: string

Attributes

description

The description of the tag.

key

The key of the tag in the dotted form familyName.groupName.tagName where familyName = iptc.

name

The name of the tag (this is also the third part of the key).

photoshop_name

The Photoshop name of the tag

raw_value

The raw values of the tag as a list of strings.

record_description

The description of the tag’s record.

record_name

The name of the tag’s record.

repeatable

Whether the tag is repeatable (accepts several values).

title

The title (label) of the tag.

type

The IPTC type of the tag (one of Short, String, Date, Time, Undefined).

value

The values of the tag as a list of python objects.

class pyexiv2.iptc.IptcValueError(ValueError)

Exception raised when failing to parse the value of an IPTC tag.

Attributes

value

The value that fails to be parsed

type

The IPTC type of the tag

pyexiv2.xmp

This module provides the classes XmpTag and XmpValueError and the following three functions to handle the XMP name spaces.

pyexiv2.xmp.register_namespace(name, prefix)

Register a custom XMP namespace.

Overriding the prefix of a known or previously registered namespace is not allowed.

Arguments:

  • name str() The name of the custom namespace (ending with a /), typically a URL (e.g. http://purl.org/dc/elements/1.1/)
  • prefix str() The prefix for the custom namespace (keys in this namespace will be in the form Xmp.{prefix}.{something})

Raises:

  • ValueError – if the name doesn’t end with a /
  • KeyError – if a namespace already exist with this prefix
pyexiv2.xmp.unregister_namespace(name)

Unregister a custom XMP namespace.

A custom namespace is identified by its name, not by its prefix.

Attempting to unregister an unknown namespace raises an error, as does attempting to unregister a builtin namespace.

Arguments:

Raises:

  • ValueError – if the name doesn’t end with a /
  • KeyError – if the namespace is unknown or a builtin namespace
pyexiv2.xmp.unregister_namespaces()

Unregister all custom XMP namespaces.

Builtin namespaces are not unregistered.

This function always succeeds.

class pyexiv2.xmp.XmpTag

Instance Attributes

Description

The XmpTag define an XMP tag.

Documentation

Instanciation

class pyexiv2.xmp.XmpTag(key, value=None, _tag=None)

An XMP tag.

Arguments:

  • key The key of the tag in the dotted form familyName.groupName.tagName where familyName = xmp.
  • value The value of the tag.

Here is a correspondance table between the XMP types and the possible python types the value of a tag may take:

  • alt, bag, seq: list of the contained simple type
  • lang alt: dict of (language-code: value)
  • Boolean: boolean
  • Colorant: [not implemented yet]
  • Date: datetime.date, datetime.datetime
  • Dimensions: [not implemented yet]
  • Font: [not implemented yet]
  • GPSCoordinate: pyexiv2.utils.GPSCoordinate
  • Integer: int
  • Locale: [not implemented yet]
  • MIMEType: 2-tuple of strings
  • Rational: fractions.Fraction
  • Real: [not implemented yet]
  • AgentName, ProperName, Text: unicode string
  • Thumbnail: [not implemented yet]
  • URI, URL: string
  • XPath: [not implemented yet]

Attributes

description

The description of the tag.

key

The key of the tag in the dotted form familyName.groupName.tagName where familyName = xmp.

name

The name of the tag (this is also the third part of the key).

raw_value

The raw value of the tag as a [list of] string(s).

title

The title (label) of the tag.

type

The XMP type of the tag.

value

The value of the tag as a [list of] python object(s).

class pyexiv2.xmp.XmpValueError(ValueError)

Exception raised when failing to parse the value of an XMP tag.

Attributes

value

The value that fails to be parsed

type

The XMP type of the tag

pyexiv2.preview

class pyexiv2.preview.Preview

Instance Attributes

Instance Method

Description

The Preview define a preview image (properties and data buffer) embedded in image metadata.

Documentation

Instanciation

class pyexiv2.preview.Preview(preview)

A preview image embedded in image metadata.

Attributes

dimensions

A tuple containing the width and height of the preview image in pixels.

extension

The file extension of the preview image with a leading dot (e.g. .jpg).

mime_type

The mime type of the preview image (e.g. image/jpeg).

size

The size of the preview image in bytes.

Method

write_to_file(path)

Write the preview image to a file on disk. The file extension will be automatically appended to the path.

Argument:

  • path str(path) The file path to write the preview to (without an extension)