Skip to content

bpo-33468: Add try-finally contextlib.contextmanager example#7816

Merged
taleinat merged 2 commits intopython:masterfrom
Carreau:bpo-33468
Jul 23, 2018
Merged

bpo-33468: Add try-finally contextlib.contextmanager example#7816
taleinat merged 2 commits intopython:masterfrom
Carreau:bpo-33468

Conversation

@Carreau
Copy link
Contributor

@Carreau Carreau commented Jun 20, 2018 •
edited by bedevere-bot
Loading

This increase the chances of people following this example properly
cleaning up resources.

https://bugs.python.org/issue33468

@Carreau Carreau requested a review from 1st1 as a code owner June 20, 2018 08:06
taleinat
taleinat requested changes Jun 30, 2018
View reviewed changes
Copy link
Contributor

@taleinat taleinat left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Please change to use an entirely abstract example according to @ncoghlan's suggestion on bpo-33468, or close this PR.

@bedevere-bot
Copy link

bedevere-bot commented Jun 30, 2018

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@Carreau
Copy link
Contributor Author

Carreau commented Jul 23, 2018

I have made the requested changes; please review again

@bedevere-bot
Copy link

bedevere-bot commented Jul 23, 2018

Thanks for making the requested changes!

@taleinat: please review the changes made to this pull request.

taleinat
taleinat requested changes Jul 23, 2018
View reviewed changes
Copy link
Contributor

@taleinat taleinat left a comment

Choose a reason for hiding this comment

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

Looking good, a few minor changes needed IMO.

Doc/library/contextlib.rst Outdated
Copy link
Contributor

@taleinat taleinat Jul 23, 2018

Choose a reason for hiding this comment

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

IMO the fact that this an abstract example (rather than a concrete one) should be mentioned explicitly.

Also, I suggest removing the word "simple".

Doc/library/contextlib.rst Outdated
Copy link
Contributor

@taleinat taleinat Jul 23, 2018

Choose a reason for hiding this comment

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

Perhaps avoid *args, **kwds here? Instead consider e.g. with managed_resource(foo="bar") as resource:

Copy link
Contributor Author

@Carreau Carreau Jul 23, 2018

Choose a reason for hiding this comment

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

something more explicit ? timeout=3600 ?

@bedevere-bot
Copy link

bedevere-bot commented Jul 23, 2018

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@Carreau
bpo-33468: Add try-finally contextlib.contextmanager example
9ab8fca 
This increase the chances of people following this example properly
cleaning up resources.
@Carreau
Copy link
Contributor Author

Carreau commented Jul 23, 2018

I have made the requested changes; please review again

@bedevere-bot
Copy link

bedevere-bot commented Jul 23, 2018

Thanks for making the requested changes!

@taleinat: please review the changes made to this pull request.

@taleinat taleinat added skip news needs backport to 3.6 docs Documentation in the Doc dir labels Jul 23, 2018
@taleinat taleinat merged commit bde782b into python:master Jul 23, 2018
@miss-islington
Copy link
Contributor

miss-islington commented Jul 23, 2018

Thanks @Carreau for the PR, and @taleinat for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 23, 2018
@Carreau @miss-islington
bpo-33468: Add try-finally contextlib.contextmanager example (pythonG…
d5e5316 
…H-7816)

(cherry picked from commit bde782b)

Co-authored-by: Matthias Bussonnier <[email protected]>
@bedevere-bot
Copy link

bedevere-bot commented Jul 23, 2018

GH-8425 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 23, 2018
@Carreau @miss-islington
bpo-33468: Add try-finally contextlib.contextmanager example (pythonG…
3465cb5 
…H-7816)

(cherry picked from commit bde782b)

Co-authored-by: Matthias Bussonnier <[email protected]>
@Carreau
Copy link
Contributor Author

Carreau commented Jul 23, 2018

Thanks @taleinat for the review and the merge !

@bedevere-bot
Copy link

bedevere-bot commented Jul 23, 2018

GH-8426 is a backport of this pull request to the 3.6 branch.

@miss-islington
Copy link
Contributor

miss-islington commented Jul 23, 2018

Sorry, @Carreau and @taleinat, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker bde782bb594edffeabe978abeee2b7082ab9bc2a 2.7

taleinat pushed a commit to taleinat/cpython that referenced this pull request Jul 23, 2018
@Carreau @taleinat
[2.7] bpo-33468: Add try-finally contextlib.contextmanager example (p…
947efaf 
…ythonGH-7816).

(cherry picked from commit bde782b)

Co-authored-by: Matthias Bussonnier <[email protected]>
@bedevere-bot
Copy link

bedevere-bot commented Jul 23, 2018

GH-8427 is a backport of this pull request to the 2.7 branch.

taleinat pushed a commit that referenced this pull request Jul 23, 2018
@miss-islington @Carreau @taleinat
bpo-33468: Add try-finally contextlib.contextmanager example (GH-7816) (
4e166ff 
GH-8425)

(cherry picked from commit bde782b)

Co-authored-by: Matthias Bussonnier <[email protected]>
taleinat pushed a commit that referenced this pull request Jul 23, 2018
@miss-islington @Carreau @taleinat
bpo-33468: Add try-finally contextlib.contextmanager example (GH-7816) (
5b3643d 
GH-8426)

(cherry picked from commit bde782b)

Co-authored-by: Matthias Bussonnier <[email protected]>
taleinat added a commit that referenced this pull request Jul 23, 2018
@taleinat @Carreau
[2.7] bpo-33468: Add try-finally contextlib.contextmanager example (G…
f7e60a6 
…H-7816) (GH-8427)

(cherry picked from commit bde782b)

Co-authored-by: Matthias Bussonnier <[email protected]>
@Carreau Carreau deleted the bpo-33468 branch October 20, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@taleinat taleinat taleinat approved these changes

@1st1 1st1 Awaiting requested review from 1st1

Assignees

@taleinat taleinat

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.

5 participants

@Carreau @bedevere-bot @miss-islington @taleinat @the-knights-who-say-ni