[Python-checkins] bpo-42393: Raise OverflowError iso. DeprecationWarning on overflow in socket.ntohs and socket.htons (GH-23980)
serhiy-storchaka
webhook-mailer at python.org
Thu Dec 31 08:16:57 EST 2020
https://github.com/python/cpython/commit/f4936ad1c4d0ae1948e428aeddc7d3096252dae4
commit: f4936ad1c4d0ae1948e428aeddc7d3096252dae4
branch: master
author: Erlend Egeberg Aasland <erlend.aasland at innova.no>
committer: serhiy-storchaka <storchaka at gmail.com>
date: 2020-12-31T15:16:50+02:00
summary:
bpo-42393: Raise OverflowError iso. DeprecationWarning on overflow in socket.ntohs and socket.htons (GH-23980)
files:
A Misc/NEWS.d/next/Library/2020-11-17-22-06-15.bpo-42393.BB0oXc.rst
M Doc/library/socket.rst
M Doc/whatsnew/3.10.rst
M Lib/test/test_socket.py
M Modules/socketmodule.c
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 4511ff9ea4a51..2255b827aa8eb 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -907,11 +907,9 @@ The :mod:`socket` module also offers various network-related services:
where the host byte order is the same as network byte order, this is a no-op;
otherwise, it performs a 2-byte swap operation.
- .. deprecated:: 3.7
- In case *x* does not fit in 16-bit unsigned integer, but does fit in a
- positive C int, it is silently truncated to 16-bit unsigned integer.
- This silent truncation feature is deprecated, and will raise an
- exception in future versions of Python.
+ .. versionchanged:: 3.10
+ Raises :exc:`OverflowError` if *x* does not fit in a 16-bit unsigned
+ integer.
.. function:: htonl(x)
@@ -927,11 +925,9 @@ The :mod:`socket` module also offers various network-related services:
where the host byte order is the same as network byte order, this is a no-op;
otherwise, it performs a 2-byte swap operation.
- .. deprecated:: 3.7
- In case *x* does not fit in 16-bit unsigned integer, but does fit in a
- positive C int, it is silently truncated to 16-bit unsigned integer.
- This silent truncation feature is deprecated, and will raise an
- exception in future versions of Python.
+ .. versionchanged:: 3.10
+ Raises :exc:`OverflowError` if *x* does not fit in a 16-bit unsigned
+ integer.
.. function:: inet_aton(ip_string)
diff --git a/Doc/whatsnew/3.10.rst b/Doc/whatsnew/3.10.rst
index db34b33b84a49..aa547ff46481b 100644
--- a/Doc/whatsnew/3.10.rst
+++ b/Doc/whatsnew/3.10.rst
@@ -537,6 +537,12 @@ Changes in the Python API
silently in Python 3.9.
(Contributed by Ken Jin in :issue:`42195`.)
+* :meth:`socket.htons` and :meth:`socket.ntohs` now raise :exc:`OverflowError`
+ instead of :exc:`DeprecationWarning` if the given parameter will not fit in
+ a 16-bit unsigned integer.
+ (Contributed by Erlend E. Aasland in :issue:`42393`.)
+
+
CPython bytecode changes
========================
diff --git a/Lib/test/test_socket.py b/Lib/test/test_socket.py
index e4af713b4c5bf..bc280306b15d1 100755
--- a/Lib/test/test_socket.py
+++ b/Lib/test/test_socket.py
@@ -1121,9 +1121,11 @@ def testNtoHErrors(self):
s_good_values = [0, 1, 2, 0xffff]
l_good_values = s_good_values + [0xffffffff]
l_bad_values = [-1, -2, 1<<32, 1<<1000]
- s_bad_values = l_bad_values + [_testcapi.INT_MIN - 1,
- _testcapi.INT_MAX + 1]
- s_deprecated_values = [1<<16, _testcapi.INT_MAX]
+ s_bad_values = (
+ l_bad_values +
+ [_testcapi.INT_MIN-1, _testcapi.INT_MAX+1] +
+ [1 << 16, _testcapi.INT_MAX]
+ )
for k in s_good_values:
socket.ntohs(k)
socket.htons(k)
@@ -1136,9 +1138,6 @@ def testNtoHErrors(self):
for k in l_bad_values:
self.assertRaises(OverflowError, socket.ntohl, k)
self.assertRaises(OverflowError, socket.htonl, k)
- for k in s_deprecated_values:
- self.assertWarns(DeprecationWarning, socket.ntohs, k)
- self.assertWarns(DeprecationWarning, socket.htons, k)
def testGetServBy(self):
eq = self.assertEqual
diff --git a/Misc/NEWS.d/next/Library/2020-11-17-22-06-15.bpo-42393.BB0oXc.rst b/Misc/NEWS.d/next/Library/2020-11-17-22-06-15.bpo-42393.BB0oXc.rst
new file mode 100644
index 0000000000000..f291123d6dea9
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2020-11-17-22-06-15.bpo-42393.BB0oXc.rst
@@ -0,0 +1,3 @@
+Raise :exc:`OverflowError` instead of silent truncation in :meth:`socket.ntohs`
+and :meth:`socket.htons`. Silent truncation was deprecated in Python 3.7.
+Patch by Erlend E. Aasland
diff --git a/Modules/socketmodule.c b/Modules/socketmodule.c
index bb33db0fa47b8..c686286d779dc 100644
--- a/Modules/socketmodule.c
+++ b/Modules/socketmodule.c
@@ -6102,13 +6102,10 @@ socket_ntohs(PyObject *self, PyObject *args)
return NULL;
}
if (x > 0xffff) {
- if (PyErr_WarnEx(PyExc_DeprecationWarning,
- "ntohs: Python int too large to convert to C "
- "16-bit unsigned integer (The silent truncation "
- "is deprecated)",
- 1)) {
- return NULL;
- }
+ PyErr_SetString(PyExc_OverflowError,
+ "ntohs: Python int too large to convert to C "
+ "16-bit unsigned integer");
+ return NULL;
}
return PyLong_FromUnsignedLong(ntohs((unsigned short)x));
}
@@ -6116,12 +6113,7 @@ socket_ntohs(PyObject *self, PyObject *args)
PyDoc_STRVAR(ntohs_doc,
"ntohs(integer) -> integer\n\
\n\
-Convert a 16-bit unsigned integer from network to host byte order.\n\
-Note that in case the received integer does not fit in 16-bit unsigned\n\
-integer, but does fit in a positive C int, it is silently truncated to\n\
-16-bit unsigned integer.\n\
-However, this silent truncation feature is deprecated, and will raise an\n\
-exception in future versions of Python.");
+Convert a 16-bit unsigned integer from network to host byte order.");
static PyObject *
@@ -6173,13 +6165,10 @@ socket_htons(PyObject *self, PyObject *args)
return NULL;
}
if (x > 0xffff) {
- if (PyErr_WarnEx(PyExc_DeprecationWarning,
- "htons: Python int too large to convert to C "
- "16-bit unsigned integer (The silent truncation "
- "is deprecated)",
- 1)) {
- return NULL;
- }
+ PyErr_SetString(PyExc_OverflowError,
+ "htons: Python int too large to convert to C "
+ "16-bit unsigned integer");
+ return NULL;
}
return PyLong_FromUnsignedLong(htons((unsigned short)x));
}
@@ -6187,12 +6176,7 @@ socket_htons(PyObject *self, PyObject *args)
PyDoc_STRVAR(htons_doc,
"htons(integer) -> integer\n\
\n\
-Convert a 16-bit unsigned integer from host to network byte order.\n\
-Note that in case the received integer does not fit in 16-bit unsigned\n\
-integer, but does fit in a positive C int, it is silently truncated to\n\
-16-bit unsigned integer.\n\
-However, this silent truncation feature is deprecated, and will raise an\n\
-exception in future versions of Python.");
+Convert a 16-bit unsigned integer from host to network byte order.");
static PyObject *
More information about the Python-checkins
mailing list