[Doc]: PyOS_InputHook documentation is incorrect #32314

Activity

1. iccir

   added

   Documentation

   Documentation: user guidefiles in galleries/users_explain or doc/usersfiles in galleries/users_explain or doc/users

   on Sep 7, 2026
2. tacaswell commented on Sep 9, 2026

   

   tacaswell

   on Sep 9, 2026

   Member

   More actions

   Sigh, I both wrote those docs and merged that PR.

   I'll put in a quick fix for the docs, but given your work on overhauling the mac backend it is worth considering how to manage installing the hook better. One of the reasons we went with "just install it" is that to our understanding you could not use the old mac backend for embedding in bigger UIs so the range of other things people might have been doing was smaller so the "make it nice for the user in the prompt" seemed like a big upside with no downside.

   The key distinction between the mac backend (and maybe webagg, but that has no reasonable shell story) and everything else is that we own the code from the python <-> toolkit binding where as with with everything else than binding comes from a dependency. In those case it is fair to expect someone else to do the hook management.

   👍React with 👍1Reacted by Ricci Adams
3. iccir commented on Sep 9, 2026

   

   iccir

   on Sep 9, 2026

   ContributorAuthor

   More actions

   One of the reasons we went with "just install it" is that to our understanding you could not use the old mac backend for embedding in bigger UIs so the range of other things people might have been doing was smaller so the "make it nice for the user in the prompt" seemed like a big upside with no downside.

   That makes sense, from my (still limited) understanding of how PyOS_InputHook works. What we should do is:

   1. By default, install our PyOS_InputHook if we detect that we are also instantiating the NSApplication singleton and our own MPLAppDelegate. That's the "make it nice for the user in the prompt" default case.
   2. If you are embedding us, we won't instantiate NSApplication, MPLAppDelegate, or touch PyOS_InputHook - although we could have an API that allows some control over this.
4. tacaswell commented on Sep 9, 2026

   

   tacaswell

   on Sep 9, 2026

   Member

   More actions

   That seems correct. We should also not clobber anything already installed.

   Following the pattern of PyQt is probably the right model for any extra API we want to add.
5. tacaswell

   added this to the v3.11-doc milestone on Sep 9, 2026
6. QuLogic

   closed this as completedin #32321on Sep 9, 2026
7. QuLogic

   added a commit that references this issue on Sep 9, 2026

   DOC: correct note about PyOS_InputHook

   ...

   This issue will close once commit 4b64fe2 is merged into the 'main' branch.

   4b64fe2