Deprecate PILLOW_VERSION and VERSION by hugovk · Pull Request #3090 · python-pillow/Pillow

hugovk · 2018-04-11T12:40:56Z

For #3082.

Replaces PR #3085.

Changes proposed in this pull request:

Internally, use more conventional __version__ rather than PILLOW_VERSION
Mark PILLOW_VERSION and VERSION as deprecated, we'll remove them in the next major version.
- It's been nearly a decade since the fork, and no end users will need to know the old PIL 1.1.7. It just causes confusion.
- With that gone, no need for PILLOW_VERSION, use __version__ instead.

#3083 (comment):

Don't break the single version in c & python,

Check

don't break the world by removing the PIL 1.1.7 version until we do a major release

Check

homm · 2018-04-11T12:47:22Z

src/PIL/__init__.py


+# PILLOW_VERSION and VERSION are deprecated and will be removed in Pillow 6.0.0. Use __version__ instead.
 VERSION = '1.1.7'  # PIL Version
 PILLOW_VERSION = version.__version__


Could you rebase on the current master to see the full picture?

homm · 2018-04-11T12:51:15Z

src/PIL/ImageCms.py

    return (
        VERSION, core.littlecms_version,
-        sys.version.split()[0], Image.VERSION
+        sys.version.split()[0], Image.__version__


It used to be 1.1.7 here.

Yes, reverted.

homm · 2018-04-11T13:18:24Z

docs/releasenotes/5.2.0.rst

+Deprecations
+^^^^^^^^^^^^
+
+Two version constants – ``VERSION`` (the old PIL version 1.1.7) and


PIL.VERSION and so on

wiredfool · 2018-04-11T15:29:18Z

You know, there's one other thing.

When we ask for a version number, we should be able to ask for one thing. And unfortunately, that's going to be PILLOW_VERSION for a good long time.

Otherwise, we're going to get this conversation:

What version are you running?

How do I do that?

Depends on what version you're running, either PIL.PILLOW_VERSION or PIL.__version__

aclark4life · 2018-04-11T16:01:20Z

That conversation is probably OK because that’s what deprecation is for. PILLOW_VERSION was a hack we should probably fix…

hugovk · 2018-04-11T18:13:02Z

PIL.__version__ has already been around for 2 years since 3.4.0, in 7 quarterly releases so far.

(Commit 7bfb252 in PR #2027.)

So I think we're fine asking for PIL.__version__.

homm · 2018-04-15T07:08:19Z

docs/releasenotes/5.2.0.rst

+* ``PIL.Image.VERSION``
+* ``PIL.Image.PILLOW_VERSION``
+
+Use ``__version__`` instead.


PIL.__version__ ?

Good idea, updated.

homm · 2018-04-15T09:08:43Z

You know, I'm for the depreciating VERSION and leaving PILLOW_VERSION as is. I don't think this is so terrible to have a fallback for code which works from the beginning of the library. This way, we are reducing the number of "version" constants from four to two in next release.

homm · 2018-04-22T16:33:14Z

@hugovk Needs rebase

hugovk · 2018-04-22T18:21:22Z

Thanks, will rebase.

And how about we keep both deprecations in place, with VERSION to be removed in the next major version, but just say PILLOW_VERSION will be removed in a future version?

That means we most importantly get rid of the confusing, different version numbers (1.1.7 vs. 5.1.0) and also discourages against PILLOW_VERSION for a bit longer.

aclark4life · 2018-04-22T18:26:43Z

@hugovk Sounds good… I think saying we're going to get rid of PILLOW_VERSION at some point but not specifying which future version will allow folks plenty of time to comment if they care. As the person who probably added PILLOW_VERSION, I think it should eventually go…

hugovk · 2018-04-22T19:26:55Z

Rebased and updated.

homm · 2018-04-22T20:11:50Z

docs/releasenotes/5.2.0.rst

+^^^^^^^^^^^^
+
+These version constants have been deprecated. ``VERSION`` will be removed in
+Pillow 6.0.0, and ``PILLOW_VERSION`` will be removed in a future release.


Doesn't it mean that PILLOW_VERSION will be removed in a future release i.e. in 5.3, before 6.0? For me, "and PILLOW_VERSION will be removed after that." looks more clear.

It is ambiguous. Updated!

Edit: and rebased.

jwilk · 2018-06-01T18:48:00Z

I was using PILLOW_VERSION to distinguish between the original PIL and Pillow.
Is there another way to distinguish between the two?

radarhere · 2018-06-01T22:13:53Z

PIL doesn't have __version__, so you can use that as a direct continuation of your current check

PIL.VERSION always reports 1.1.7, it is deprecated since version 5.2.0 (see python-pillow/Pillow#3090), and removed from version 6.0.0. The recommended way to access the version of Pillow is PIL.__version__.

Image.VERSION always reports 1.1.7, it is deprecated since version 5.2.0 (see python-pillow/Pillow#3090), and removed from version 6.0.0. The recommended way to access the version of Pillow is Image.__version__.

hugovk mentioned this pull request Apr 11, 2018

Use __version__ internally, drop old 1.1.7 number, and deprecate other constants #3085

Closed

homm reviewed Apr 11, 2018

View reviewed changes

hugovk force-pushed the deprecate-versions branch from 8f965ac to 66b6db5 Compare April 11, 2018 12:49

homm reviewed Apr 11, 2018

View reviewed changes

homm approved these changes Apr 11, 2018

View reviewed changes

homm reviewed Apr 11, 2018

View reviewed changes

homm reviewed Apr 15, 2018

View reviewed changes

homm added the Needs Rebase label Apr 22, 2018

hugovk force-pushed the deprecate-versions branch from c8c6e4b to 3daabaa Compare April 22, 2018 19:01

hugovk removed the Needs Rebase label Apr 22, 2018

homm reviewed Apr 22, 2018

View reviewed changes

hugovk added 8 commits April 25, 2018 11:21

Prefer more conventional __version__ rather than PILLOW_VERSION

e33dd49

Deprecate PILLOW_VERSION and VERSION, use __version__ instead

d80ed2e

Keep Image.VERSION here

34d6649

Document deprecations in release note

312b917

Explicitly enumerate version constants

3508d67

'Use PIL.__version__ instead.'

c18dce5

PILLOW_VERSION will be removed in a future release

ef9bf76

Clarify PILLOW_VERSION will be removed after VERSION

de6baf6

hugovk force-pushed the deprecate-versions branch from baca69c to de6baf6 Compare April 25, 2018 08:24

homm approved these changes Apr 25, 2018

View reviewed changes

hugovk merged commit 5e1a528 into python-pillow:master Apr 25, 2018

hugovk deleted the deprecate-versions branch May 17, 2018 13:16

hugovk mentioned this pull request Jan 13, 2019

Drop support for Python 3.4? #3581

Closed

5 tasks

hugovk added the Deprecation Feature that will be removed in the future label Jan 23, 2019

marcvinyals mentioned this pull request Apr 21, 2019

Use Pillow version number fofix/fofix#185

Merged

hugovk mentioned this pull request Oct 1, 2019

Remove deprecated PILLOW_VERSION #4107

Merged

hugovk mentioned this pull request Mar 29, 2020

Re-add deprecated PILLOW_VERSION to give projects more time to upgrade #4494

Merged

Uh oh!

Conversation

hugovk commented Apr 11, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wiredfool commented Apr 11, 2018

Uh oh!

aclark4life commented Apr 11, 2018

Uh oh!

hugovk commented Apr 11, 2018 • edited by homm Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

homm Apr 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

homm commented Apr 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

homm commented Apr 22, 2018

Uh oh!

hugovk commented Apr 22, 2018

Uh oh!

aclark4life commented Apr 22, 2018

Uh oh!

hugovk commented Apr 22, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hugovk Apr 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jwilk commented Jun 1, 2018

Uh oh!

radarhere commented Jun 1, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hugovk commented Apr 11, 2018 •

edited by homm

Loading

homm Apr 15, 2018 •

edited

Loading

homm commented Apr 15, 2018 •

edited

Loading

hugovk Apr 25, 2018 •

edited

Loading