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

typing.TextIO and BinaryIO are not aliases of IO[...] #76465

Closed
srittau mannequin opened this issue Dec 12, 2017 · 6 comments
Closed

typing.TextIO and BinaryIO are not aliases of IO[...] #76465

srittau mannequin opened this issue Dec 12, 2017 · 6 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir release-blocker

Comments

@srittau
Copy link
Mannequin

srittau mannequin commented Dec 12, 2017

BPO 32284
Nosy @gvanrossum, @srittau, @ned-deily, @asvetlov, @ilevkivskyi
PRs
  • bpo-32284: Fix documentation of BinaryIO and TextIO #4832
  • [3.6] bpo-32284: Fix documentation of BinaryIO and TextIO (GH-4832) #4833
    		•

    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 2017-12-13.08:59:40.299>
created_at = <Date 2017-12-12.00:34:35.047>
labels = ['3.7', 'release-blocker', 'docs']
title = 'typing.TextIO and BinaryIO are not aliases of IO[...]'
updated_at = <Date 2017-12-19.07:50:50.855>
user = 'https://github.com/srittau'

    bugs.python.org fields:

    activity = <Date 2017-12-19.07:50:50.855>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-12-13.08:59:40.299>
closer = 'asvetlov'
components = ['Documentation']
creation = <Date 2017-12-12.00:34:35.047>
creator = 'srittau'
dependencies = []
files = []
hgrepos = []
issue_num = 32284
keywords = ['patch']
message_count = 6.0
messages = ['308083', '308087', '308191', '308192', '308193', '308619']
nosy_count = 6.0
nosy_names = ['gvanrossum', 'srittau', 'ned.deily', 'asvetlov', 'docs@python', 'levkivskyi']
pr_nums = ['4832', '4833']
priority = 'release blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue32284'
versions = ['Python 3.6', 'Python 3.7']
    @srittau
    Copy link
    Mannequin Author

    srittau mannequin commented Dec 12, 2017

    See python/typing#518 for context.

    The typing documentation for 3.6.4rc1 states:

    typing.io ... defines the generic type IO[AnyStr] and aliases TextIO and BinaryIO for respectively IO[str] and IO[bytes].

    In the current implementation TextIO and BinaryIO are not aliases, but instead derived from IO. This means that values of type IO[...], and especially IO[Any] can not be assigned where TextIO or BinaryIO is expected.

    @srittau srittau mannequin assigned docspython Dec 12, 2017
    @srittau srittau mannequin added the docs Documentation in the Doc dir label Dec 12, 2017
    @gvanrossum
    Copy link
    Member

    This doc bug should be fixed before 3.6.4 final goes out.

    @asvetlov asvetlov added the 3.7 (EOL) end of life label Dec 13, 2017
    @asvetlov
    Copy link
    Contributor

    New changeset c3e070f by Andrew Svetlov (Sebastian Rittau) in branch 'master':
    bpo-32284: Fix documentation of BinaryIO and TextIO (bpo-4832)
    c3e070f

    @asvetlov
    Copy link
    Contributor

    New changeset b0358e8 by Andrew Svetlov (Miss Islington (bot)) in branch '3.6':
    bpo-32284: Fix documentation of BinaryIO and TextIO (GH-4832) (bpo-4833)
    b0358e8

    @asvetlov
    Copy link
    Contributor

    Done

    @ned-deily
    Copy link
    Member

    New changeset 898a3e4 by Ned Deily (Miss Islington (bot)) in branch '3.6':
    bpo-32284: Fix documentation of BinaryIO and TextIO (GH-4832) (bpo-4833)
    898a3e4

    @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.7 (EOL) end of life docs Documentation in the Doc dir release-blocker
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @asvetlov @gvanrossum @ned-deily