python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-11-04 09:57:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

Removed "Experimental" label from pulls_fd

Browse Source
This commit is contained in:
Andrew Murray 2022-02-28 12:17:16 +11:00
parent 3cb355c1af
commit 3b79a776d6
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/handbook/writing-your-own-image-plugin.rst
View File

@ -373,12 +373,10 @@ interest in this object are:
any format specific state or options. any format specific state or options.
**pulls_fd** **pulls_fd**
**EXPERIMENTAL** -- **WARNING**, interface may change. If set to 1, If set to 1, ``state->fd`` will be a pointer to the Python file like
``state->fd`` will be a pointer to the Python file like object. The object. The decoder may use the functions in ``codec_fd.c`` to read
decoder may use the functions in ``codec_fd.c`` to read directly directly from the file like object rather than have the data pushed
from the file like object rather than have the data pushed through a through a buffer.
buffer. Note that this implementation may be refactored until this
warning is removed.
.. versionadded:: 3.3.0 .. versionadded:: 3.3.0
@ -389,17 +387,16 @@ Decoding
The decode function is called with the target (core) image, the The decode function is called with the target (core) image, the
decoder state structure, and a buffer of data to be decoded. decoder state structure, and a buffer of data to be decoded.
**Experimental** -- If ``pulls_fd`` is set, then the decode function
is called once, with an empty buffer. It is the decoder's
responsibility to decode the entire tile in that one call. The rest of
this section only applies if ``pulls_fd`` is not set.
It is the decoder's responsibility to pull as much data as possible It is the decoder's responsibility to pull as much data as possible
out of the buffer and return the number of bytes consumed. The next out of the buffer and return the number of bytes consumed. The next
call to the decoder will include the previous unconsumed tail. The call to the decoder will include the previous unconsumed tail. The
decoder function will be called multiple times as the data is read decoder function will be called multiple times as the data is read
from the file like object. from the file like object.
Alternatively, if ``pulls_fd`` is set, then the decode function is
called once, with an empty buffer. It is the decoder's responsibility
to decode the entire tile in that one call.
If an error occurs, set ``state->errcode`` and return -1. If an error occurs, set ``state->errcode`` and return -1.
Return -1 on success, without setting the errcode. Return -1 on success, without setting the errcode.