bpo-42393: Raise OverflowError iso. DeprecationWarning on overflow in socket.ntohs and socket.htons (GH-23980)
This commit is contained in:
parent
9655434cca
commit
f4936ad1c4
|
@ -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;
|
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.
|
otherwise, it performs a 2-byte swap operation.
|
||||||
|
|
||||||
.. deprecated:: 3.7
|
.. versionchanged:: 3.10
|
||||||
In case *x* does not fit in 16-bit unsigned integer, but does fit in a
|
Raises :exc:`OverflowError` if *x* does not fit in a 16-bit unsigned
|
||||||
positive C int, it is silently truncated to 16-bit unsigned integer.
|
integer.
|
||||||
This silent truncation feature is deprecated, and will raise an
|
|
||||||
exception in future versions of Python.
|
|
||||||
|
|
||||||
|
|
||||||
.. function:: htonl(x)
|
.. 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;
|
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.
|
otherwise, it performs a 2-byte swap operation.
|
||||||
|
|
||||||
.. deprecated:: 3.7
|
.. versionchanged:: 3.10
|
||||||
In case *x* does not fit in 16-bit unsigned integer, but does fit in a
|
Raises :exc:`OverflowError` if *x* does not fit in a 16-bit unsigned
|
||||||
positive C int, it is silently truncated to 16-bit unsigned integer.
|
integer.
|
||||||
This silent truncation feature is deprecated, and will raise an
|
|
||||||
exception in future versions of Python.
|
|
||||||
|
|
||||||
|
|
||||||
.. function:: inet_aton(ip_string)
|
.. function:: inet_aton(ip_string)
|
||||||
|
|
|
@ -537,6 +537,12 @@ Changes in the Python API
|
||||||
silently in Python 3.9.
|
silently in Python 3.9.
|
||||||
(Contributed by Ken Jin in :issue:`42195`.)
|
(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
|
CPython bytecode changes
|
||||||
========================
|
========================
|
||||||
|
|
||||||
|
|
|
@ -1121,9 +1121,11 @@ class GeneralModuleTests(unittest.TestCase):
|
||||||
s_good_values = [0, 1, 2, 0xffff]
|
s_good_values = [0, 1, 2, 0xffff]
|
||||||
l_good_values = s_good_values + [0xffffffff]
|
l_good_values = s_good_values + [0xffffffff]
|
||||||
l_bad_values = [-1, -2, 1<<32, 1<<1000]
|
l_bad_values = [-1, -2, 1<<32, 1<<1000]
|
||||||
s_bad_values = l_bad_values + [_testcapi.INT_MIN - 1,
|
s_bad_values = (
|
||||||
_testcapi.INT_MAX + 1]
|
l_bad_values +
|
||||||
s_deprecated_values = [1<<16, _testcapi.INT_MAX]
|
[_testcapi.INT_MIN-1, _testcapi.INT_MAX+1] +
|
||||||
|
[1 << 16, _testcapi.INT_MAX]
|
||||||
|
)
|
||||||
for k in s_good_values:
|
for k in s_good_values:
|
||||||
socket.ntohs(k)
|
socket.ntohs(k)
|
||||||
socket.htons(k)
|
socket.htons(k)
|
||||||
|
@ -1136,9 +1138,6 @@ class GeneralModuleTests(unittest.TestCase):
|
||||||
for k in l_bad_values:
|
for k in l_bad_values:
|
||||||
self.assertRaises(OverflowError, socket.ntohl, k)
|
self.assertRaises(OverflowError, socket.ntohl, k)
|
||||||
self.assertRaises(OverflowError, socket.htonl, 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):
|
def testGetServBy(self):
|
||||||
eq = self.assertEqual
|
eq = self.assertEqual
|
||||||
|
|
|
@ -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
|
|
@ -6102,26 +6102,18 @@ socket_ntohs(PyObject *self, PyObject *args)
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
if (x > 0xffff) {
|
if (x > 0xffff) {
|
||||||
if (PyErr_WarnEx(PyExc_DeprecationWarning,
|
PyErr_SetString(PyExc_OverflowError,
|
||||||
"ntohs: Python int too large to convert to C "
|
"ntohs: Python int too large to convert to C "
|
||||||
"16-bit unsigned integer (The silent truncation "
|
"16-bit unsigned integer");
|
||||||
"is deprecated)",
|
|
||||||
1)) {
|
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
}
|
|
||||||
return PyLong_FromUnsignedLong(ntohs((unsigned short)x));
|
return PyLong_FromUnsignedLong(ntohs((unsigned short)x));
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(ntohs_doc,
|
PyDoc_STRVAR(ntohs_doc,
|
||||||
"ntohs(integer) -> integer\n\
|
"ntohs(integer) -> integer\n\
|
||||||
\n\
|
\n\
|
||||||
Convert a 16-bit unsigned integer from network to host byte order.\n\
|
Convert a 16-bit unsigned integer from network to host byte order.");
|
||||||
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.");
|
|
||||||
|
|
||||||
|
|
||||||
static PyObject *
|
static PyObject *
|
||||||
|
@ -6173,26 +6165,18 @@ socket_htons(PyObject *self, PyObject *args)
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
if (x > 0xffff) {
|
if (x > 0xffff) {
|
||||||
if (PyErr_WarnEx(PyExc_DeprecationWarning,
|
PyErr_SetString(PyExc_OverflowError,
|
||||||
"htons: Python int too large to convert to C "
|
"htons: Python int too large to convert to C "
|
||||||
"16-bit unsigned integer (The silent truncation "
|
"16-bit unsigned integer");
|
||||||
"is deprecated)",
|
|
||||||
1)) {
|
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
}
|
|
||||||
return PyLong_FromUnsignedLong(htons((unsigned short)x));
|
return PyLong_FromUnsignedLong(htons((unsigned short)x));
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(htons_doc,
|
PyDoc_STRVAR(htons_doc,
|
||||||
"htons(integer) -> integer\n\
|
"htons(integer) -> integer\n\
|
||||||
\n\
|
\n\
|
||||||
Convert a 16-bit unsigned integer from host to network byte order.\n\
|
Convert a 16-bit unsigned integer from host to network byte order.");
|
||||||
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.");
|
|
||||||
|
|
||||||
|
|
||||||
static PyObject *
|
static PyObject *
|
||||||
|
|
Loading…
Reference in New Issue