Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-06-28 11:50:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.15] gh-121249: Soft deprecate F and D struct format types (#149346) (#152274)

Browse source 
gh-121249: Soft deprecate F and D struct format types (#149346)

Remove F/D type codes from table in the struct module documentation.


(cherry picked from commit 5f17434a1e)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
This commit is contained in:
Victor Stinner 2026-06-26 16:26:52 +02:00 • committed by GitHub
parent f3e6bdafd2
commit f2402cba9d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Doc/deprecations/soft-deprecations.rst
View file

@ -19,3 +19,8 @@ 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`.)

11
Doc/library/struct.rst
View file

@ -260,10 +260,6 @@ platform-dependent.
+--------+--------------------------+--------------------+----------------+------------+
| ``d`` | :c:expr:`double` | float | 8 | \(4) |
+--------+--------------------------+--------------------+----------------+------------+
| ``F`` | :c:expr:`float complex` | complex | 8 | \(10) |
+--------+--------------------------+--------------------+----------------+------------+
| ``D`` | :c:expr:`double complex` | complex | 16 | \(10) |
+--------+--------------------------+--------------------+----------------+------------+
| ``Zf`` | :c:expr:`float complex` | complex | 8 | \(10) |
+--------+--------------------------+--------------------+----------------+------------+
| ``Zd`` | :c:expr:`double complex` | complex | 16 | \(10) |
@ -286,6 +282,7 @@ platform-dependent.
.. versionchanged:: 3.15
Added support for the ``'Zf'`` and ``'Zd'`` formats.
``'F'`` and ``'D'`` formats are :term:`soft deprecated`.
.. seealso::
@ -376,13 +373,15 @@ Notes:
are accepted.
(10)
For the ``'F'`` and ``'D'`` format characters, the packed representation uses
For the ``'Zf'`` and ``'Zd'`` type codes, the packed representation uses
the IEEE 754 binary32 and binary64 format for components of the complex
number, regardless of the floating-point format used by the platform.
Note that complex types (``F``/``Zf`` and ``D``/``Zd``) are available unconditionally,
Note that complex types are available unconditionally,
despite complex types being an optional feature in C.
As specified in the C11 standard, each complex type is represented by a
two-element C array containing, respectively, the real and imaginary parts.
The ``'F'`` and ``'D'`` (for ``'Zf'`` and ``'Zd'``, respectively) format
characters are supported for compatibility.
A format character may be preceded by an integral repeat count. For example,

5
Doc/whatsnew/3.15.rst
View file

@ -2280,6 +2280,11 @@ New deprecations
(Contributed by Sergey B Kirpichev and Serhiy Storchaka in :gh:`143715`.)
* Using ``'F'`` and ``'D'`` type codes now are :term:`soft deprecated`
in favor of two-letter forms ``'Zf'`` and ``'Zd'``.
(Contributed by Sergey B Kirpichev in :gh:`121249`.)
* :mod:`typing`:
* The following statements now cause ``DeprecationWarning``\ s to be emitted