summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2020-01-22 19:44:22 (GMT)
committerGitHub <noreply@github.com>2020-01-22 19:44:22 (GMT)
commitbeea26b57e8c80f1eff0f967a0f9d083a7dc3d66 (patch)
tree473ad7cfdd3e65177dc7e392152759bba38e5826 /Doc
parent14d80d0b605d8b148e14458e4c1853a940071462 (diff)
downloadcpython-beea26b57e8c80f1eff0f967a0f9d083a7dc3d66.zip
cpython-beea26b57e8c80f1eff0f967a0f9d083a7dc3d66.tar.gz
cpython-beea26b57e8c80f1eff0f967a0f9d083a7dc3d66.tar.bz2
bpo-39353: Deprecate the binhex module (GH-18025)
Deprecate binhex4 and hexbin4 standards. Deprecate the binhex module and the following binascii functions: * b2a_hqx(), a2b_hqx() * rlecode_hqx(), rledecode_hqx() * crc_hqx()
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/binascii.rst10
-rw-r--r--Doc/library/binhex.rst2
-rw-r--r--Doc/whatsnew/3.9.rst10
3 files changed, 22 insertions, 0 deletions
diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst
index 98d8679..aa2a270 100644
--- a/Doc/library/binascii.rst
+++ b/Doc/library/binascii.rst
@@ -92,6 +92,8 @@ The :mod:`binascii` module defines the following functions:
The string should contain a complete number of binary bytes, or (in case of the
last portion of the binhex4 data) have the remaining bits zero.
+ .. deprecated:: 3.9
+
.. function:: rledecode_hqx(data)
@@ -104,11 +106,15 @@ The :mod:`binascii` module defines the following functions:
.. versionchanged:: 3.2
Accept only bytestring or bytearray objects as input.
+ .. deprecated:: 3.9
+
.. function:: rlecode_hqx(data)
Perform binhex4 style RLE-compression on *data* and return the result.
+ .. deprecated:: 3.9
+
.. function:: b2a_hqx(data)
@@ -116,6 +122,8 @@ The :mod:`binascii` module defines the following functions:
argument should already be RLE-coded, and have a length divisible by 3 (except
possibly the last fragment).
+ .. deprecated:: 3.9
+
.. function:: crc_hqx(data, value)
@@ -124,6 +132,8 @@ The :mod:`binascii` module defines the following functions:
*x*:sup:`16` + *x*:sup:`12` + *x*:sup:`5` + 1, often represented as
0x1021. This CRC is used in the binhex4 format.
+ .. deprecated:: 3.9
+
.. function:: crc32(data[, value])
diff --git a/Doc/library/binhex.rst b/Doc/library/binhex.rst
index 2966e0d..7de6a66 100644
--- a/Doc/library/binhex.rst
+++ b/Doc/library/binhex.rst
@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/binhex.py`
+.. deprecated:: 3.9
+
--------------
This module encodes and decodes files in binhex4 format, a format allowing
diff --git a/Doc/whatsnew/3.9.rst b/Doc/whatsnew/3.9.rst
index 00341ef..0e82ff0 100644
--- a/Doc/whatsnew/3.9.rst
+++ b/Doc/whatsnew/3.9.rst
@@ -353,6 +353,16 @@ Deprecated
deprecated and will be removed in version 3.11.
(Contributed by Yury Selivanov and Kyle Stanley in :issue:`34790`.)
+* binhex4 and hexbin4 standards are now deprecated. The :`binhex` module
+ and the following :mod:`binascii` functions are now deprecated:
+
+ * :func:`~binascii.b2a_hqx`, :func:`~binascii.a2b_hqx`
+ * :func:`~binascii.rlecode_hqx`, :func:`~binascii.rledecode_hqx`
+ * :func:`~binascii.crc_hqx`
+
+ (Contributed by Victor Stinner in :issue:`39353`.)
+
+
Removed
=======