FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-121249: Deprecate using F/D type codes in the struct module by skirpichev · Pull Request #152309 · python/cpython · GitHub

/ cpython Public
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .c  (1) .py  (3) .rst  (5) All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
6 changes: 6 additions & 0 deletions Doc/deprecations/pending-removal-in-3.21.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,9 @@ Pending removal in Python 3.21
are not generated by the parser or accepted by the code generator.
* The ``dims`` property of ``ast.Tuple`` will be removed in Python 3.21. Use
the ``ast.Tuple.elts`` property instead.

* :mod:`struct`:

* Soft-deprecated since Python 3.15, using ``'F'`` and ``'D'`` type codes are now
deprecated. These codes will be removed in Python 3.21. Use instead
two-letter forms ``'Zf'`` and ``'Zd'``.
5 changes: 0 additions & 5 deletions Doc/deprecations/soft-deprecations.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,3 @@ There are no plans to remove :term:`soft deprecated` APIs.

(Contributed by Gregory P. Smith in :gh:`86519` and
Hugo van Kemenade in :gh:`148100`.)

* Using ``'F'`` and ``'D'`` format type codes of the :mod:`struct` module
now are :term:`soft deprecated` in favor of two-letter forms ``'Zf'``
and ``'Zd'``.
(Contributed by Sergey B Kirpichev in :gh:`121249`.)
4 changes: 3 additions & 1 deletion Doc/library/struct.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,9 @@ platform-dependent.

.. versionchanged:: 3.15
Added support for the ``'Zf'`` and ``'Zd'`` formats.
``'F'`` and ``'D'`` formats are :term:`soft deprecated`.

.. versionchanged:: 3.16
``'F'`` and ``'D'`` formats are deprecated.

.. seealso::

Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.16.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,13 @@ New deprecations
3.9, now issues a deprecation warning on use. This property is slated for
removal in 3.21. Use ``ast.Tuple.elts`` instead.

* :mod:`struct`:

* Soft-deprecated since Python 3.15, using ``'F'`` and ``'D'`` type codes are now
deprecated. These codes will be removed in Python 3.21. Use instead
Comment thread
skirpichev marked this conversation as resolved.
two-letter forms ``'Zf'`` and ``'Zd'``.
(Contributed by Sergey B Kirpichev in :gh:`121249`.)

.. Add deprecations above alphabetically, not here at the end.

.. include:: ../deprecations/pending-removal-in-3.17.rst
Expand Down
12 changes: 6 additions & 6 deletions Lib/test/test_ctypes/test_byteswap.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,14 @@ def test_endian_float_complex(self):
self.assertIs(c_float_complex.__ctype_le__.__ctype_be__,
c_float_complex)
s = c_float_complex(math.pi+1j)
self.assertEqual(bin(struct.pack("F", math.pi+1j)), bin(s))
self.assertEqual(bin(struct.pack("Zf", math.pi+1j)), bin(s))
self.assertAlmostEqual(s.value, math.pi+1j, places=6)
s = c_float_complex.__ctype_le__(math.pi+1j)
self.assertAlmostEqual(s.value, math.pi+1j, places=6)
self.assertEqual(bin(struct.pack("<F", math.pi+1j)), bin(s))
self.assertEqual(bin(struct.pack("<Zf", math.pi+1j)), bin(s))
s = c_float_complex.__ctype_be__(math.pi+1j)
self.assertAlmostEqual(s.value, math.pi+1j, places=6)
self.assertEqual(bin(struct.pack(">F", math.pi+1j)), bin(s))
self.assertEqual(bin(struct.pack(">Zf", math.pi+1j)), bin(s))

@unittest.skipUnless(hasattr(ctypes, 'c_double_complex'), "No complex types")
def test_endian_double_complex(self):
Expand All @@ -199,14 +199,14 @@ def test_endian_double_complex(self):
self.assertIs(c_double_complex.__ctype_le__.__ctype_be__,
c_double_complex)
s = c_double_complex(math.pi+1j)
self.assertEqual(bin(struct.pack("D", math.pi+1j)), bin(s))
self.assertEqual(bin(struct.pack("Zd", math.pi+1j)), bin(s))
self.assertAlmostEqual(s.value, math.pi+1j, places=6)
s = c_double_complex.__ctype_le__(math.pi+1j)
self.assertAlmostEqual(s.value, math.pi+1j, places=6)
self.assertEqual(bin(struct.pack("<D", math.pi+1j)), bin(s))
self.assertEqual(bin(struct.pack("<Zd", math.pi+1j)), bin(s))
s = c_double_complex.__ctype_be__(math.pi+1j)
self.assertAlmostEqual(s.value, math.pi+1j, places=6)
self.assertEqual(bin(struct.pack(">D", math.pi+1j)), bin(s))
self.assertEqual(bin(struct.pack(">Zd", math.pi+1j)), bin(s))

