deprecated() function refers to past changes as if they were upcoming.

[maresb]

Description

If I run the following:

from pip._internal.utils.deprecation import deprecated

deprecated("Some reason.", "the_replacement", "10")

then I get

pip._internal.utils.deprecation.PipDeprecationWarning: DEPRECATION: Some reason. pip 10
will remove support for this functionality. A possible replacement is the_replacement.

even though the version is 21.1.3 (>10).

Expected behavior

I expect a message which uses the correct verb tense such as

pip._internal.utils.deprecation.PipDeprecationWarning: DEPRECATION: Some reason. This
behavior change has been enforced since pip 10. A possible replacement is the_replacement.

pip version

21.3

Python version

3.9.6

OS

Ubuntu 21.04

How to Reproduce

See above.

Output

No response

Code of Conduct

• I agree to follow the PSF Code of Conduct.

[uranusjr]

The deprecation warning is only intended to be used for gone_in to be later than the current version. If you call it like this, the function call would crash (which you either ignored or decided to not mention for whatever reason). I think the function as it stands if fine, although I wonuldn’t object if you submit a patch to conditionally use future tense when Version(gone_in) <= Version(pip.__version__).

[maresb]

@uranusjr, ah, okay, thanks for clarifying!

It did indeed "raise" the warning as an exception, apologies for not mentioning that detail.

I was assuming that after old functionality is deleted, the deprecation could remain in the code for some time as a helpful error message. (As a user in need of a quick fix, it would be very useful to know before which version I need to revert.)

Apologies if it seems that I ignored your suggestion not to implement. I already implemented the fix for this a week ago for #10167, but I could only test it today. I'm glad that you don't find it objectionable.

[maresb]

Closed by #10167