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.

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

Not so correct documentation about asyncio.subprocess_shell method #65957

Closed
vajrasky mannequin opened this issue Jun 14, 2014 · 4 comments
Closed

Not so correct documentation about asyncio.subprocess_shell method #65957

vajrasky mannequin opened this issue Jun 14, 2014 · 4 comments
Labels
docs Documentation in the Doc dir topic-asyncio

Comments

@vajrasky
Copy link
Mannequin

vajrasky mannequin commented Jun 14, 2014

BPO 21758
Nosy @gvanrossum, @vstinner, @1st1, @vajrasky
Files
  • fix_doc_asyncio_subprocess_shell.patch
  • 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 2014-06-19.15:40:51.150>
    created_at = <Date 2014-06-14.16:17:58.359>
    labels = ['docs', 'expert-asyncio']
    title = 'Not so correct documentation about asyncio.subprocess_shell method'
    updated_at = <Date 2014-06-19.15:40:51.149>
    user = 'https://github.com/vajrasky'

    bugs.python.org fields:

    activity = <Date 2014-06-19.15:40:51.149>
    actor = 'vstinner'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2014-06-19.15:40:51.150>
    closer = 'vstinner'
    components = ['Documentation', 'asyncio']
    creation = <Date 2014-06-14.16:17:58.359>
    creator = 'vajrasky'
    dependencies = []
    files = ['35634']
    hgrepos = []
    issue_num = 21758
    keywords = ['patch']
    message_count = 4.0
    messages = ['220567', '220620', '220962', '220963']
    nosy_count = 6.0
    nosy_names = ['gvanrossum', 'vstinner', 'docs@python', 'python-dev', 'yselivanov', 'vajrasky']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = None
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue21758'
    versions = ['Python 3.4', 'Python 3.5']

    @vajrasky
    Copy link
    Mannequin Author

    vajrasky mannequin commented Jun 14, 2014

    subprocess_shell in asyncio accepts cmd as a string or a bytes but the test unit, the documentation and the exception indicates that it only accepts a string.

    @vajrasky vajrasky mannequin assigned docspython Jun 14, 2014
    @vajrasky vajrasky mannequin added docs Documentation in the Doc dir topic-asyncio labels Jun 14, 2014
    @vstinner
    Copy link
    Member

    IMO it's fine to support bytes on UNIX, os.fsencode() is well defined. On
    Windows, we may use the same decoder.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jun 19, 2014

    New changeset 24c356168cc8 by Victor Stinner in branch '3.4':
    Closes bpo-21758: asyncio doc: mention explicitly that subprocess parameters are
    http://hg.python.org/cpython/rev/24c356168cc8

    New changeset b57cdb945bf9 by Victor Stinner in branch 'default':
    (Merge 3.4) Closes bpo-21758: asyncio doc: mention explicitly that subprocess
    http://hg.python.org/cpython/rev/b57cdb945bf9

    @python-dev python-dev mannequin closed this as completed Jun 19, 2014
    @vstinner
    Copy link
    Member

    A "string" can be a bytes string or a character string. I modified the documentation to be more explicitly, but IMO it's fine to keep "string" term in unit tests and error messages. You should not get the "string" error message if you pass a bytes or str object.

    @vstinner vstinner reopened this Jun 19, 2014
    @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
    Labels
    docs Documentation in the Doc dir topic-asyncio
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant