Detailed API

This part of the documentation is auto-generated from the Doxygen format documentation in the libexiv2 “header” files. There are many ways in which the conversion process can fail, so you may need to consult the Exiv2 C++ API documentation as well.

The documentation is split into several pages, one for each module in the Python interface. This makes it easier to use than having all the classes and functions in one document. Do not use the module names in your Python scripts: always use exiv2.name rather than exiv2.module.name or exiv2._module.name.

See Index for a full index to all classes, attributes, functions and methods.

Package Attributes

exiv2.__version__

python-exiv2 version as a string

exiv2.__version_tuple__

python-exiv2 version as a tuple of ints

Package Modules

exiv2.image

Image & ImageFactory classes.

exiv2.exif

Exif metadatum, container and iterators.

exiv2.iptc

IPTC metadatum, container and iterators.

exiv2.xmp

XMP metadatum, container and iterators.

exiv2.preview

Access to preview images.

exiv2.value

Exiv2 metadata value classes.

exiv2.types

Exiv2 metadata data types and utility classes.

exiv2.tags

Exif key class and data attributes.

exiv2.datasets

IPTC key class and data attributes.

exiv2.properties

XMP key class and data attributes.

exiv2.version_module

Exiv2 library version information.

exiv2.error

Exiv2 error codes and message logging.

exiv2.easyaccess

Simplified reading of Exif metadata.

exiv2.basicio

Class interface to access files, memory and remote data.

exiv2.metadatum

Exiv2 metadatum and key base classes.

exiv2.extras

Pure Python extra classes and functions.