bpo-28516: contextlib.ExitStack.enter has trivial but undocument… #31636

Vidhyavinu · 2022-03-01T15:47:50Z

The enter_context is updated with following information: 'The :meth:__enter__ method
returns the ExitStack instance, and performs no additional operations.'

https://bugs.python.org/issue28516

…ed behavior The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.'

akulakov · 2022-03-01T18:07:09Z

Doc/library/contextlib.rst

@@ -529,7 +529,8 @@ Functions and classes provided:

      Enters a new context manager and adds its :meth:`__exit__` method to
      the callback stack. The return value is the result of the context
-      manager's own :meth:`__enter__` method.
+      manager's own :meth:`__enter__` method.The :meth:`__enter__` method 


space after period.

akulakov · 2022-03-01T18:07:52Z

Doc/library/contextlib.rst

@@ -529,7 +529,8 @@ Functions and classes provided:

      Enters a new context manager and adds its :meth:`__exit__` method to
      the callback stack. The return value is the result of the context
-      manager's own :meth:`__enter__` method.
+      manager's own :meth:`__enter__` method.The :meth:`__enter__` method 
+      returns the ExitStack instance, and performs no additional operations.


Can we make a link for ExitStack?

Thanks for your comments. It is updated in the latest commit.

Added space after period and link to ExitStack.

JelleZijlstra · 2022-03-02T04:31:56Z

Doc/library/contextlib.rst

@@ -529,7 +529,8 @@ Functions and classes provided:

      Enters a new context manager and adds its :meth:`__exit__` method to
      the callback stack. The return value is the result of the context
-      manager's own :meth:`__enter__` method.
+      manager's own :meth:`__enter__` method. The :meth:`__enter__` method


It doesn't make sense to put this in the enter_context documentation. It needs to go somewhere in the ExitStack intro, perhaps in the paragraph after the example.

I put it as a separate paragraph in the ExitStack intro. Please review.

Are you able to review the last commit? If you feel anything to be updated pls let me know.

bedevere-bot · 2022-03-02T04:32:08Z

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.

JelleZijlstra · 2022-03-09T02:36:03Z

Doc/library/contextlib.rst

   Each instance maintains a stack of registered callbacks that are called in
   reverse order when the instance is closed (either explicitly or implicitly
   at the end of a :keyword:`with` statement). Note that callbacks are *not*
   invoked implicitly when the context stack instance is garbage collected.
-


Please put this line back

Added the line in the latest commit. please review.

The CI build is still failing due to some trailing whitespace.

I cannot see any trailing spaces. Are you able to locate which line it is?

AlexWaygood

In general you can see which specific errors are being reported by a failing CI check by clicking the "Details" button next to the check.

AlexWaygood · 2022-03-09T22:38:28Z

Doc/library/contextlib.rst

@@ -502,6 +502,9 @@ Functions and classes provided:
          # the with statement, even if attempts to open files later
          # in the list raise an exception

+   The :meth:`__enter__` method returns the :class:`ExitStack` instance, and 


Suggested change

The :meth:`__enter__` method returns the :class:`ExitStack` instance, and

The :meth:`__enter__` method returns the :class:`ExitStack` instance, and

Removed trailing whitespace.

Vidhyavinu · 2022-03-10T14:08:51Z

Thanks Alex. I removed the trailing whitespace.

Is it possible for me to run the CI tests locally?

miss-islington · 2022-03-28T04:31:35Z

Thanks @Vidhyavinu for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

bedevere-bot · 2022-03-28T04:31:55Z

GH-32145 is a backport of this pull request to the 3.9 branch.

…-31636) The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.' Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 86384cf) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>

JelleZijlstra · 2022-03-28T04:52:33Z

Not sure what happened to the 3.10 backport

AlexWaygood · 2022-03-28T08:22:31Z

Not sure what happened to the 3.10 backport

Looks like it's here:

[3.10] bpo-28516: document contextlib.ExitStack.__enter__ behavior (GH-31636) #32144

Idk why Bedevere didn't pick up on it.

AlexWaygood · 2022-03-28T08:23:54Z

Thanks Alex. I removed the trailing whitespace.

Is it possible for me to run the CI tests locally?

Yes, there's a section in the devguide with instructions on it here 🙂

miss-islington · 2022-03-28T17:34:04Z

Thanks @Vidhyavinu for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington · 2022-03-28T17:43:49Z

Thanks @Vidhyavinu for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

GH-32145) The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.' Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 86384cf) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com> Co-authored-by: Ned Deily <nad@python.org>

ned-deily · 2022-03-28T18:48:38Z

@JelleZijlstra The 3.10 backport still seems to be missing in action. Sorry about that. If you don't mind, I'll let you deal with it as I've caused enough trouble already ;)

JelleZijlstra · 2022-03-28T18:50:32Z

Sure, I'll take care of it. Thanks!

bedevere-bot · 2022-03-29T02:11:45Z

GH-32171 is a backport of this pull request to the 3.10 branch.

…ythonGH-31636) The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.' Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 86384cf) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>

…H-31636) (GH-32171) The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.' Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 86384cf) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com>

…-31636) (pythonGH-32145) The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.' Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 86384cf) Co-authored-by: vidhya <96202776+Vidhyavinu@users.noreply.github.com> Co-authored-by: Ned Deily <nad@python.org>

