mirror of
https://github.com/python-pillow/Pillow.git
synced 2025-05-29 10:13:09 +03:00
Improved documentation for _pulls_fd and _pushes_fd
This commit is contained in:
parent
3b79a776d6
commit
95e3194497
|
@ -395,7 +395,9 @@ from the file like object.
|
||||||
|
|
||||||
Alternatively, if ``pulls_fd`` is set, then the decode function is
|
Alternatively, if ``pulls_fd`` is set, then the decode function is
|
||||||
called once, with an empty buffer. It is the decoder's responsibility
|
called once, with an empty buffer. It is the decoder's responsibility
|
||||||
to decode the entire tile in that one call.
|
to decode the entire tile in that one call. Using this will provide a
|
||||||
|
codec with more freedom, but that freedom may mean increased memory usage
|
||||||
|
if entire tile is held in memory at once by the codec.
|
||||||
|
|
||||||
If an error occurs, set ``state->errcode`` and return -1.
|
If an error occurs, set ``state->errcode`` and return -1.
|
||||||
|
|
||||||
|
@ -429,6 +431,13 @@ Python-based file codec:
|
||||||
a buffer of data to be interpreted, or the ``encode`` method is repeatedly
|
a buffer of data to be interpreted, or the ``encode`` method is repeatedly
|
||||||
called with the size of data to be output.
|
called with the size of data to be output.
|
||||||
|
|
||||||
|
Alternatively, if the decoder's ``_pulls_fd`` property (or the encoder's
|
||||||
|
``_pushes_fd`` property) is set to ``True``, then ``decode`` and ``encode``
|
||||||
|
will only be called once. In the decoder, ``self.fd`` can be used to access
|
||||||
|
the file-like object. Using this will provide a codec with more freedom, but
|
||||||
|
that freedom may mean increased memory usage if entire file is held in
|
||||||
|
memory at once by the codec.
|
||||||
|
|
||||||
In ``decode``, once the data has been interpreted, ``set_as_raw`` can be
|
In ``decode``, once the data has been interpreted, ``set_as_raw`` can be
|
||||||
used to populate the image.
|
used to populate the image.
|
||||||
|
|
||||||
|
|
|
@ -725,6 +725,9 @@ class PyEncoder(PyCodec):
|
||||||
|
|
||||||
def encode_to_pyfd(self):
|
def encode_to_pyfd(self):
|
||||||
"""
|
"""
|
||||||
|
If ``pushes_fd`` is ``True``, then this method will be used,
|
||||||
|
and ``encode()`` will only be called once.
|
||||||
|
|
||||||
:returns: A tuple of ``(bytes consumed, errcode)``.
|
:returns: A tuple of ``(bytes consumed, errcode)``.
|
||||||
Err codes are from :data:`.ImageFile.ERRORS`.
|
Err codes are from :data:`.ImageFile.ERRORS`.
|
||||||
"""
|
"""
|
||||||
|
|
Loading…
Reference in New Issue
Block a user