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

Hide internal asyncio.Stream methods #82247

Closed
asvetlov opened this issue Sep 9, 2019 · 6 comments
Closed

Hide internal asyncio.Stream methods #82247

asvetlov opened this issue Sep 9, 2019 · 6 comments
Labels
3.8 only security fixes 3.9 only security fixes topic-asyncio

Comments

@asvetlov
Copy link
Contributor

asvetlov commented Sep 9, 2019

BPO 38066
Nosy @asvetlov, @1st1, @tzickel, @miss-islington
PRs
  • bpo-38066: Hide internal Stream methods #15762
  • [3.8] bpo-38066: Hide internal Stream methods (GH-15762) #15847
  • 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-09-10.14:04:17.872>
    created_at = <Date 2019-09-09.11:38:35.563>
    labels = ['3.8', '3.9', 'expert-asyncio']
    title = 'Hide internal asyncio.Stream methods'
    updated_at = <Date 2020-02-26.20:56:24.649>
    user = 'https://github.com/asvetlov'

    bugs.python.org fields:

    activity = <Date 2020-02-26.20:56:24.649>
    actor = 'tzickel'
    assignee = 'none'
    closed = True
    closed_date = <Date 2019-09-10.14:04:17.872>
    closer = 'asvetlov'
    components = ['asyncio']
    creation = <Date 2019-09-09.11:38:35.563>
    creator = 'asvetlov'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 38066
    keywords = ['patch']
    message_count = 6.0
    messages = ['351433', '351439', '351549', '351634', '351659', '362736']
    nosy_count = 4.0
    nosy_names = ['asvetlov', 'yselivanov', 'tzickel', 'miss-islington']
    pr_nums = ['15762', '15847']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue38066'
    versions = ['Python 3.8', 'Python 3.9']

    @asvetlov
    Copy link
    Contributor Author

    asvetlov commented Sep 9, 2019

    As discussed in discussion #14488 (comment)

    Hide feed_eof(), feed_data(), set_exception() and set_transport() methods.

    @asvetlov asvetlov added 3.8 only security fixes 3.9 only security fixes topic-asyncio labels Sep 9, 2019
    @1st1
    Copy link
    Member

    1st1 commented Sep 9, 2019

    BTW, if we are doing this -- maybe not expose the underlying transport at all? I don't like that we do that currently, and there multiple ways for the user to screw up the Stream object (and potentially break start_tls()/sendfile() etc)

    @asvetlov
    Copy link
    Contributor Author

    asvetlov commented Sep 9, 2019

    Done.
    The only API from transport that users really need is get_extra_info() which is exposed as a stream method already.

    @miss-islington
    Copy link
    Contributor

    New changeset 12c122a by Miss Islington (bot) (Andrew Svetlov) in branch 'master':
    bpo-38066: Hide internal Stream methods (GH-15762)
    12c122a

    @miss-islington
    Copy link
    Contributor

    New changeset f12ff05 by Miss Islington (bot) in branch '3.8':
    bpo-38066: Hide internal Stream methods (GH-15762)
    f12ff05

    @tzickel
    Copy link
    Mannequin

    tzickel mannequin commented Feb 26, 2020

    The documentation needs to scrub this methods as well, for example:

    https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.at_eof

    still mentions them.

    @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
    3.8 only security fixes 3.9 only security fixes topic-asyncio
    Projects
    None yet
    Development

    No branches or pull requests

    3 participants