Skip to content

gh-141004: Document soft-deprecated symbols #141634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZeroIntensity merged 19 commits into from
Jan 14, 2026
Merged

gh-141004: Document soft-deprecated symbols #141634

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
596d4ec
Document soft-deprecated symbols
ZeroIntensity Nov 16, 2025
5297d4a
Add a note about completeness.
ZeroIntensity Nov 16, 2025
5559162
Fix typo.
ZeroIntensity Nov 16, 2025
5516aeb
Remove changes to stable.rst
ZeroIntensity Nov 19, 2025
d02736d
Move PyLong* symbols to long.rst
ZeroIntensity Nov 19, 2025
0d0ca9a
Document PyAsyncGenASend_CheckExact()
ZeroIntensity Nov 19, 2025
8f2e924
Document PyFile_NewStdPrinter() and PyStdPrinter_Type
ZeroIntensity Nov 19, 2025
c151684
Document PySet_MINSIZE
ZeroIntensity Nov 19, 2025
df5566c
Document the values of PyLong* macros.
ZeroIntensity Nov 19, 2025
8bcf20b
Apply suggestions from code review
ZeroIntensity Nov 19, 2025
e794b69
Update Doc/c-api/file.rst
ZeroIntensity Nov 19, 2025
9e282c6
Update Doc/c-api/long.rst
ZeroIntensity Nov 19, 2025
4d97a04
Merge branch 'main' into document-internal-symbols
ZeroIntensity Nov 20, 2025
d5e9740
Update Doc/c-api/set.rst
ZeroIntensity Nov 24, 2025
4dab332
Remove ".. deprecated"
ZeroIntensity Nov 24, 2025
d355c62
Fix trailing space
ZeroIntensity Nov 24, 2025
d6224c6
Merge branch 'main' into document-internal-symbols
ZeroIntensity Dec 4, 2025
ac40a70
Fix ignored_c_api.txt
ZeroIntensity Dec 4, 2025
35b119d
Merge branch 'main' into document-internal-symbols
ZeroIntensity Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Move PyLong* symbols to long.rst
  • Loading branch information
@ZeroIntensity
ZeroIntensity committed Nov 19, 2025
commit d02736d2114724f2a8b7b97300219c9ad549e67f
13 changes: 13 additions & 0 deletions Doc/c-api/long.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,3 +855,16 @@ The :c:type:`PyLongWriter` API can be used to import an integer.
If *writer* is ``NULL``, no operation is performed.

The writer instance and the *digits* array are invalid after the call.


Deprecated API
^^^^^^^^^^^^^^

.. c:macro:: PyLong_BASE
.. c:macro:: PyLong_SHIFT
.. c:macro:: PyLong_MASK

These macros are :term:`soft deprecated`. They represent internal constants
for :c:type:`PyLongObject` instances.

Do not use these; use :c:func:`PyLong_GetNativeLayout` instead.
Comment thread
ZeroIntensity marked this conversation as resolved.
Outdated