Repository navigation
PEP 594: uuencode codec and binascii functions apparently not properly deprecated or documented as such #92613
Description
Activity
Probably just an oversight, although not a critical one.
Still, one that should be corrected, since per PEP 387 (PEP-387), in order to be removed, any APIs must raise a deprecation warning (and be documented as such) for at least two releases, and their deprecation is also explicitly specified per PEP 594.
Raising a
DeprecationWarningon use of the codec is straightforward (since it can use the same function as the rest, presumably), as are the docs changes, but what about the twobinasciifunctions are part of an extension module written in C? I'm not familiar with standard practice there, and I wasn't able to easily find existing examples or devguide guidance on this issue, (though its entirely possible I missed it), so I'd appreciate your advice on this.Also, I presume this can still get landed in 3.11, since otherwise they would block
uu's removal for another release, but can/should the docs deprecation notices also be backported like the module-level ones (presumably without the version), or no?Raising a
DeprecationWarningon use of the codec is straightforward (since it can use the same function as the rest, presumably), as are the docs changes, but what about the twobinasciifunctions are part of an extension module written in C?Here's an example from https://github.com/python/cpython/pull/91846/files:
PyMODINIT_FUNC PyInit_spwd(void) { if (PyErr_WarnEx(PyExc_DeprecationWarning, "'spwd' is deprecated and slated for removal in " "Python 3.13", 7)) { return NULL; }
Some more:
Reacted by C.A.M. GerlachStill, one that should be corrected
Yep, I'm just saying I don't have the time to do it myself.
since per PEP 387 (PEP-387), in order to be removed, any APIs must raise a deprecation warning (and be documented as such) for at least two releases
As co-author of the PEP, I'm aware. 😉
Also, I presume this can still get landed in 3.11, since otherwise they would block
uu's removal for another releaseThat's a question for @pablogsal
but can/should the docs deprecation notices also be backported like the module-level ones (presumably without the version), or no?
No as it's too small of a deprecation.
I'm partway through implementing this (most of the work is just silencing the warnings in the tests).
BTW, I noticed one other minor use of
uutoo small to be noted in the PEP—its not mentioned in the documentation, but the uu decode function is also called to decode uuencoded attachments of (ancient, pre-MIME) emails, so a DeprecationWarning and docs note can be added there as well, to identify any unexpected user impacts.Yep, I'm just saying I don't have the time to do it myself.
Yep, I assumed you'd have more important things to do, heh, so I assigned myself here.
As co-author of the PEP, I'm aware. 😉
I'd almost said "your PEP 387", but double-checked and noticed you were the
PEP-Delegate, not an author (which would be a COI)That's a question for @pablogsal
Is there something specific I need to do to apply for/justify an exception on this, or do we just wait for Pablo to respond here? I know release managers are very busy people...
No as it's too small of a deprecation.
👍
45 remaining items
- added a commit that references this issue
on Aug 11, 2022 - added 11 commits that reference this issue
on Nov 8, 2022 Is binascii.b2a_uu deprecated? If so, it would be nice to see this when reading the documentation. I recently wrote a script that will use it, without being aware of this push for deprecation. The PEP does not say any binascii functions will be deprecated; it only mentions deprecating the uu module, and encodings/uu_codec.py.
@warsaw should we move forward w/ this deprecation or drop it?
As referred to in #92611 , PEP 594 (PEP-594) states that the
uuencode/decode-related functions in thebinasciimodule, as well as theuucodec will be deprecated in Python 3.11 and removed in Python 3.13:However, as far as I can tell, those deprecations are neither implemented with warnings in uu_codec.py or binascii (although I'm not sure what a deprecation warning at the C level that should appear at the Python level is actually supposed to look like) nor are they documented in the respective uu codec or binascii documentation sections.
Is this intentional. If not, shouldn't we get these in for 3.11?
@brettcannon @tiran