python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-01-11 17:56:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

DOC fix "Write Your Own File Decoder" link in Image API docs

Browse Source
This commit is contained in:
Mikhail Korobov 2015-01-07 04:12:37 +05:00
parent e8e2482292
commit 52cbd123a2
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
PIL/Image.py
View File

@ -2024,7 +2024,7 @@ def frombytes(mode, size, data, decoder_name="raw", *args):
You can also use any pixel decoder supported by PIL. For more You can also use any pixel decoder supported by PIL. For more
information on available decoders, see the section information on available decoders, see the section
**Writing Your Own File Decoder**. :ref:`Writing Your Own File Decoder <file-decoders>`.
Note that this function decodes pixel data only, not entire images. Note that this function decodes pixel data only, not entire images.
If you have an entire image in a string, wrap it in a If you have an entire image in a string, wrap it in a

10
docs/handbook/writing-your-own-file-decoder.rst
View File

@ -1,4 +1,6 @@
Writing your own file decoder .. _file-decoders:
Writing Your Own File Decoder
============================= =============================
The Python Imaging Library uses a plug-in model which allows you to The Python Imaging Library uses a plug-in model which allows you to
@ -7,7 +9,7 @@ library itself. Such plug-ins usually have names like
:file:`XxxImagePlugin.py`, where ``Xxx`` is a unique format name :file:`XxxImagePlugin.py`, where ``Xxx`` is a unique format name
(usually an abbreviation). (usually an abbreviation).
.. warning:: Pillow >= 2.1.0 no longer automatically imports any file in the Python path with a name ending in :file:`ImagePlugin.py`. You will need to import your decoder manually. .. warning:: Pillow >= 2.1.0 no longer automatically imports any file in the Python path with a name ending in :file:`ImagePlugin.py`. You will need to import your decoder manually.
A decoder plug-in should contain a decoder class, based on the A decoder plug-in should contain a decoder class, based on the
:py:class:`PIL.ImageFile.ImageFile` base class. This class should provide an :py:class:`PIL.ImageFile.ImageFile` base class. This class should provide an
@ -68,7 +70,7 @@ true color.
] ]
Image.register_open("SPAM", SpamImageFile) Image.register_open("SPAM", SpamImageFile)
Image.register_extension("SPAM", ".spam") Image.register_extension("SPAM", ".spam")
Image.register_extension("SPAM", ".spa") # dos version Image.register_extension("SPAM", ".spa") # dos version
@ -125,7 +127,7 @@ TIFF, and many others. To use the raw decoder with the
:py:func:`PIL.Image.fromstring` function, use the following syntax:: :py:func:`PIL.Image.fromstring` function, use the following syntax::
image = Image.fromstring( image = Image.fromstring(
mode, size, data, "raw", mode, size, data, "raw",
raw mode, stride, orientation raw mode, stride, orientation
) )