Skip to content

bpo-32392: Document env kwarg of subprocess.run method #7289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 5, 2018
Merged

bpo-32392: Document env kwarg of subprocess.run method #7289

merged 1 commit into from
Jun 5, 2018

Conversation

rixx
Copy link
Contributor

@rixx rixx commented May 31, 2018 •
edited by bedevere-bot
Loading

As discussed in bpo-32392, I added the env kwarg to the subprocess.run documentation.

https://bugs.python.org/issue32392

@rixx rixx requested a review from gpshead as a code owner May 31, 2018 20:20
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again to your contribution and we look forward to looking at it!

berkerpeksag
berkerpeksag requested changes Jun 1, 2018
View reviewed changes
Doc/library/subprocess.rst
@@ -39,7 +39,7 @@ compatibility with older versions, see the :ref:`call-function-trio` section.

.. function:: run(args, *, stdin=None, input=None, stdout=None, stderr=None,\
shell=False, cwd=None, timeout=None, check=False, \
encoding=None, errors=None, text=None)
encoding=None, errors=None, text=None, env=None)
Copy link
Member

Choose a reason for hiding this comment

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

Could you add a brief description of what env is? Copying the existing documentation would be enough:

   If *env* is not ``None``, it must be a mapping that defines the environment
   variables for the new process; these are used instead of the default
   behavior of inheriting the current process' environment.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@gpshead gpshead added the docs Documentation in the Doc dir label Jun 1, 2018
@rixx
Copy link
Contributor Author

rixx commented Jun 1, 2018

Thank you for your reveiw. I have made the requested changes; please review again. I've added a sentence referencing Popen so that people will be more likely to find the note attached to the env kwarg of Popen, copying it would be overkill I think.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@berkerpeksag: please review the changes made to this pull request.

@berkerpeksag
Copy link
Member

Looks good to me, thank you! I will wait until Monday to give @gpshead time to review this since he's the maintainer of the subprocess module.

@berkerpeksag berkerpeksag merged commit af1ec97 into python:master Jun 5, 2018
@miss-islington
Copy link
Contributor

Thanks @rixx for the PR, and @berkerpeksag for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@berkerpeksag
Copy link
Member

Thanks!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 5, 2018
@rixx @miss-islington
bpo-32392: Document env keyword argument of subprocess.run() (pythonG…
fa4dbcb 
…H-7289)

(cherry picked from commit af1ec97)

Co-authored-by: Tobias Kunze <[email protected]>
@bedevere-bot
Copy link

GH-7423 is a backport of this pull request to the 3.7 branch.

@miss-islington
Copy link
Contributor

Sorry, @rixx and @berkerpeksag, I could not cleanly backport this to 3.6 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker af1ec97a6d1dde68b2dc0ee9b78965eb219061a8 3.6

@berkerpeksag
Copy link
Member

@rixx would you like to submit a backport PR for 3.6?

miss-islington added a commit that referenced this pull request Jun 5, 2018
@miss-islington @rixx
bpo-32392: Document env keyword argument of subprocess.run() (GH-7289)
23b7ee2 
(cherry picked from commit af1ec97)

Co-authored-by: Tobias Kunze <[email protected]>
berkerpeksag pushed a commit to berkerpeksag/cpython that referenced this pull request Jun 7, 2018
@rixx @berkerpeksag
bpo-32392: Document env keyword argument of subprocess.run() (pythonG…
b712420 
…H-7289)

(cherry picked from commit af1ec97)

Conflicts:

	Doc/library/subprocess.rst
@bedevere-bot
Copy link

GH-7489 is a backport of this pull request to the 3.6 branch.

berkerpeksag added a commit that referenced this pull request Jun 7, 2018
@berkerpeksag
[3.6] bpo-32392: Document env keyword argument of subprocess.run() (G…
2795644 
…H-7289)

(cherry picked from commit af1ec97)

Conflicts:

	Doc/library/subprocess.rst
@rixx rixx deleted the issue-32392 branch June 7, 2018 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@berkerpeksag berkerpeksag berkerpeksag approved these changes

@gpshead gpshead Awaiting requested review from gpshead

Assignees

@berkerpeksag berkerpeksag

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@rixx @the-knights-who-say-ni @bedevere-bot @berkerpeksag @miss-islington @gpshead