BPO - 28516 contextlib.ExitStack.__enter__ has trivial but undocument…

0b95995

…ed behavior The enter_context is updated with following information: 'The :meth:`__enter__` method returns the ExitStack instance, and performs no additional operations.'

Vidhyavinu requested a review from 1st1 as a code owner March 1, 2022 15:47

bedevere-bot added the awaiting review label Mar 1, 2022

the-knights-who-say-ni added the CLA signed label Mar 1, 2022

bedevere-bot added the docs Documentation in the Doc dir label Mar 1, 2022

JelleZijlstra self-requested a review March 1, 2022 16:01

AlexWaygood added the skip news label Mar 1, 2022

akulakov reviewed Mar 1, 2022

View reviewed changes

Vidhyavinu and others added 2 commits March 1, 2022 16:21

Update contextlib.rst

598f420

Added space after period and link to ExitStack.

clear trailing whitespace

61fae60

JelleZijlstra changed the title ~~BPO - 28516 contextlib.ExitStack.__enter__ has trivial but undocument…~~ bpo-28516: contextlib.ExitStack.__enter__ has trivial but undocument… Mar 2, 2022

JelleZijlstra requested changes Mar 2, 2022

View reviewed changes

bedevere-bot removed the awaiting review label Mar 2, 2022

bedevere-bot added the awaiting changes label Mar 2, 2022

Vidhyavinu added 5 commits March 2, 2022 13:34

Update contextlib.rst

7638af3

Update contextlib.rst

6c70f1d

Update contextlib.rst

e1a1161

Update contextlib.rst

0476d74

Update contextlib.rst

bcbaece

JelleZijlstra self-requested a review March 7, 2022 17:47

JelleZijlstra reviewed Mar 9, 2022

View reviewed changes

Vidhyavinu added 2 commits March 9, 2022 06:01

Update contextlib.rst

d5cbd4d

Update contextlib.rst

0958ed5

AlexWaygood reviewed Mar 9, 2022

View reviewed changes

Update contextlib.rst

c411078

Removed trailing whitespace.

JelleZijlstra approved these changes Mar 28, 2022

View reviewed changes

bedevere-bot removed the awaiting changes label Mar 28, 2022

bedevere-bot added the awaiting merge label Mar 28, 2022

JelleZijlstra added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Mar 28, 2022

JelleZijlstra merged commit 86384cf into python:main Mar 28, 2022

bedevere-bot removed awaiting merge needs backport to 3.9 only security fixes labels Mar 28, 2022

ned-deily added needs backport to 3.10 only security fixes and removed needs backport to 3.10 only security fixes labels Mar 28, 2022

bedevere-bot removed the needs backport to 3.10 only security fixes label Mar 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-28516: contextlib.ExitStack.enter has trivial but undocument… #31636

bpo-28516: contextlib.ExitStack.enter has trivial but undocument… #31636

Vidhyavinu commented Mar 1, 2022 •

edited by bedevere-bot

Loading

akulakov Mar 1, 2022

akulakov Mar 1, 2022

Vidhyavinu Mar 1, 2022

Vidhyavinu Mar 1, 2022

JelleZijlstra Mar 2, 2022

Vidhyavinu Mar 2, 2022

Vidhyavinu Mar 7, 2022

bedevere-bot commented Mar 2, 2022

JelleZijlstra Mar 9, 2022

Vidhyavinu Mar 9, 2022

JelleZijlstra Mar 9, 2022

Vidhyavinu Mar 9, 2022

AlexWaygood left a comment

AlexWaygood Mar 9, 2022

Vidhyavinu commented Mar 10, 2022

miss-islington commented Mar 28, 2022

bedevere-bot commented Mar 28, 2022

JelleZijlstra commented Mar 28, 2022

AlexWaygood commented Mar 28, 2022

AlexWaygood commented Mar 28, 2022

miss-islington commented Mar 28, 2022

miss-islington commented Mar 28, 2022

ned-deily commented Mar 28, 2022

JelleZijlstra commented Mar 28, 2022

bedevere-bot commented Mar 29, 2022

	The :meth:`__enter__` method returns the :class:`ExitStack` instance, and
	The :meth:`__enter__` method returns the :class:`ExitStack` instance, and

bpo-28516: contextlib.ExitStack.__enter__ has trivial but undocument… #31636

bpo-28516: contextlib.ExitStack.__enter__ has trivial but undocument… #31636

Conversation

Vidhyavinu commented Mar 1, 2022 • edited by bedevere-bot Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bedevere-bot commented Mar 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlexWaygood left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Vidhyavinu commented Mar 10, 2022

miss-islington commented Mar 28, 2022

bedevere-bot commented Mar 28, 2022

JelleZijlstra commented Mar 28, 2022

AlexWaygood commented Mar 28, 2022

AlexWaygood commented Mar 28, 2022

miss-islington commented Mar 28, 2022

miss-islington commented Mar 28, 2022

ned-deily commented Mar 28, 2022

JelleZijlstra commented Mar 28, 2022

bedevere-bot commented Mar 29, 2022

bpo-28516: contextlib.ExitStack.enter has trivial but undocument… #31636

bpo-28516: contextlib.ExitStack.enter has trivial but undocument… #31636

Vidhyavinu commented Mar 1, 2022 •

edited by bedevere-bot

Loading