def test_endian_other(self):
self.assertIs(c_byte.__ctype_le__, c_byte)
Expand Down
4 changes: 2 additions & 2 deletions Lib/test/test_memoryview.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -717,8 +717,8 @@ def test_half_float(self):
self.assertListEqual(half_view.tolist(), float_view.tolist())

def test_complex_types(self):
float_complex_data = struct.pack('FFF', 0.0, -1.5j, 1+2j)
double_complex_data = struct.pack('DDD', 0.0, -1.5j, 1+2j)
float_complex_data = struct.pack('ZfZfZf', 0.0, -1.5j, 1+2j)
double_complex_data = struct.pack('ZdZdZd', 0.0, -1.5j, 1+2j)
float_complex_view = memoryview(float_complex_data).cast('Zf')
double_complex_view = memoryview(double_complex_data).cast('Zd')
self.assertEqual(float_complex_view.nbytes * 2, double_complex_view.nbytes)
Expand Down
23 changes: 18 additions & 5 deletions Lib/test/test_struct.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import unittest
import struct
import sys
import warnings
import weakref

from test import support
Expand Down Expand Up @@ -995,14 +996,26 @@ def test_c_complex_round_trip(self):
values = [complex(*_) for _ in combinations([1, -1, 0.0, -0.0, 2,
-3, INF, -INF, NAN], 2)]
for z in values:
for f in [
'F', 'D', 'Zf', 'Zd',
'>F', '>D', '>Zf', '>Zd',
'<F', '<D', '<Zf', '<Zd',
]:
for f in ['Zf', 'Zd', '>Zf', '>Zd', '<Zf', '<Zd']:
with self.subTest(z=z, format=f):
round_trip = struct.unpack(f, struct.pack(f, z))[0]
self.assertComplexesAreIdentical(z, round_trip)
z = 1+1j
for fmt in ['F', 'D', '>F', '>D', '<F', '<D']:
with self.subTest(format=fmt):
with warnings.catch_warnings():
warnings.simplefilter("error", DeprecationWarning)
self.assertRaises(DeprecationWarning, struct.pack, fmt, z)
with warnings.catch_warnings():
with self.assertWarns(DeprecationWarning):
b = struct.pack(fmt, z)

with warnings.catch_warnings():
warnings.simplefilter("error", DeprecationWarning)
self.assertRaises(DeprecationWarning, struct.unpack, fmt, b)
with self.assertWarns(DeprecationWarning):
round_trip = struct.unpack(fmt, b)[0]
self.assertComplexesAreIdentical(z, round_trip)

@unittest.skipIf(
support.is_android or support.is_apple_mobile,
Expand Down
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Deprecate using ``'F'`` and ``'D'`` type codes in the :mod:`struct` module.
29 changes: 29 additions & 0 deletions Modules/_struct.c
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -1697,6 +1697,21 @@ prepare_s(PyStructObject *self, PyObject *format)
if (e == NULL)
return -1;

if (strcmp(e->format, "F") == 0) {
if (PyErr_WarnEx(PyExc_DeprecationWarning,
"The 'F' type code is deprecated, use 'Zf'", 1))
{
return -1;
}
}
if (strcmp(e->format, "D") == 0) {
if (PyErr_WarnEx(PyExc_DeprecationWarning,
"The 'D' type code is deprecated, use 'Zd'", 1))
{
return -1;
}
}

switch (c) {
case 's': _Py_FALLTHROUGH;
case 'p':
Expand Down Expand Up @@ -2065,6 +2080,20 @@ s_unpack_internal(PyStructObject *soself, const char *startfrom,
}
v = PyBytes_FromStringAndSize(res + 1, n);
} else {
if (strcmp(e->format, "F") == 0) {
if (PyErr_WarnEx(PyExc_DeprecationWarning,
"The 'F' type code is deprecated, use 'Zf'", 1))
{
goto fail;
}
}
if (strcmp(e->format, "D") == 0) {
if (PyErr_WarnEx(PyExc_DeprecationWarning,
"The 'D' type code is deprecated, use 'Zd'", 1))
{
goto fail;
}
}
v = e->unpack(state, res, e);
}
if (v == NULL)
Expand Down
Loading

Back | FazBrowse Home | New Git URL