GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-45292: [PEP-654] exception groups and except* documentation by iritkatriel · Pull Request #30158 · python/cpython

Conversation

@iritkatriel

@iritkatriel iritkatriel commented Dec 16, 2021 •
edited by bedevere-bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

https://bugs.python.org/issue45292

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@iritkatriel
bpo-45292: except* documentation
f42d81e
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Dec 16, 2021
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Dec 16, 2021
@bedevere-bot bedevere-bot added the awaiting core review label Dec 16, 2021
@iritkatriel iritkatriel added the skip news label Dec 16, 2021
@iritkatriel

iritkatriel commented Dec 16, 2021

Copy link
Copy Markdown
Member Author

@willingc Is there anyone from the documentation experts who may be interested in helping with this?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel iritkatriel changed the title bpo-45292: except* documentation bpo-45292: [PEP-654] exception groups and except* documentation Dec 16, 2021
@iritkatriel
fix
1eaebb2
@gvanrossum

gvanrossum commented Dec 17, 2021

Copy link
Copy Markdown
Member

@Fidget-Spinner Are you available to help here?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@willingc

willingc commented Dec 17, 2021

Copy link
Copy Markdown
Contributor

@iritkatriel I'm happy to help if @Fidget-Spinner is unavailable. I'm assuming you wish for some help to resolve whatever is causing the doc build to error.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

willingc
willingc reviewed Dec 17, 2021
View reviewed changes

@willingc willingc left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Irit, this looks good. Looking into the keyword errors.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

willingc
willingc reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/reference/compound_stmts.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel

iritkatriel commented Dec 17, 2021

Copy link
Copy Markdown
Member Author

@iritkatriel I'm happy to help if @Fidget-Spinner is unavailable. I'm assuming you wish for some help to resolve whatever is causing the doc build to error.

Thank you. Not just the formatting error, also a fresh reader who can see if it’s clear and consistent with the documentation style, and whether things are where they belong and at the right level of detail.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel @willingc
Apply suggestions from code review
59ae0f5
Co-authored-by: Carol Willing <[email protected]>
@willingc

willingc commented Dec 17, 2021

Copy link
Copy Markdown
Contributor

@iritkatriel I think the tone and content are well done. I need to drop for the evening but feel free to merge if the build error resolves. Ping me in the morning if you get stuck on that. Thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Fidget-Spinner

Fidget-Spinner commented Dec 17, 2021 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Hi @iritkatriel, you need to create a label/anchor (I forgot the term) for except_star. See line 221-223 of compound_stmts.rst for an example. Adding a .._except_star: under the try, except, finally labels should be sufficient.

For some reason, keyword labels must be placed preceding a title, even though rST supports arbitrary anchors normally. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref for more info.

willingc reacted with hooray emoji
All reactions
  • 🎉 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

iritkatriel added 3 commits December 17, 2021 11:28
@iritkatriel
add _except_star anchor
af959d7
@iritkatriel
add small note example
27db9c3
@iritkatriel
mentioned __note__ in traceback doc
274f7f1
@iritkatriel

iritkatriel commented Dec 17, 2021

Copy link
Copy Markdown
Member Author

Thank you @willingc and @Fidget-Spinner , it's looking good now.

I will give @gvanrossum and @1st1 and anyone else a chance to review before merging. There isn't any rush with this - the early users we have now already read the PEP.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Fidget-Spinner
Fidget-Spinner reviewed Dec 17, 2021
View reviewed changes

@Fidget-Spinner Fidget-Spinner left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! This is the first time I'm reading about PEP 654 in more detail, and I did not realize it was this powerful!

Speaking from the perspective of a newbie, I understood what you wrote. The tutorial and language reference is very clear to me.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

iritkatriel, willingc, and Zac-HD reacted with hooray emoji
All reactions
  • 🎉 3 reactions
Comment thread Doc/reference/compound_stmts.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/reference/compound_stmts.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

kumaraditya303
kumaraditya303 reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

kumaraditya303
kumaraditya303 reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel @kumaraditya303
Apply suggestions from code review
9f90292
Co-authored-by: Kumar Aditya <[email protected]>
kumaraditya303
kumaraditya303 reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

kumaraditya303
kumaraditya303 reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/reference/compound_stmts.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

kumaraditya303
kumaraditya303 reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/tutorial/errors.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

gpshead
gpshead reviewed Dec 17, 2021
View reviewed changes
Comment thread Doc/reference/compound_stmts.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/tutorial/errors.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

