Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-92613: Deprecate other uuencode functionality per PEP 594 & document as such #92758

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

gh-92613: Deprecate other uuencode functionality per PEP 594 & document as such #92758

wants to merge 12 commits into from
+197 −45

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented May 13, 2022 •
edited

Per #92613 , for the following functionality deprecated by PEP 594 (PEP-594) but not formally implemented due to an oversight:

  • Low-level interfaces binascii.a2b_uu and binascii.b2a_uu for decoding and encoding uuencode data
  • The uu_codec binary transform in the codecs module, implementing uuencode as a Python codec
  • Support for decoding non-MIME uuencode payloads with the get_payload() method of the legacy email.message.Message (compat32) API

This PR adds missing:

  • DeprecationWarnings in the Python/C code
  • Warning checks and handling in the tests
  • Deprecation notices in the docs, and
  • A descriptive entry in the What's New for 3.11

Fixes #92613

CAM-Gerlach added 12 commits May 12, 2022
@CAM-Gerlach
pythongh-92613: Deprecate the uuencode codec in codecs
e08cfe8
@CAM-Gerlach
pythongh-92613: Silence uu-codec-related deprecation warnings in tests
86368f5
@CAM-Gerlach
pythongh-92613: Add deprecation note to codecs docs for uuencode codec
9d45e8d
@CAM-Gerlach
pythongh-92613: Deprecate built-in decoding support for uuencode in e…
5e4fa96 
…mail
@CAM-Gerlach
pythongh-92613: Silence uuencode deprecation warnings in email tests
988d387
@CAM-Gerlach
pythongh-92613: Add deprecation note for uuencode payloads to email.m…
07133d0 
…essage
@CAM-Gerlach
pythongh-92613: Add deprecation warning for binascii uuencode functions
ebab3be
@CAM-Gerlach
pythongh-92613: Silence depr warnings for binascii uuencode that alre…
05d5d54 
…ady warn
@CAM-Gerlach
pythongh-92613: Suppress binascii uuencode deprecation warnings in tests
2725eb8
@CAM-Gerlach
pythongh-92613: Add deprecation note for uuencode functions to binasc…
8fac635 
…ii docs
@CAM-Gerlach
pythongh-92613: Add What's New entry for uuencode-related deprecations
ee146e9
@CAM-Gerlach
pythongh-92613: Add News entry for uuencode deprecations
e856829
@CAM-Gerlach CAM-Gerlach requested a review from as a code owner May 13, 2022
@CAM-Gerlach CAM-Gerlach added docs stdlib 3.11 needs backport to 3.11 labels May 13, 2022
@CAM-Gerlach CAM-Gerlach requested a review from brettcannon May 13, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request May 13, 2022
Open
@CAM-Gerlach CAM-Gerlach requested review from warsaw and pablogsal May 13, 2022
@CAM-Gerlach
Copy link
Member Author

@CAM-Gerlach CAM-Gerlach commented May 13, 2022

@warsaw , I've tagged you on behalf of the email team for review of this PR's approach to handling the deprecation of uuencode in the legacy email.message.Message compat32 API, and @pablogsal , I've tagged you as release manager for 3.11, to review adding necessary deprecation messages to a couple final uuencode-related items that were explicitly slated by PEP 594 to be deprecated in 3.11 and to be removed in 3.13, and not yet formally documented as such (both per the recommendation of @brettcannon).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@python/email-team email-team

@brettcannon brettcannon

@warsaw warsaw

@pablogsal pablogsal

Assignees
No one assigned
Labels
3.11 awaiting review docs needs backport to 3.11 stdlib
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PEP 594: uuencode codec and binascii functions apparently not properly deprecated or documented as such
2 participants
@CAM-Gerlach @bedevere-bot