:py:mod:`tagkit.image.collection`
=================================

.. py:module:: tagkit.image.collection

.. autodoc2-docstring:: tagkit.image.collection
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ExifImageCollection <tagkit.image.collection.ExifImageCollection>`
     - .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection
          :summary:

API
~~~

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

   .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection

   .. rubric:: Initialization

   .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.__init__

   .. py:method:: as_dict(binary_format: typing.Optional[str] = None) -> dict[str, dict[str, dict[str, typing.Union[str, int]]]]
      :canonical: tagkit.image.collection.ExifImageCollection.as_dict

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.as_dict

   .. py:property:: n_tags
      :canonical: tagkit.image.collection.ExifImageCollection.n_tags
      :type: int

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.n_tags

   .. py:property:: n_files
      :canonical: tagkit.image.collection.ExifImageCollection.n_files
      :type: int

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.n_files

   .. py:method:: _normalize_filenames(files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]]) -> list[str]
      :canonical: tagkit.image.collection.ExifImageCollection._normalize_filenames

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection._normalize_filenames

   .. py:method:: write_tag(tag_key: typing.Union[str, int], value: tagkit.core.types.TagValue, ifd: typing.Optional[tagkit.core.types.IfdName] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None)
      :canonical: tagkit.image.collection.ExifImageCollection.write_tag

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.write_tag

   .. py:method:: write_tags(tags: typing.Mapping[typing.Union[str, int], tagkit.core.types.TagValue], ifd: typing.Optional[tagkit.core.types.IfdName] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None)
      :canonical: tagkit.image.collection.ExifImageCollection.write_tags

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.write_tags

   .. py:method:: delete_tag(tag_key: typing.Union[str, int], ifd: typing.Optional[tagkit.core.types.IfdName] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None)
      :canonical: tagkit.image.collection.ExifImageCollection.delete_tag

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.delete_tag

   .. py:method:: delete_tags(tag_keys: typing.Iterable[typing.Union[str, int]], ifd: typing.Optional[tagkit.core.types.IfdName] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None)
      :canonical: tagkit.image.collection.ExifImageCollection.delete_tags

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.delete_tags

   .. py:method:: save_all(create_backup: bool = False)
      :canonical: tagkit.image.collection.ExifImageCollection.save_all

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.save_all

   .. py:method:: get_datetime(files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None, tag: typing.Optional[str] = None) -> dict[str, datetime.datetime]
      :canonical: tagkit.image.collection.ExifImageCollection.get_datetime

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.get_datetime

   .. py:method:: set_datetime(dt: datetime.datetime, tags: typing.Optional[typing.Iterable[str]] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None) -> None
      :canonical: tagkit.image.collection.ExifImageCollection.set_datetime

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.set_datetime

   .. py:method:: offset_datetime(delta: datetime.timedelta, tags: typing.Optional[typing.Iterable[str]] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None) -> None
      :canonical: tagkit.image.collection.ExifImageCollection.offset_datetime

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.offset_datetime

   .. py:method:: get_all_datetimes(files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None) -> dict[str, dict[str, datetime.datetime]]
      :canonical: tagkit.image.collection.ExifImageCollection.get_all_datetimes

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.get_all_datetimes

   .. py:method:: read_tag(tag_key: typing.Union[str, int], ifd: typing.Optional[tagkit.core.types.IfdName] = None, format_value: bool = False, binary_format: typing.Optional[str] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None, skip_missing: bool = False) -> dict[str, tagkit.core.types.TagValue]
      :canonical: tagkit.image.collection.ExifImageCollection.read_tag

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.read_tag

   .. py:method:: read_tags(tag_keys: list[typing.Union[str, int]], ifd: typing.Optional[tagkit.core.types.IfdName] = None, format_value: bool = False, binary_format: typing.Optional[str] = None, files: typing.Optional[typing.Iterable[tagkit.core.types.FilePath]] = None, skip_missing: bool = False) -> dict[str, dict[str, tagkit.core.types.TagValue]]
      :canonical: tagkit.image.collection.ExifImageCollection.read_tags

      .. autodoc2-docstring:: tagkit.image.collection.ExifImageCollection.read_tags