/usr/share/pyshared/pyexiv2/metadata.py is in python-pyexiv2 0.3.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | # -*- coding: utf-8 -*-
# ******************************************************************************
#
# Copyright (C) 2006-2011 Olivier Tilloy <olivier@tilloy.net>
#
# This file is part of the pyexiv2 distribution.
#
# pyexiv2 is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# pyexiv2 is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with pyexiv2; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
#
# Author: Olivier Tilloy <olivier@tilloy.net>
#
# ******************************************************************************
"""
Provide the ImageMetadata class.
"""
import os
import sys
from errno import ENOENT
from collections import MutableMapping
from itertools import chain
import codecs
import libexiv2python
from pyexiv2.exif import ExifTag, ExifThumbnail
from pyexiv2.iptc import IptcTag
from pyexiv2.xmp import XmpTag
from pyexiv2.preview import Preview
class ImageMetadata(MutableMapping):
"""
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.
"""
def __init__(self, filename):
"""
:param filename: path to an image file
:type filename: string
"""
self.filename = filename
if filename is not None and isinstance(filename, unicode):
self.filename = filename.encode(sys.getfilesystemencoding())
self.__image = None
self._keys = {'exif': None, 'iptc': None, 'xmp': None}
self._tags = {'exif': {}, 'iptc': {}, 'xmp': {}}
self._exif_thumbnail = None
def _instantiate_image(self, filename):
# This method is meant to be overridden in unit tests to easily replace
# the internal image reference by a mock.
if not os.path.exists(filename) or not os.path.isfile(filename):
raise IOError(ENOENT, os.strerror(ENOENT), filename)
# Remember the reference timestamps before doing any access to the file
stat = os.stat(filename)
self._atime = stat.st_atime
self._mtime = stat.st_mtime
return libexiv2python._Image(filename)
@classmethod
def from_buffer(cls, buffer):
"""
Instantiate an image container from an image buffer.
:param buffer: a buffer containing image data
:type buffer: string
"""
obj = cls(None)
obj.__image = libexiv2python._Image(buffer, len(buffer))
return obj
@property
def _image(self):
if self.__image is None:
raise IOError('Image metadata has not been read yet')
return self.__image
def read(self):
"""
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).
"""
if self.__image is None:
self.__image = self._instantiate_image(self.filename)
self.__image._readMetadata()
def write(self, preserve_timestamps=False):
"""
Write the metadata back to the image.
:param preserve_timestamps: whether to preserve the file's original
timestamps (access time and modification
time)
:type preserve_timestamps: boolean
"""
self._image._writeMetadata()
if self.filename is None:
return
if preserve_timestamps:
# Revert to the original timestamps
os.utime(self.filename, (self._atime, self._mtime))
else:
# Reset the reference timestamps
stat = os.stat(self.filename)
self._atime = stat.st_atime
self._mtime = stat.st_mtime
@property
def dimensions(self):
"""A tuple containing the width and height of the image, expressed in
pixels."""
return (self._image._getPixelWidth(), self._image._getPixelHeight())
@property
def mime_type(self):
"""The mime type of the image, as a string."""
return self._image._getMimeType()
@property
def exif_keys(self):
"""List of the keys of the available EXIF tags."""
if self._keys['exif'] is None:
self._keys['exif'] = self._image._exifKeys()
return self._keys['exif']
@property
def iptc_keys(self):
"""List of the keys of the available IPTC tags."""
if self._keys['iptc'] is None:
self._keys['iptc'] = self._image._iptcKeys()
return self._keys['iptc']
@property
def xmp_keys(self):
"""List of the keys of the available XMP tags."""
if self._keys['xmp'] is None:
self._keys['xmp'] = self._image._xmpKeys()
return self._keys['xmp']
def _get_exif_tag(self, key):
# Return the EXIF tag for the given key.
# Throw a KeyError if the tag doesn't exist.
try:
return self._tags['exif'][key]
except KeyError:
_tag = self._image._getExifTag(key)
tag = ExifTag._from_existing_tag(_tag)
self._tags['exif'][key] = tag
return tag
def _get_iptc_tag(self, key):
# Return the IPTC tag for the given key.
# Throw a KeyError if the tag doesn't exist.
try:
return self._tags['iptc'][key]
except KeyError:
_tag = self._image._getIptcTag(key)
tag = IptcTag._from_existing_tag(_tag)
self._tags['iptc'][key] = tag
return tag
def _get_xmp_tag(self, key):
# Return the XMP tag for the given key.
# Throw a KeyError if the tag doesn't exist.
try:
return self._tags['xmp'][key]
except KeyError:
_tag = self._image._getXmpTag(key)
tag = XmpTag._from_existing_tag(_tag)
self._tags['xmp'][key] = tag
return tag
def __getitem__(self, key):
"""
Get a metadata tag for a given key.
:param key: metadata key in the dotted form
``familyName.groupName.tagName`` where ``familyName`` may
be one of ``exif``, ``iptc`` or ``xmp``.
:type key: string
:raise KeyError: if the tag doesn't exist
"""
family = key.split('.')[0].lower()
if family in ('exif', 'iptc', 'xmp'):
return getattr(self, '_get_%s_tag' % family)(key)
else:
raise KeyError(key)
def _set_exif_tag(self, key, tag_or_value):
# Set an EXIF tag. If the tag already exists, its value is overwritten.
if isinstance(tag_or_value, ExifTag):
tag = tag_or_value
else:
# As a handy shortcut, accept direct value assignment.
tag = ExifTag(key, tag_or_value)
tag._set_owner(self)
self._tags['exif'][tag.key] = tag
if tag.key not in self.exif_keys:
self._keys['exif'].append(tag.key)
def _set_iptc_tag(self, key, tag_or_values):
# Set an IPTC tag. If the tag already exists, its values are
# overwritten.
if isinstance(tag_or_values, IptcTag):
tag = tag_or_values
else:
# As a handy shortcut, accept direct value assignment.
tag = IptcTag(key, tag_or_values)
tag._set_owner(self)
self._tags['iptc'][tag.key] = tag
if tag.key not in self.iptc_keys:
self._keys['iptc'].append(tag.key)
def _set_xmp_tag(self, key, tag_or_value):
# Set an XMP tag. If the tag already exists, its value is overwritten.
if isinstance(tag_or_value, XmpTag):
tag = tag_or_value
else:
# As a handy shortcut, accept direct value assignment.
tag = XmpTag(key, tag_or_value)
tag._set_owner(self)
self._tags['xmp'][tag.key] = tag
if tag.key not in self.xmp_keys:
self._keys['xmp'].append(tag.key)
def __setitem__(self, 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.
:param key: metadata key in the dotted form
``familyName.groupName.tagName`` where ``familyName`` may
be one of ``exif``, ``iptc`` or ``xmp``.
:type key: string
:param tag_or_value: an instance of the corresponding family of metadata
tag, or a value
:type tag_or_value: :class:`pyexiv2.exif.ExifTag` or
:class:`pyexiv2.iptc.IptcTag` or
:class:`pyexiv2.xmp.XmpTag` or any valid value type
:raise KeyError: if the key is invalid
"""
family = key.split('.')[0].lower()
if family in ('exif', 'iptc', 'xmp'):
return getattr(self, '_set_%s_tag' % family)(key, tag_or_value)
else:
raise KeyError(key)
def _delete_exif_tag(self, key):
# Delete an EXIF tag.
# Throw a KeyError if the tag doesn't exist.
if key not in self.exif_keys:
raise KeyError('Cannot delete an inexistent tag')
self._image._deleteExifTag(key)
try:
del self._tags['exif'][key]
except KeyError:
# The tag was not cached.
pass
if self._keys['exif'] is not None:
self._keys['exif'].remove(key)
def _delete_iptc_tag(self, key):
# Delete an IPTC tag.
# Throw a KeyError if the tag doesn't exist.
if key not in self.iptc_keys:
raise KeyError('Cannot delete an inexistent tag')
self._image._deleteIptcTag(key)
try:
del self._tags['iptc'][key]
except KeyError:
# The tag was not cached.
pass
if self._keys['iptc'] is not None:
self._keys['iptc'].remove(key)
def _delete_xmp_tag(self, key):
# Delete an XMP tag.
# Throw a KeyError if the tag doesn't exist.
if key not in self.xmp_keys:
raise KeyError('Cannot delete an inexistent tag')
self._image._deleteXmpTag(key)
try:
del self._tags['xmp'][key]
except KeyError:
# The tag was not cached.
pass
if self._keys['xmp'] is not None:
self._keys['xmp'].remove(key)
def __delitem__(self, key):
"""
Delete a metadata tag for a given key.
:param key: metadata key in the dotted form
``familyName.groupName.tagName`` where ``familyName`` may
be one of ``exif``, ``iptc`` or ``xmp``.
:type key: string
:raise KeyError: if the tag with the given key doesn't exist
"""
family = key.split('.')[0].lower()
if family in ('exif', 'iptc', 'xmp'):
return getattr(self, '_delete_%s_tag' % family)(key)
else:
raise KeyError(key)
def __iter__(self):
return chain(self.exif_keys, self.iptc_keys, self.xmp_keys)
def __len__(self):
return len( [ x for x in self ] )
def _get_comment(self):
return self._image._getComment()
def _set_comment(self, comment):
if comment is not None:
self._image._setComment(comment)
else:
self._del_comment()
def _del_comment(self):
self._image._clearComment()
comment = property(fget=_get_comment, fset=_set_comment, fdel=_del_comment,
doc='The image comment.')
@property
def previews(self):
"""List of the previews available in the image, sorted by increasing
size."""
return [Preview(preview) for preview in self._image._previews()]
def copy(self, 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.
:param other: the destination metadata to copy to (it must have been
:meth:`.read` beforehand)
:type other: :class:`pyexiv2.metadata.ImageMetadata`
:param exif: whether to copy the EXIF metadata
:type exif: boolean
:param iptc: whether to copy the IPTC metadata
:type iptc: boolean
:param xmp: whether to copy the XMP metadata
:type xmp: boolean
:param comment: whether to copy the image comment
:type comment: boolean
"""
self._image._copyMetadata(other._image, exif, iptc, xmp)
# Empty the cache where needed
if exif:
other._keys['exif'] = None
other._tags['exif'] = {}
if iptc:
other._keys['iptc'] = None
other._tags['iptc'] = {}
if xmp:
other._keys['xmp'] = None
other._tags['xmp'] = {}
if comment:
other.comment = self.comment
@property
def buffer(self):
"""
The image buffer as a string.
If metadata has been modified, the data won't be up-to-date until
:meth:`.write` has been called.
"""
return self._image._getDataBuffer()
@property
def exif_thumbnail(self):
"""A thumbnail image optionally embedded in the EXIF data."""
if self._exif_thumbnail is None:
self._exif_thumbnail = ExifThumbnail(self)
return self._exif_thumbnail
def _get_iptc_charset(self):
value = self._image._getIptcCharset()
if value != '':
return value.lower()
else:
return None
def _set_iptc_charset(self, charset):
if charset is None:
self._del_iptc_charset()
return
try:
name = codecs.lookup(charset).name
except LookupError, error:
raise ValueError(*error.args)
else:
charsets = {'utf-8': '\x1b%G'}
try:
self['Iptc.Envelope.CharacterSet'] = (charsets[name],)
except KeyError:
raise ValueError('Unhandled charset: %s' % name)
def _del_iptc_charset(self):
try:
del self['Iptc.Envelope.CharacterSet']
except KeyError:
pass
iptc_charset = property(fget=_get_iptc_charset, fset=_set_iptc_charset,
fdel=_del_iptc_charset,
doc='An optional character set the IPTC data is encoded in.')
|