[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: Calling this one done - any further adjustments can be handled as new tracker issues. -- resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed ___ Python tracker

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: Well, that forward port was definitely more complicated than I expected. Additional reviews of both 3.2 and 3.3 (i.e. default) would be appreciated - there were quite a few adjustments needed to cope with changes between 2.7 and 3.2 and then additional changes

[issue13237] subprocess docs should emphasise convenience functions

Roundup Robot added the comment: New changeset e929d2a96d9b by Nick Coghlan in branch '3.2': Issue #13237: Forward port subprocess module updates and explicitly document UTF-8 encoding assumption when universal_newlines=True http://hg.python.org/cpython/rev/e929d2a96d9b New changeset d3b159c43

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: As the last checkin message says, I've made the documentation for the helper functions more self-contained. Each now has its own short "shell=True" warning with a pointer to the full explanation in the shared parameter description. There was also a copy-and-pas

[issue13237] subprocess docs should emphasise convenience functions

Roundup Robot added the comment: New changeset 2a2df6a72ccb by Nick Coghlan in branch '2.7': Issue #13237: Make the subprocess convenience helper documentation self-contained aside from the shared parameter description. Downgrade the pipe warnings at that level to notes (since those pipes are

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: We can only protect people from themselves so much - "shell=True" is invaluable when you actually want to invoke the shell, and the shell has much better tools for process invocation and pipeline processing than Python does (since shells are, in effect, domain

[issue13237] subprocess docs should emphasise convenience functions

Ezio Melotti added the comment: I think Éric is referring to the foo(bar, *, baz=None) syntax. In 2.7 you can drop the '*' and still leave only the keyword arguments that you think are more useful. I also see that you converted a few examples to use shell=True, but afaiu that should be avoid

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: That's deliberate, as I'm only showing a selected subset of the full signature at that point and using the subprocess API's with positional arguments would lead to almost incomprehensible code. I'm not in any great hurry to forward port though, so I'm happy to wai

[issue13237] subprocess docs should emphasise convenience functions

Éric Araujo added the comment: I want to review the doc, but lack time right now. For example, one function signature in your patch uses keyword-only arguments but 2.7 doesn’t support them. -- ___ Python tracker

[issue13237] subprocess docs should emphasise convenience functions

Roundup Robot added the comment: New changeset 5dfe6d7f7c61 by Nick Coghlan in branch '2.7': Issue #13237: fix typo http://hg.python.org/cpython/rev/5dfe6d7f7c61 -- ___ Python tracker _

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: Absent any further feedback, I think I'm done with the changes to the 2.7 subprocess docs. I'll let them sit for a few days, then do the forward port to 3.2 and default. There are a couple of additional changes I'll add to the 3.x versions: - mention redirectin

[issue13237] subprocess docs should emphasise convenience functions

Roundup Robot added the comment: New changeset f445c125aca3 by Nick Coghlan in branch '2.7': Issue #13237: remove some details that only apply to the 3.x version of this module and cross reference the relocated warning about the dangers of invoking the shell with untrusted input http://hg.pyth

[issue13237] subprocess docs should emphasise convenience functions

Roundup Robot added the comment: New changeset 0b4df6701c4d by Nick Coghlan in branch '2.7': Issue #13237: further updates to subprocess documentation http://hg.python.org/cpython/rev/0b4df6701c4d -- ___ Python tracker

[issue13237] subprocess docs should emphasise convenience functions

Changes by Nick Coghlan : -- assignee: docs@python -> ncoghlan ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: I'm reasonably happy with the changes I just checked in, but rather than doing multiple forward ports, my plan is to let them settle for a while, update them based on any feedback I get, then incorporate the final version into the 3.x series. -- _

[issue13237] subprocess docs should emphasise convenience functions

Roundup Robot added the comment: New changeset 2184df0e0f89 by Nick Coghlan in branch '2.7': Issue #13237: Rearrange subprocess module documentation to emphasise the convenience functions and commonly needed arguments http://hg.python.org/cpython/rev/2184df0e0f89 -- nosy: +python-dev

[issue13237] subprocess docs should emphasise convenience functions

Changes by Éric Araujo : -- nosy: +eric.araujo ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pyth

[issue13237] subprocess docs should emphasise convenience functions

Ezio Melotti added the comment: Yep, what I was suggesting was an easier approach, but if someone is willing to reorganize the document, I agree that is better to start with an example that shows the most common use cases with the convenience functions and then gradually explain the convenien

[issue13237] subprocess docs should emphasise convenience functions

Nick Coghlan added the comment: You couldn't just move them - you'd need to change the wording of how they cross-link to each other, since the explanations of the convenience function currently assume you understand how Popen works. I'd like us to get to the point where you only need to under

[issue13237] subprocess docs should emphasise convenience functions

Ezio Melotti added the comment: >From a quick look it seems to me that only - output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0] + output = check_output(["mycmd", "myarg"]) can be changed. Most of the other example access attributes of the Popen objects, such as stdin/stdout

[issue13237] subprocess docs should emphasise convenience functions

Changes by Florent Xicluna : -- nosy: +flox type: -> behavior ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue13237] subprocess docs should emphasise convenience functions

Raymond Hettinger added the comment: +1 -- nosy: +rhettinger ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: h

[issue13237] subprocess docs should emphasise convenience functions

Changes by Nick Coghlan : -- title: subprocess docs should use emphasise convenience functions -> subprocess docs should emphasise convenience functions ___ Python tracker ___ _