This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: pydoc should return non-zero exit code when a query is not found
Type: enhancement Stage: resolved
Components: Demos and Tools Versions: Python 3.11
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: gpanders, lukasz.langa
Priority: normal Keywords: patch

Created on 2021-08-21 03:22 by gpanders, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 27868 merged gpanders, 2021-08-21 03:23
Messages (3)
msg400012 - (view) Author: Gregory Anders (gpanders) * Date: 2021-08-21 03:22
Currently pydoc returns an exit code of zero no matter what, even with e.g.

    pydoc lsjdfkdfj

However, the ability to know whether or not pydoc successfully found a result is useful in tools that embed pydoc in some way.

Here's one use case: Vim and Neovim have a feature that allows a user to run an external command for the keyword under the cursor (keywordprg). In Python files, this defaults to pydoc. In Neovim, we would like to automatically close the PTY buffers that we create for these processes when they finish without any errors, but if it returns a non-zero exit code we want to keep the PTY buffer open so the user can see what went wrong. Because pydoc returns immediately when it fails to find a match and does not indicate that it failed via a return code, the PTY buffer is closed immediately with no indication to the user that anything went wrong.

I have a patch prepared for this that I will link to the issue.
msg400339 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-26 12:22
New changeset 8868d48712aee2b490efaf60bed8dfe9fb14d6b7 by Gregory Anders in branch 'main':
bpo-44967: pydoc: return non-zero exit code when query is not found (GH-27868)
msg400340 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-26 12:22
Thanks for the report and fix, Gregory! ✨ 🍰 ✨
Date User Action Args
2022-04-11 14:59:49adminsetgithub: 89130
2022-01-25 14:23:18iritkatriellinkissue5884 superseder
2021-08-26 12:22:34lukasz.langasetstatus: open -> closed
versions: + Python 3.11
messages: + msg400340

resolution: fixed
stage: patch review -> resolved
2021-08-26 12:22:05lukasz.langasetnosy: + lukasz.langa
messages: + msg400339
2021-08-21 03:23:41gpanderssetkeywords: + patch
stage: patch review
pull_requests: + pull_request26323
2021-08-21 03:22:27gpanderscreate