python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-28 10:56:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated docstring

Browse Source
This commit is contained in:
Andrew Murray 2021-09-11 19:24:24 +10:00
parent e122e8f3a6
commit c39e545949
1 changed files with 27 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/PIL/TiffImagePlugin.py
View File

@ -437,35 +437,41 @@ class ImageFileDirectory_v2(MutableMapping):
Data Structures:
* self.tagtype = {}
* ``self.tagtype = {}``
* Key: numerical tiff tag number
* Value: integer corresponding to the data type from
~PIL.TiffTags.TYPES`
:py:data:`.TiffTags.TYPES`
.. versionadded:: 3.0.0
"""
"""
Documentation:
'internal' data structures:
* self._tags_v2 = {} Key: numerical tiff tag number
Value: decoded data, as tuple for multiple values
* self._tagdata = {} Key: numerical tiff tag number
Value: undecoded byte string from file
* self._tags_v1 = {} Key: numerical tiff tag number
Value: decoded data in the v1 format
Tags will be found in the private attributes self._tagdata, and in
self._tags_v2 once decoded.
* ``self._tags_v2 = {}``
self.legacy_api is a value for internal use, and shouldn't be
changed from outside code. In cooperation with the
ImageFileDirectory_v1 class, if legacy_api is true, then decoded
tags will be populated into both _tags_v1 and _tags_v2. _tags_v2
will be used if this IFD is used in the TIFF save routine. Tags
should be read from _tags_v1 if legacy_api == true.
* Key: numerical tiff tag number
* Value: decoded data, as tuple for multiple values
* ``self._tagdata = {}``
* Key: numerical tiff tag number
* Value: undecoded byte string from file
* ``self._tags_v1 = {}``
* Key: numerical tiff tag number
* Value: decoded data in the v1 format
Tags will be found in the private attributes ``self._tagdata``, and in
``self._tags_v2`` once decoded.
``self.legacy_api`` is a value for internal use, and shouldn't be changed
from outside code. In cooperation with
:py:class:`~PIL.TiffImagePlugin.ImageFileDirectory_v1`, if ``legacy_api``
is true, then decoded tags will be populated into both ``_tags_v1`` and
``_tags_v2``. ``_tags_v2`` will be used if this IFD is used in the TIFF
save routine. Tags should be read from ``_tags_v1`` if
``legacy_api == true``.
"""