summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2023-05-25 14:25:27 (GMT)
committerGitHub <noreply@github.com>2023-05-25 14:25:27 (GMT)
commitdbc8216f4c00ea40b0c2d3ca487e5afeb4b0e0b1 (patch)
tree87054aa8f6853402fadad273a071839e88aaeced /Doc
parente4127eaa1ea9104be0a1d9d9e147d50ba88f59aa (diff)
downloadcpython-dbc8216f4c00ea40b0c2d3ca487e5afeb4b0e0b1.zip
cpython-dbc8216f4c00ea40b0c2d3ca487e5afeb4b0e0b1.tar.gz
cpython-dbc8216f4c00ea40b0c2d3ca487e5afeb4b0e0b1.tar.bz2
gh-104773: PEP 594: Remove the uu module (#104932)
Doc/license.rst: Keep the UUencode and UUdecode license since it's also used by the uu codec.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/binascii.rst6
-rw-r--r--Doc/library/superseded.rst1
-rw-r--r--Doc/library/uu.rst72
-rw-r--r--Doc/license.rst2
-rw-r--r--Doc/whatsnew/3.11.rst2
-rw-r--r--Doc/whatsnew/3.12.rst2
-rw-r--r--Doc/whatsnew/3.13.rst4
-rw-r--r--Doc/whatsnew/3.7.rst2
8 files changed, 9 insertions, 82 deletions
diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst
index 21960cb..e9f6f0e 100644
--- a/Doc/library/binascii.rst
+++ b/Doc/library/binascii.rst
@@ -6,14 +6,13 @@
representations.
.. index::
- pair: module; uu
pair: module; base64
--------------
The :mod:`binascii` module contains a number of methods to convert between
binary and various ASCII-encoded binary representations. Normally, you will not
-use these functions directly but use wrapper modules like :mod:`uu` or
+use these functions directly but use wrapper modules like
:mod:`base64` instead. The :mod:`binascii` module contains
low-level functions written in C for greater speed that are used by the
higher-level modules.
@@ -179,8 +178,5 @@ The :mod:`binascii` module defines the following functions:
Support for RFC compliant base64-style encoding in base 16, 32, 64,
and 85.
- Module :mod:`uu`
- Support for UU encoding used on Unix.
-
Module :mod:`quopri`
Support for quoted-printable encoding used in MIME email messages.
diff --git a/Doc/library/superseded.rst b/Doc/library/superseded.rst
index 284716e..7e05f0e 100644
--- a/Doc/library/superseded.rst
+++ b/Doc/library/superseded.rst
@@ -15,4 +15,3 @@ backwards compatibility. They have been superseded by other modules.
chunk.rst
imghdr.rst
optparse.rst
- uu.rst
diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst
deleted file mode 100644
index 83c4aec..0000000
--- a/Doc/library/uu.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-:mod:`uu` --- Encode and decode uuencode files
-==============================================
-
-.. module:: uu
- :synopsis: Encode and decode files in uuencode format.
- :deprecated:
-
-.. moduleauthor:: Lance Ellinghouse
-
-**Source code:** :source:`Lib/uu.py`
-
-.. deprecated-removed:: 3.11 3.13
- The :mod:`uu` module is deprecated
- (see :pep:`PEP 594 <594#uu-and-the-uu-encoding>` for details).
- :mod:`base64` is a modern alternative.
-
---------------
-
-This module encodes and decodes files in uuencode format, allowing arbitrary
-binary data to be transferred over ASCII-only connections. Wherever a file
-argument is expected, the methods accept a file-like object. For backwards
-compatibility, a string containing a pathname is also accepted, and the
-corresponding file will be opened for reading and writing; the pathname ``'-'``
-is understood to mean the standard input or output. However, this interface is
-deprecated; it's better for the caller to open the file itself, and be sure
-that, when required, the mode is ``'rb'`` or ``'wb'`` on Windows.
-
-.. index::
- single: Jansen, Jack
- single: Ellinghouse, Lance
-
-This code was contributed by Lance Ellinghouse, and modified by Jack Jansen.
-
-The :mod:`uu` module defines the following functions:
-
-
-.. function:: encode(in_file, out_file, name=None, mode=None, *, backtick=False)
-
- Uuencode file *in_file* into file *out_file*. The uuencoded file will have
- the header specifying *name* and *mode* as the defaults for the results of
- decoding the file. The default defaults are taken from *in_file*, or ``'-'``
- and ``0o666`` respectively. If *backtick* is true, zeros are represented by
- ``'`'`` instead of spaces.
-
- .. versionchanged:: 3.7
- Added the *backtick* parameter.
-
-
-.. function:: decode(in_file, out_file=None, mode=None, quiet=False)
-
- This call decodes uuencoded file *in_file* placing the result on file
- *out_file*. If *out_file* is a pathname, *mode* is used to set the permission
- bits if the file must be created. Defaults for *out_file* and *mode* are taken
- from the uuencode header. However, if the file specified in the header already
- exists, a :exc:`uu.Error` is raised.
-
- :func:`decode` may print a warning to standard error if the input was produced
- by an incorrect uuencoder and Python could recover from that error. Setting
- *quiet* to a true value silences this warning.
-
-
-.. exception:: Error()
-
- Subclass of :exc:`Exception`, this can be raised by :func:`uu.decode` under
- various situations, such as described above, but also including a badly
- formatted header, or truncated input file.
-
-
-.. seealso::
-
- Module :mod:`binascii`
- Support module containing ASCII-to-binary and binary-to-ASCII conversions.
diff --git a/Doc/license.rst b/Doc/license.rst
index 947a9b1..4b7113b 100644
--- a/Doc/license.rst
+++ b/Doc/license.rst
@@ -476,7 +476,7 @@ The :mod:`trace` module contains the following notice::
UUencode and UUdecode functions
-------------------------------
-The :mod:`uu` module contains the following notice::
+The ``uu`` codec contains the following notice::
Copyright 1994 by Lance Ellinghouse
Cathedral City, California Republic, United States of America.
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index efff132..ece273c 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -1733,7 +1733,7 @@ Modules
+---------------------+---------------------+---------------------+---------------------+---------------------+
| :mod:`aifc` | :mod:`chunk` | :mod:`!msilib` | :mod:`!pipes` | :mod:`!telnetlib` |
+---------------------+---------------------+---------------------+---------------------+---------------------+
- | :mod:`audioop` | :mod:`!crypt` | :mod:`!nis` | :mod:`!sndhdr` | :mod:`uu` |
+ | :mod:`audioop` | :mod:`!crypt` | :mod:`!nis` | :mod:`!sndhdr` | :mod:`!uu` |
+---------------------+---------------------+---------------------+---------------------+---------------------+
| :mod:`!cgi` | :mod:`imghdr` | :mod:`!nntplib` | :mod:`!spwd` | :mod:`!xdrlib` |
+---------------------+---------------------+---------------------+---------------------+---------------------+
diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
index f01cc27..7c18406 100644
--- a/Doc/whatsnew/3.12.rst
+++ b/Doc/whatsnew/3.12.rst
@@ -935,7 +935,7 @@ Modules (see :pep:`594`):
* :mod:`!spwd`
* :mod:`!sunau`
* :mod:`!telnetlib`
-* :mod:`uu`
+* :mod:`!uu`
* :mod:`!xdrlib`
APIs:
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index f570e03..38526e1 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -217,6 +217,10 @@ Removed
(Contributed by Victor Stinner in :gh:`104773`.)
+* :pep:`594`: Remove the :mod:`!uu` module, deprecated in Python 3.11:
+ the :mod:`base64` module is a modern alternative.
+ (Contributed by Victor Stinner in :gh:`104773`.)
+
Porting to Python 3.13
======================
diff --git a/Doc/whatsnew/3.7.rst b/Doc/whatsnew/3.7.rst
index 93915b2..fa89b7d 100644
--- a/Doc/whatsnew/3.7.rst
+++ b/Doc/whatsnew/3.7.rst
@@ -1547,7 +1547,7 @@ adding ``~`` to the set of characters that are never quoted by default.
uu
--
-The :func:`uu.encode` function now accepts an optional *backtick*
+The :func:`!uu.encode` function now accepts an optional *backtick*
keyword argument. When it's true, zeros are represented by ``'`'``
instead of spaces. (Contributed by Xiang Zhang in :issue:`30103`.)