From bb69e79dc913620e84bbf34be192fc7f67a8b89a Mon Sep 17 00:00:00 2001 From: Hugo Date: Sun, 20 Jan 2019 22:07:22 +0200 Subject: [PATCH 1/2] Document removals --- docs/deprecations.rst | 43 +++++++++++-------------------- docs/releasenotes/4.3.0.rst | 2 +- docs/releasenotes/6.0.0.rst | 51 +++++++++++++++++++++++++++++++++++++ docs/releasenotes/index.rst | 1 + 4 files changed, 68 insertions(+), 29 deletions(-) create mode 100644 docs/releasenotes/6.0.0.rst diff --git a/docs/deprecations.rst b/docs/deprecations.rst index 8d0ccbf37..adbf0f85f 100644 --- a/docs/deprecations.rst +++ b/docs/deprecations.rst @@ -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 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. deprecated:: 4.3.0 +*Removed in version 6.0.0.* -Several undocumented functions in ``ImageOps`` have been deprecated. They issue -a ``DeprecationWarning`` informing which equivalent to use from ``ImageFilter`` -instead: +Several undocumented functions in ``ImageOps`` have been removed. Use the equivalents +in ``ImageFilter`` instead: ========================== ============================ -Deprecated Use instead +Removed Use instead ========================== ============================ ``ImageOps.box_blur`` ``ImageFilter.BoxBlur`` ``ImageOps.gaussian_blur`` ``ImageFilter.GaussianBlur`` @@ -56,27 +61,9 @@ Deprecated Use instead 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`` issues a ``DeprecationWarning`` (from 4.0.0) or raises -``ImportError`` (from 5.0.0): - -.. 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``). +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`` in 5.0.0 +(2018-01). The deprecated file has now been removed from Pillow. If needed, install from +PyPI (eg. ``pip install olefile``). diff --git a/docs/releasenotes/4.3.0.rst b/docs/releasenotes/4.3.0.rst index 827754230..6fa554e23 100644 --- a/docs/releasenotes/4.3.0.rst +++ b/docs/releasenotes/4.3.0.rst @@ -9,7 +9,7 @@ Deprecations Several undocumented functions in ImageOps have been deprecated: ``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. TIFF Metadata Changes diff --git a/docs/releasenotes/6.0.0.rst b/docs/releasenotes/6.0.0.rst new file mode 100644 index 000000000..2ed3d980a --- /dev/null +++ b/docs/releasenotes/6.0.0.rst @@ -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 ``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 diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst index 9f98d6961..9a088375b 100644 --- a/docs/releasenotes/index.rst +++ b/docs/releasenotes/index.rst @@ -6,6 +6,7 @@ Release Notes .. toctree:: :maxdepth: 2 + 6.0.0 5.4.1 5.4.0 5.3.0 From 5a276be8895b991a6b982f741f8ea6c10aa9c2a3 Mon Sep 17 00:00:00 2001 From: Andrew Murray <3112309+radarhere@users.noreply.github.com> Date: Mon, 21 Jan 2019 20:55:04 +0200 Subject: [PATCH 2/2] Fix typo Co-Authored-By: hugovk --- docs/releasenotes/6.0.0.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releasenotes/6.0.0.rst b/docs/releasenotes/6.0.0.rst index 2ed3d980a..f683d7c20 100644 --- a/docs/releasenotes/6.0.0.rst +++ b/docs/releasenotes/6.0.0.rst @@ -22,7 +22,7 @@ deprecated file has now been removed from Pillow. If needed, install from PyPI ( Removed deprecated ImageOps functions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Several undocumented functions ``ImageOps`` were deprecated in Pillow 4.3.0 (2017-10) +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.