Skip to content

Make the crash warning in ctypes more prominent#150410

Merged
encukou merged 3 commits into
python:mainfrom
StanFromIreland:ctypes-warning
May 28, 2026
Merged

Make the crash warning in ctypes more prominent#150410
encukou merged 3 commits into
python:mainfrom
StanFromIreland:ctypes-warning

Conversation

@StanFromIreland
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland commented May 25, 2026

(I was in a warning-y mood today ;-)

I agree with Jelle:

The note you cite in the ctypes docs is buried in a section about a more specific topic (calling functions). I think it's worth adding a more prominent warning like the one on https://docs.python.org/3/library/pickle.html . However, once we do that I don't think we need to do anything in the devguide: the note in the CPython docs should be enough.

Originally posted by @JelleZijlstra in #211

@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs May 25, 2026
@StanFromIreland StanFromIreland mentioned this pull request May 25, 2026
Open
JelleZijlstra
JelleZijlstra reviewed May 25, 2026
View reviewed changes
Comment thread Doc/library/ctypes.rst Outdated
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 25, 2026 •
edited
Loading

Documentation build overview

📚 cpython-previews | 🛠️ Build #32852780 | 📁 Comparing 0b1a090 against main (c714b56)

  🔍 Preview build  

2 files changed
± library/ctypes.html
± whatsnew/changelog.html

JelleZijlstra
JelleZijlstra approved these changes May 25, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this wording! Please leave this open for a little bit to give others a chance to comment though.

encukou
encukou reviewed May 26, 2026
View reviewed changes
Comment thread Doc/library/ctypes.rst Outdated
@StanFromIreland @encukou
Apply Petr's suggestion(s)
0b1a090 
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@StanFromIreland StanFromIreland requested a review from encukou May 26, 2026 12:51
ncoghlan
ncoghlan approved these changes May 27, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, too!

@JelleZijlstra JelleZijlstra added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels May 27, 2026
@encukou encukou merged commit b53f6ca into python:main May 28, 2026
36 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs May 28, 2026
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented May 28, 2026

Thanks @StanFromIreland for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 28, 2026

GH-150547 is a backport of this pull request to the 3.15 branch.

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented May 28, 2026

Sorry, @StanFromIreland and @encukou, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b53f6ca850b500621474e82931c3e7216d9a1cb1 3.13

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 28, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 28, 2026

GH-150548 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label May 28, 2026
encukou added a commit that referenced this pull request May 28, 2026
@miss-islington @StanFromIreland @encukou
[3.15] Add prominent crash warning to ctypes docs (GH-150410) (GH-1…
0e08bba 
…50547)

(cherry picked from commit b53f6ca)

Co-authored-by: Stan Ulbrych <stan@python.org>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
encukou added a commit that referenced this pull request May 28, 2026
@miss-islington @StanFromIreland @encukou
[3.14] Add prominent crash warning to ctypes docs (GH-150410) (GH-1…
e4a23c8 
…50548)

(cherry picked from commit b53f6ca)

Co-authored-by: Stan Ulbrych <stan@python.org>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@StanFromIreland StanFromIreland deleted the ctypes-warning branch May 28, 2026 11:48
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented May 28, 2026

GH-150556 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label May 28, 2026
StanFromIreland added a commit that referenced this pull request May 28, 2026
@StanFromIreland @encukou
[3.13] Add a prominent crash warning to the ctypes docs (GH-150410)
8603881 
(cherry picked from commit b53f6ca)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukou encukou encukou approved these changes

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@ncoghlan ncoghlan ncoghlan approved these changes

Assignees

@encukou encukou

Labels

docs Documentation in the Doc dir skip issue skip news topic-ctypes

Projects

Ctypes issues
Status: Done
Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@StanFromIreland @encukou @JelleZijlstra @ncoghlan