: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[list[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) -> typing.Dict[str, typing.Any]
      :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:: write_tag(tag: typing.Union[str, int], value: typing.Any, 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: dict[typing.Union[str, int], typing.Any], 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(tags: list[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