Merge pull request #3600 from hugovk/add-release-notes

Document removals
This commit is contained in:
Hugo 2019-01-28 11:59:41 +02:00 committed by GitHub
commit 071dc9409f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 68 additions and 29 deletions

View File

@ -34,17 +34,22 @@ Two version constants ``VERSION`` (the old PIL version, always 1.1.7) and
``PILLOW_VERSION`` have been deprecated and will be removed in the next ``PILLOW_VERSION`` have been deprecated and will be removed in the next
major release. Use ``__version__`` instead. major release. Use ``__version__`` instead.
Removed features
----------------
Deprecated features are only removed in major releases after an appropriate
period of deprecation has passed.
Undocumented ImageOps functions Undocumented ImageOps functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. deprecated:: 4.3.0 *Removed in version 6.0.0.*
Several undocumented functions in ``ImageOps`` have been deprecated. They issue Several undocumented functions in ``ImageOps`` have been removed. Use the equivalents
a ``DeprecationWarning`` informing which equivalent to use from ``ImageFilter`` in ``ImageFilter`` instead:
instead:
========================== ============================ ========================== ============================
Deprecated Use instead Removed Use instead
========================== ============================ ========================== ============================
``ImageOps.box_blur`` ``ImageFilter.BoxBlur`` ``ImageOps.box_blur`` ``ImageFilter.BoxBlur``
``ImageOps.gaussian_blur`` ``ImageFilter.GaussianBlur`` ``ImageOps.gaussian_blur`` ``ImageFilter.GaussianBlur``
@ -56,27 +61,9 @@ Deprecated Use instead
PIL.OleFileIO PIL.OleFileIO
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. deprecated:: 4.0.0 *Removed in version 6.0.0.*
The vendored version of olefile has been removed. Attempting to import PIL.OleFileIO was removed as a vendored file and in Pillow 4.0.0 (2017-01) in favour of
``PIL.OleFileIO`` issues a ``DeprecationWarning`` (from 4.0.0) or raises the upstream olefile Python package, and replaced with an ``ImportError`` in 5.0.0
``ImportError`` (from 5.0.0): (2018-01). The deprecated file has now been removed from Pillow. If needed, install from
PyPI (eg. ``pip install olefile``).
.. code-block:: none
PIL.OleFileIO is deprecated. Use the olefile Python package
instead. This module will be removed in a future version.
Removed features
----------------
Deprecated features are only removed in major releases after an appropriate
period of deprecation has passed.
Vendored olefile
~~~~~~~~~~~~~~~~
*Removed in version 4.0.0.*
The vendored version of the olefile Python package was removed in favour of the
upstream package. Install if needed (eg. ``pip install olefile``).

View File

@ -9,7 +9,7 @@ Deprecations
Several undocumented functions in ImageOps have been deprecated: Several undocumented functions in ImageOps have been deprecated:
``gaussian_blur``, ``gblur``, ``unsharp_mask``, ``usm`` and ``gaussian_blur``, ``gblur``, ``unsharp_mask``, ``usm`` and
``box_blur``. Use the equivalent operations in ImageFilter ``box_blur``. Use the equivalent operations in ``ImageFilter``
instead. These functions will be removed in a future release. instead. These functions will be removed in a future release.
TIFF Metadata Changes TIFF Metadata Changes

View File

@ -0,0 +1,51 @@
6.0.0
-----
Backwards Incompatible Changes
==============================
Python 3.4 dropped
^^^^^^^^^^^^^^^^^^
Python 3.4 is EOL since 2019-03-16 and no longer supported. We will not be creating
binaries, testing, or retaining compatibility with this version. The final version of
Pillow for Python 3.4 is 5.4.1.
Removed deprecated PIL.OleFileIO
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PIL.OleFileIO was removed as a vendored file and in Pillow 4.0.0 (2017-01) in favour of
the upstream olefile Python package, and replaced with an ``ImportError``. The
deprecated file has now been removed from Pillow. If needed, install from PyPI (eg.
``pip install olefile``).
Removed deprecated ImageOps functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Several undocumented functions in ``ImageOps`` were deprecated in Pillow 4.3.0 (2017-10)
and have now been removed: ``gaussian_blur``, ``gblur``, ``unsharp_mask``, ``usm`` and
``box_blur``. Use the equivalent operations in ``ImageFilter`` instead.
API Changes
===========
TODO
^^^^
TODO
API Additions
=============
TODO
^^^^
TODO
Other Changes
=============
TODO
^^^^
TODO

View File

@ -6,6 +6,7 @@ Release Notes
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
6.0.0
5.4.1 5.4.1
5.4.0 5.4.0
5.3.0 5.3.0