Skip to content
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

Docs: asyncio.loop.subprocess_exec documentation is confusing, it's not clear how to inherit stdin, stdout or stderr in the subprocess #80867

Closed
sbstp mannequin opened this issue Apr 21, 2019 · 4 comments
Closed

Docs: asyncio.loop.subprocess_exec documentation is confusing, it's not clear how to inherit stdin, stdout or stderr in the subprocess #80867

sbstp mannequin opened this issue Apr 21, 2019 · 4 comments
Labels
3.8 only security fixes topic-asyncio

Comments

@sbstp
Copy link
Mannequin

sbstp mannequin commented Apr 21, 2019

BPO 36686
Nosy @asvetlov, @1st1, @sbstp, @miss-islington
PRs
  • bpo-36686: Improve the documentation of the std* params in loop.subprocess_exec #13586
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2019-05-28.00:22:48.604>
created_at = <Date 2019-04-21.01:04:45.598>
labels = ['3.8', 'expert-asyncio']
title = "Docs: asyncio.loop.subprocess_exec documentation is confusing, it's not clear how to inherit stdin, stdout or stderr in the subprocess"
updated_at = <Date 2019-05-28.13:06:47.124>
user = 'https://github.com/sbstp'

    bugs.python.org fields:

    activity = <Date 2019-05-28.13:06:47.124>
actor = 'asvetlov'
assignee = 'none'
closed = True
closed_date = <Date 2019-05-28.00:22:48.604>
closer = 'sbstp'
components = ['asyncio']
creation = <Date 2019-04-21.01:04:45.598>
creator = 'sbstp'
dependencies = []
files = []
hgrepos = []
issue_num = 36686
keywords = ['patch']
message_count = 4.0
messages = ['340593', '340594', '343542', '343713']
nosy_count = 4.0
nosy_names = ['asvetlov', 'yselivanov', 'sbstp', 'miss-islington']
pr_nums = ['13586']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue36686'
versions = ['Python 3.8']
    @sbstp
    Copy link
    Mannequin Author

    sbstp mannequin commented Apr 21, 2019

    I had trouble figuring out how to simply inherit stdin, stdout, or stderr in the asyncio.create_subprocess_exec / asyncio.subprocess_exec docs. My experiments show that passing either None or sys.std* works but the way the docs are written make it hard to figure that out in my opinion.

    stdout: either a file-like object representing the pipe to be connected to the subprocess’s standard output stream using connect_read_pipe(), or the subprocess.PIPE constant (default). By default a new pipe will be created and connected.

    I would add a mention that using None makes the subprocess inherit the file descriptor.

    @sbstp sbstp mannequin added 3.7 (EOL) end of life 3.9 only security fixes 3.8 only security fixes topic-asyncio labels Apr 21, 2019
    @sbstp
    Copy link
    Mannequin Author

    sbstp mannequin commented Apr 21, 2019

    Could be cool to also mention that encoding / errors does not work yet. https://bugs.python.org/issue31087

    @asvetlov
    Copy link
    Contributor

    Pull Request is welcome!

    @miss-islington
    Copy link
    Contributor

    New changeset f0d4c64 by Miss Islington (bot) (sbstp) in branch 'master':
    bpo-36686: Improve the documentation of the std* params in loop.subprocess_exec (GH-13586)
    f0d4c64

    @sbstp sbstp mannequin closed this as completed May 28, 2019
    @asvetlov asvetlov removed 3.7 (EOL) end of life 3.9 only security fixes labels May 28, 2019
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.8 only security fixes topic-asyncio
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @asvetlov @miss-islington