[issue39976] Add "**other_popen_kwargs" to subprocess API signatures in docs
New submission from Nick Coghlan <ncoghlan@gmail.com>: Two of my colleagues missed the "The arguments shown above are merely the most common ones, ..." caveat on the subprocess.run documentation, and assumed that Python 3.5 only supported the "cwd" option in the low level Popen API, and not any of the higher level APIs. Something we could potential do is include a "**other_popen_kwargs" placeholder in the affected API signatures (run, call, check_call, check_output) that makes it clear there are more options beyond the explicitly listed ones. ---------- assignee: docs@python components: Documentation messages: 364295 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Add "**other_popen_kwargs" to subprocess API signatures in docs type: enhancement versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Change by Zackery Spytz <zspytz@gmail.com>: ---------- keywords: +patch nosy: +ZackerySpytz nosy_count: 2.0 -> 3.0 pull_requests: +19450 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/20145 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Chris Jerdonek <chris.jerdonek@gmail.com> added the comment: New changeset 46545000c2a30b46aed717b546bc09e5bae7148f by Zackery Spytz in branch 'master': bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145) https://github.com/python/cpython/commit/46545000c2a30b46aed717b546bc09e5bae... ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Chris Jerdonek <chris.jerdonek@gmail.com> added the comment: I'm not sure if this is worth backporting, but let me know if you think it should. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- nosy: +miss-islington nosy_count: 4.0 -> 5.0 pull_requests: +19506 pull_request: https://github.com/python/cpython/pull/20210 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +19507 pull_request: https://github.com/python/cpython/pull/20211 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Chris Jerdonek <chris.jerdonek@gmail.com> added the comment: New changeset 257e11cebde6b29177a206abd1e395367799ed42 by Miss Islington (bot) in branch '3.8': bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145) https://github.com/python/cpython/commit/257e11cebde6b29177a206abd1e39536779... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
Chris Jerdonek <chris.jerdonek@gmail.com> added the comment: New changeset 05525fff8a46f4d479cc029e4ea57b35b153f015 by Miss Islington (bot) in branch '3.7': bpo-39976: Add **other_popen_kwargs to subprocess docs (GH-20145) https://github.com/python/cpython/commit/05525fff8a46f4d479cc029e4ea57b35b15... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue39976> _______________________________________
participants (4)
-
Chris Jerdonek -
miss-islington
-
Nick Coghlan
-
Zackery Spytz