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

.. py:module:: tagkit.image.exif

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

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

Classes
~~~~~~~

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

   * - :py:obj:`ExifImage <tagkit.image.exif.ExifImage>`
     - .. autodoc2-docstring:: tagkit.image.exif.ExifImage
          :summary:

Data
~~~~

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

   * - :py:obj:`DATETIME_TAG_PRECEDENCE <tagkit.image.exif.DATETIME_TAG_PRECEDENCE>`
     - .. autodoc2-docstring:: tagkit.image.exif.DATETIME_TAG_PRECEDENCE
          :summary:

API
~~~

.. py:data:: DATETIME_TAG_PRECEDENCE
   :canonical: tagkit.image.exif.DATETIME_TAG_PRECEDENCE
   :value: ['DateTimeOriginal', 'DateTimeDigitized', 'DateTime']

   .. autodoc2-docstring:: tagkit.image.exif.DATETIME_TAG_PRECEDENCE

.. py:class:: ExifImage(file_path: tagkit.core.types.FilePath, tag_filter: typing.Optional[typing.Iterable[typing.Union[int, str]]] = None, thumbnail: typing.Optional[bool] = None, ifd: typing.Optional[tagkit.core.types.IfdName] = None, io_backend: typing.Optional[tagkit.tag_io.base.ExifIOBackend] = None)
   :canonical: tagkit.image.exif.ExifImage

   .. autodoc2-docstring:: tagkit.image.exif.ExifImage

   .. rubric:: Initialization

   .. autodoc2-docstring:: tagkit.image.exif.ExifImage.__init__

   .. py:method:: __len__() -> int
      :canonical: tagkit.image.exif.ExifImage.__len__

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.__len__

   .. py:method:: write_tag(tag_key: typing.Union[str, int], value: tagkit.core.types.TagValue, ifd: typing.Optional[tagkit.core.types.IfdName] = None)
      :canonical: tagkit.image.exif.ExifImage.write_tag

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.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)
      :canonical: tagkit.image.exif.ExifImage.write_tags

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.write_tags

   .. py:method:: delete_tag(tag_key: typing.Union[str, int], ifd: typing.Optional[tagkit.core.types.IfdName] = None)
      :canonical: tagkit.image.exif.ExifImage.delete_tag

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.delete_tag

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

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.delete_tags

   .. 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) -> tagkit.core.types.TagValue
      :canonical: tagkit.image.exif.ExifImage.read_tag

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.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, skip_missing: bool = False) -> dict[str, tagkit.core.types.TagValue]
      :canonical: tagkit.image.exif.ExifImage.read_tags

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.read_tags

   .. py:property:: tags
      :canonical: tagkit.image.exif.ExifImage.tags
      :type: typing.Mapping[str, tagkit.core.tag.ExifTag]

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.tags

   .. py:method:: save(create_backup: bool = False)
      :canonical: tagkit.image.exif.ExifImage.save

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.save

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

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.as_dict

   .. py:method:: get_datetime(tag: typing.Optional[str] = None) -> datetime.datetime
      :canonical: tagkit.image.exif.ExifImage.get_datetime

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.get_datetime

   .. py:method:: set_datetime(dt: datetime.datetime, tags: typing.Optional[typing.Iterable[str]] = None) -> None
      :canonical: tagkit.image.exif.ExifImage.set_datetime

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.set_datetime

   .. py:method:: offset_datetime(delta: datetime.timedelta, tags: typing.Optional[typing.Iterable[str]] = None) -> None
      :canonical: tagkit.image.exif.ExifImage.offset_datetime

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.offset_datetime

   .. py:method:: get_all_datetimes() -> dict[str, datetime.datetime]
      :canonical: tagkit.image.exif.ExifImage.get_all_datetimes

      .. autodoc2-docstring:: tagkit.image.exif.ExifImage.get_all_datetimes