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

Change of inheritance of asyncio.CancelledError needs documentation #81832

Closed
garyvdm mannequin opened this issue Jul 22, 2019 · 5 comments
Closed

Change of inheritance of asyncio.CancelledError needs documentation #81832

garyvdm mannequin opened this issue Jul 22, 2019 · 5 comments
Labels
3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir topic-asyncio

Comments

@garyvdm
Copy link
Mannequin

garyvdm mannequin commented Jul 22, 2019

BPO 37651
Nosy @asvetlov, @1st1, @lisroach, @miss-islington, @tirkarthi
PRs
  • bpo-37651: Document CancelledError is now a subclass of BaseException #15950
  • [3.8] bpo-37651: Document CancelledError is now a subclass of BaseException (GH-15950) #15959
    		•

    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-11.15:09:17.485>
created_at = <Date 2019-07-22.13:36:22.593>
labels = ['docs', '3.8', '3.9', 'expert-asyncio']
title = 'Change of inheritance of asyncio.CancelledError needs documentation'
updated_at = <Date 2019-09-11.15:09:17.484>
user = 'https://bugs.python.org/garyvdm'

    bugs.python.org fields:

    activity = <Date 2019-09-11.15:09:17.484>
actor = 'asvetlov'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-09-11.15:09:17.485>
closer = 'asvetlov'
components = ['Documentation', 'asyncio']
creation = <Date 2019-07-22.13:36:22.593>
creator = 'garyvdm'
dependencies = []
files = []
hgrepos = []
issue_num = 37651
keywords = ['patch']
message_count = 5.0
messages = ['348297', '351881', '351891', '351924', '351925']
nosy_count = 7.0
nosy_names = ['asvetlov', 'docs@python', 'yselivanov', 'lisroach', 'garyvdm', 'miss-islington', 'xtreak']
pr_nums = ['15950', '15959']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue37651'
versions = ['Python 3.8', 'Python 3.9']
    @garyvdm
    Copy link
    Mannequin Author

    garyvdm mannequin commented Jul 22, 2019

    asyncio.CancelledError inheritance was changed in 3.8.

    https://bugs.python.org/issue32528
    431b540

    The documentation still instructs the user to perform a pattern needed before this change. The documentation should probably change to inform them of the change, and to let them know that pattern is only necessary prior to 3.8.

    @garyvdm garyvdm mannequin added the 3.8 only security fixes label Jul 22, 2019
    @garyvdm garyvdm mannequin assigned docspython Jul 22, 2019
    @garyvdm garyvdm mannequin added the docs Documentation in the Doc dir label Jul 22, 2019
    @tirkarthi
    Copy link
    Member

    Thanks for the report. I think this documentation part is missed in the linked PR. I will prepare a PR that adds the versionchanged directive. Perhaps we can also remove the important section or perhaps just keep the try..except example to ensure users are aware of this. I will prepare a PR for this change.

    @tirkarthi tirkarthi added topic-asyncio 3.9 only security fixes labels Sep 11, 2019
    @miss-islington
    Copy link
    Contributor

    New changeset 7b69069 by Miss Islington (bot) (Xtreak) in branch 'master':
    bpo-37651: Document CancelledError is now a subclass of BaseException (GH-15950)
    7b69069

    @miss-islington
    Copy link
    Contributor

    New changeset e784bb7 by Miss Islington (bot) in branch '3.8':
    bpo-37651: Document CancelledError is now a subclass of BaseException (GH-15950)
    e784bb7

    @asvetlov
    Copy link
    Contributor

    Done, thanks!

    @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 3.9 only security fixes docs Documentation in the Doc dir topic-asyncio
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @asvetlov @tirkarthi @miss-islington