kumaraditya303
kumaraditya303 reviewed Dec 18, 2021
View reviewed changes
Comment thread Doc/reference/compound_stmts.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel @kumaraditya303
typo
a285f87
Co-authored-by: Kumar Aditya <[email protected]>
iritkatriel added 2 commits December 19, 2021 15:48
@iritkatriel
nested exceptions must be instances
6a99f8c
@iritkatriel
subgroup/split check condition for interior nodes as well. This mean …
7a13adb
…that rest is not exactly subgroup(not condition)
kumaraditya303
kumaraditya303 reviewed Dec 19, 2021
View reviewed changes
Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

warsaw
warsaw reviewed Dec 20, 2021
View reviewed changes
Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/exceptions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/traceback.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/tutorial/errors.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/tutorial/errors.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

iritkatriel and others added 3 commits December 20, 2021 19:56
@iritkatriel @kumaraditya303
Kumar’s edit
be728bf
Co-authored-by: Kumar Aditya <[email protected]>
@iritkatriel
attribute references
cbff13f
@iritkatriel
reword __note__ description
2b76b03
@Zac-HD

Zac-HD commented Dec 21, 2021

Copy link
Copy Markdown
Contributor

I'm happy to take comments related to .__note__ over on my PEP 678 draft 😁

warsaw and willingc reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Zac-HD Zac-HD mentioned this pull request Dec 22, 2021
PEP 678: Enriching Exceptions with Notes python/peps#2201
Merged
@iritkatriel
fix the contructor description
dd967c2
@warsaw warsaw mentioned this pull request Dec 24, 2021
A change of wording in PEP 654 - ExceptionGroups and except* python/steering-council#94
Closed
@iritkatriel
add subclassing example
a964a2d
@iritkatriel

iritkatriel commented Jan 6, 2022

Copy link
Copy Markdown
Member Author

Shall I merge this? It might be nice to have the documentation there when except* is released in the next alpha.

Zac-HD, willingc, and warsaw reacted with thumbs up emoji
All reactions
  • 👍 3 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@willingc

willingc commented Jan 6, 2022

Copy link
Copy Markdown
Contributor

@iritkatriel Prior to merging, can you recap any outstanding next actions needed in a message here. Thanks!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel

iritkatriel commented Jan 6, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member Author

I believe this PR now describes the way exception groups and except* work, and is consistent with PEP654.

The new __note__ field on exception is the subject of PEP678, which is still in draft stage. The doc here describes the current implementation, which is consistent with the PEP. Any changes/reversion following the PEP678 discussions will be made in the code and the doc at the same time.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel

iritkatriel commented Jan 6, 2022

Copy link
Copy Markdown
Member Author

I could also split out the __note__ section into a separate PR and merge only the PEP654 stuff for now if that works better.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@gvanrossum

gvanrossum commented Jan 6, 2022

Copy link
Copy Markdown
Member

I could also split out the __note__ section into a separate PR and merge only the PEP654 stuff for now if that works better.

Yeah, let's keep __note__ undocumented until its PEP has been approved.

warsaw reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel
remove __note__ documentation
939a1f6
iritkatriel
iritkatriel commented Jan 6, 2022
View reviewed changes
Comment thread Doc/tutorial/errors.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel
Fix prompt in example
4a46570
@iritkatriel
iritkatriel merged commit 9925e70 into python:main Jan 6, 2022
@bedevere-bot bedevere-bot removed the awaiting core review label Jan 6, 2022
@iritkatriel
iritkatriel deleted the bpo-45292-doc branch January 6, 2022 19:22
@iritkatriel

iritkatriel commented Jan 6, 2022

Copy link
Copy Markdown
Member Author

Thank you everyone!

The notes section is in this draft PR #30441.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@iritkatriel iritkatriel mentioned this pull request Apr 10, 2022
Implement PEP 654: Exception Groups #89455
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gpshead gpshead gpshead left review comments
@warsaw warsaw warsaw left review comments
@encukou encukou encukou left review comments
@willingc willingc willingc left review comments
@gvanrossum gvanrossum gvanrossum left review comments
@Fidget-Spinner Fidget-Spinner Fidget-Spinner left review comments
@kumaraditya303 kumaraditya303 kumaraditya303 left review comments
+1 more reviewer
@Zac-HD Zac-HD Zac-HD left review comments
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

11 participants

@iritkatriel @gvanrossum @willingc @Fidget-Spinner @Zac-HD @gpshead @warsaw @encukou @kumaraditya303 @the-knights-who-say-ni @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.