diff --git a/docs/deprecations.rst b/docs/deprecations.rst index c21aea2b489..f00f3e31fa5 100644 --- a/docs/deprecations.rst +++ b/docs/deprecations.rst @@ -12,6 +12,29 @@ Deprecated features Below are features which are considered deprecated. Where appropriate, a ``DeprecationWarning`` is issued. +Image.__del__ +~~~~~~~~~~~~~ + +.. deprecated:: 6.1.0 + +Implicitly closing the image's underlying file in ``Image.__del__`` has been deprecated. +Use a context manager or call ``Image.close()`` instead to close the file in a +deterministic way. + +Deprecated: + +.. code-block:: python + + im = Image.open("hopper.png") + im.save("out.jpg") + +Use instead: + +.. code-block:: python + + with Image.open("hopper.png") as im: + im.save("out.jpg") + Python 2.7 ~~~~~~~~~~ diff --git a/docs/releasenotes/6.1.0.rst b/docs/releasenotes/6.1.0.rst index 851dcb2d0a4..ffe0aacf0b7 100644 --- a/docs/releasenotes/6.1.0.rst +++ b/docs/releasenotes/6.1.0.rst @@ -1,6 +1,32 @@ 6.1.0 ----- +Deprecations +============ + +Image.__del__ +^^^^^^^^^^^^^ + +.. deprecated:: 6.1.0 + +Implicitly closing the image's underlying file in ``Image.__del__`` has been deprecated. +Use a context manager or call ``Image.close()`` instead to close the file in a +deterministic way. + +Deprecated: + +.. code-block:: python + + im = Image.open("hopper.png") + im.save("out.jpg") + +Use instead: + +.. code-block:: python + + with Image.open("hopper.png") as im: + im.save("out.jpg") + API Additions =============