Merge pull request #3090 from hugovk/deprecate-versions

Deprecate PILLOW_VERSION and VERSION

Tests/test_pyroma.py

@@ -1,6 +1,6 @@
 from helper import unittest, PillowTestCase
 
-from PIL import PILLOW_VERSION
+from PIL import __version__
 
 try:
     import pyroma
@@ -26,7 +26,7 @@ class TestPyroma(PillowTestCase):
         rating = pyroma.ratings.rate(data)
 
         # Assert
-        if 'rc' in PILLOW_VERSION:
+        if 'rc' in __version__:
             # Pyroma needs to chill about RC versions
             # and not kill all our tests.
             self.assertEqual(rating, (9, [

docs/conf.py

@@ -53,9 +53,9 @@ author = u'Fredrik Lundh, Alex Clark and Contributors'
 #
 # The short X.Y version.
 import PIL
-version = PIL.PILLOW_VERSION
+version = PIL.__version__
 # The full version, including alpha/beta/rc tags.
-release = PIL.PILLOW_VERSION
+release = PIL.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/releasenotes/5.2.0.rst

@@ -1,6 +1,23 @@
 5.2.0
 -----
 
+API Changes
+===========
+
+Deprecations
+^^^^^^^^^^^^
+
+These version constants have been deprecated. ``VERSION`` will be removed in
+Pillow 6.0.0, and ``PILLOW_VERSION`` will be removed after that.
+
+* ``PIL.VERSION`` (old PIL version 1.1.7)
+* ``PIL.PILLOW_VERSION``
+* ``PIL.Image.VERSION``
+* ``PIL.Image.PILLOW_VERSION``
+
+Use ``PIL.__version__`` instead.
+
+
 API Additions
 =============
 

selftest.py

@@ -161,7 +161,7 @@ if __name__ == "__main__":
     exit_status = 0
 
     print("-"*68)
-    print("Pillow", Image.PILLOW_VERSION, "TEST SUMMARY ")
+    print("Pillow", Image.__version__, "TEST SUMMARY ")
     print("-"*68)
     print("Python modules loaded from", os.path.dirname(Image.__file__))
     print("Binary modules loaded from", os.path.dirname(Image.core.__file__))

src/PIL/Image.py

@@ -24,7 +24,10 @@
 # See the README file for information on usage and redistribution.
 #
 
-from . import VERSION, PILLOW_VERSION, _plugins
+# VERSION is deprecated and will be removed in Pillow 6.0.0.
+# PILLOW_VERSION is deprecated and will be removed after that.
+# Use __version__ instead.
+from . import VERSION, PILLOW_VERSION, __version__, _plugins
 from ._util import py3
 
 import logging
@@ -59,13 +62,13 @@ try:
     # Also note that Image.core is not a publicly documented interface,
     # and should be considered private and subject to change.
     from . import _imaging as core
-    if PILLOW_VERSION != getattr(core, 'PILLOW_VERSION', None):
+    if __version__ != getattr(core, 'PILLOW_VERSION', None):
         raise ImportError("The _imaging extension was built for another "
                           "version of Pillow or PIL:\n"
                           "Core version: %s\n"
                           "Pillow version: %s" %
                           (getattr(core, 'PILLOW_VERSION', None),
-                           PILLOW_VERSION))
+                           __version__))
 
 except ImportError as v:
     core = _imaging_not_installed()

src/PIL/__init__.py

@@ -13,6 +13,9 @@
 
 from . import _version
 
+# VERSION is deprecated and will be removed in Pillow 6.0.0.
+# PILLOW_VERSION is deprecated and will be removed after that.
+# Use __version__ instead.
 VERSION = '1.1.7'  # PIL Version
 PILLOW_VERSION = __version__ = _version.__version__