tagkit.image.collection

Collection of EXIF image data for multiple files.

This module provides the ExifImageCollection class for working with EXIF data from multiple image files.

Module Contents

Classes

ExifImageCollection

A collection of EXIF data for multiple image files.

API

class tagkit.image.collection.ExifImageCollection(files: Iterable[tagkit.core.types.FilePath], *, tag_filter: Optional[list[Union[int, str]]] = None, ifd: Optional[tagkit.core.types.IfdName] = None)

A collection of EXIF data for multiple image files.

This class provides a convenient way to access EXIF data from multiple files.

Args:

files: List of paths to image files. tag_filter: Optional list of tag names or IDs to filter by. ifd: Specific IFD to use.

Attributes:

files (Dict[str, ExifImage]): Dictionary mapping file paths to their EXIF data.

Initialization

Initialize the collection with a list of file paths.

Args:

files: List of paths to image files. tag_filter: Optional list of tag names or IDs to filter by. ifd: Specific IFD to use.

as_dict(binary_format: Optional[str] = None) → Dict[str, Any]

Convert the collection to a dictionary.

Args:

binary_format: Format for binary data (‘hex’, ‘base64’, or None for default).

If None, <bytes: N> will be shown as a placeholder.

Returns:

Dictionary mapping file paths to their EXIF data dictionaries.

Example:

>>> collection = ExifImageCollection(["image2.jpg", "image3.jpg"])
>>> collection.as_dict()
{'image2.jpg': {'Make': {'id': 271, 'value': 'Tagkit', 'ifd': 'IFD0'}}, 'image3.jpg': {'Make': {'id': 271, 'value': 'Tagkit', 'ifd': 'IFD0'}}}

property n_tags: int

Get the total number of tags across all files.

Returns:

Total number of tags.

Example:

>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.n_tags
9

property n_files: int

Get the number of files in the collection.

Returns:

Number of files.

Example:

>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.n_files
2

write_tag(tag: Union[str, int], value: Any, ifd: Optional[tagkit.core.types.IfdName] = None, files: Optional[Iterable[tagkit.core.types.FilePath]] = None)

Set the value of a specific EXIF tag for all or selected images in the collection.

Args:

tag: Tag name or tag ID. value: Value to set. ifd: Specific IFD to use. files: Iterable of file names (keys in self.files) to update. If None, update all.

Raises:

KeyError: If a file is not found in the collection. ValueError: If the tag or IFD is invalid.

Example:

>>> from tagkit.image.collection import ExifImageCollection
>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.write_tag('Artist', 'John Doe', ifd='IFD0')

write_tags(tags: dict[Union[str, int], Any], ifd: Optional[tagkit.core.types.IfdName] = None, files: Optional[Iterable[tagkit.core.types.FilePath]] = None)

Set multiple EXIF tags for all or selected images in the collection.

Args:

tags: A dictionary mapping tag names or IDs to values. ifd: Specific IFD to use for all tags. files: Iterable of file names (keys in self.files) to update. If None, update all.

Example:

>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.write_tags({'Artist': 'Jane', 'Copyright': '2025 John'})

delete_tag(tag_key: Union[str, int], ifd: Optional[tagkit.core.types.IfdName] = None, files: Optional[Iterable[tagkit.core.types.FilePath]] = None)

Remove a specific EXIF tag from all or selected images in the collection. If a file does not contain the tag, it is silently ignored.

Args:

tag_key: Tag name or tag ID. ifd: Specific IFD to use. files: Iterable of file names (keys in self.files) to update. If None, update all.

Raises:

KeyError: If a file is not found in the collection. ValueError: If the tag or IFD is invalid.

Example:

>>> from tagkit.image.collection import ExifImageCollection
>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.write_tag('Artist', 'John Doe', ifd='IFD0')
>>> collection.delete_tag('Artist', ifd='IFD0')

delete_tags(tags: list[Union[str, int]], ifd: Optional[tagkit.core.types.IfdName] = None, files: Optional[Iterable[tagkit.core.types.FilePath]] = None)

Remove multiple EXIF tags from all or selected images in the collection. If a file does not contain a tag, it is silently ignored.

Args:

tags: A list of tag names or tag IDs to remove. ifd: Specific IFD to use for all tags. files: Iterable of file names (keys in self.files) to update. If None, update all.

Example:

>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.delete_tags(['Artist', 'Copyright'])

save_all(create_backup: bool = False)

Save all modified EXIF data back to their respective image files.

Args:

create_backup: If True, create a backup of each file before saving.

Example:

>>> from tagkit.image.collection import ExifImageCollection
>>> collection = ExifImageCollection(["image1.jpg", "image2.jpg"])
>>> collection.write_tag('Artist', 'John Doe')
>>> collection.save_all(create_backup=True)