bpo-39198: Ensure logging global lock is released on exception in isEnabledFor #17689

DerekTBrown · 2019-12-24T01:12:00Z

This is a relatively small change which makes it easier to reason about the global _acquireLock() behavior inside of isEnabledFor:

Other callsites call _releaseLock inside of a finally block, ensuring that the lock is released even if exceptions are thrown (Example). This diff's primary goal is to ensure _releaseLock is called inside a finally block.
1. This makes it easier to prove the correctness of isEnabledFor, because we no longer need to assert than no exceptions are thrown in order for the lock to be released.
2. When using libraries like stopit, this ensures the lock is released even if exceptions are injected.
Nested try statements are stylistically bad. Instead, create a helper function to contain the uncached behavior of determining if a logger is enabled for a particular status.

https://bugs.python.org/issue39198

the-knights-who-say-ni · 2019-12-24T01:12:03Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@DerekTBrown

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!


        Move _releaseLock into finally block

DerekTBrown · 2019-12-26T01:13:47Z

I just signed CLA.

csabella · 2019-12-31T12:36:58Z

Hi @DerekTBrown, thank you for your contribution and for helping to improve CPython. Please open an issue on bugs.python.org and update the title of the PR with the ticket number. Trivial changes are for things like one word spelling changes and anything more than that should have a bug ticket. Thank you!


        📜🤖 Added by blurb_it.

DerekTBrown · 2020-01-02T20:25:20Z

Thanks @csabella! I filed a BPO and created a news entry as well. Let me know if I need to make changes to the content in either of those places.

bharel · 2020-01-02T22:24:43Z

I feel like nesting a try won't actually pose an issue, it'll be faster and frankly enough more readable I believe.

Lib/logging/__init__.py

vsajip

I would also prefer to not add the extra method but handle with a nested try, while ensuring that Gareth Rees' comment is also addressed.

bedevere-bot · 2020-01-06T19:48:02Z

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.


        Address comments using nested try

DerekTBrown · 2020-01-06T22:58:23Z

I have made the requested changes; please review again. Given comments, I made a simpler change and just wrapped setting the level in a try...finally block.

bedevere-bot · 2020-01-06T22:58:26Z

Thanks for making the requested changes!

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

miss-islington · 2020-01-07T16:41:01Z

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


        bpo-39198: Ensure logging global lock is released on exception in isE…

…nabledFor (pythonGH-17689) (cherry picked from commit 950c679) Co-authored-by: Derek Brown <derek@allderek.com>

bedevere-bot · 2020-01-07T16:41:21Z

GH-17897 is a backport of this pull request to the 3.8 branch.

miss-islington · 2020-01-07T16:41:44Z

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


        bpo-39198: Ensure logging global lock is released on exception in isE…

…nabledFor (pythonGH-17689) (cherry picked from commit 950c679) Co-authored-by: Derek Brown <derek@allderek.com>

bedevere-bot · 2020-01-07T16:41:53Z

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


        bpo-39198: Ensure logging global lock is released on exception in isE…

…nabledFor (GH-17689) (GH-17897) (cherry picked from commit 950c679)


        bpo-39198: Ensure logging global lock is released on exception in isE…

…nabledFor (GH-17689) (GH-17898) (cherry picked from commit 950c679)

the-knights-who-say-ni added the CLA not signed label Dec 24, 2019

bedevere-bot added the awaiting review label Dec 24, 2019

DerekTBrown force-pushed the DerekTBrown:logging_deadlock branch 2 times, most recently from 53e9f6b to 9509cc9 Dec 24, 2019

DerekTBrown changed the title ~~Fix potential deadlock in logging~~ [easy] Move _releaseLock() into `finally` Dec 24, 2019

DerekTBrown force-pushed the DerekTBrown:logging_deadlock branch from 9509cc9 to d9dbc31 Dec 24, 2019

Move _releaseLock into finally block

Loading status checks…

7b778d6

DerekTBrown force-pushed the DerekTBrown:logging_deadlock branch from d9dbc31 to 7b778d6 Dec 26, 2019

DerekTBrown marked this pull request as ready for review Dec 26, 2019

DerekTBrown requested a review from vsajip as a code owner Dec 26, 2019

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Dec 31, 2019

DerekTBrown changed the title ~~[easy] Move _releaseLock() into `finally`~~ bpo-39198 Ensure logging global lock is released on exception in isEnabled For Jan 2, 2020

📜🤖 Added by blurb_it.

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

9d49c14

DerekTBrown changed the title ~~bpo-39198 Ensure logging global lock is released on exception in isEnabled For~~ bpo-39198 Ensure logging global lock is released on exception in isEnabledFor Jan 2, 2020

gareth-rees reviewed Jan 5, 2020

View changes

Lib/logging/__init__.py Outdated Show resolved Hide resolved

Lib/logging/__init__.py Outdated Show resolved Hide resolved

csabella requested review from vsajip and removed request for vsajip Jan 5, 2020

vsajip requested changes Jan 6, 2020

View changes

bedevere-bot added awaiting changes and removed awaiting review labels Jan 6, 2020

Address comments using nested try

Loading status checks…

8a259ca

bedevere-bot removed the awaiting changes label Jan 6, 2020

bedevere-bot added the awaiting change review label Jan 6, 2020

bedevere-bot requested a review from vsajip Jan 6, 2020

vsajip approved these changes Jan 7, 2020

View changes

bedevere-bot added awaiting merge and removed awaiting change review labels Jan 7, 2020

vsajip changed the title ~~bpo-39198 Ensure logging global lock is released on exception in isEnabledFor~~ bpo-39198: Ensure logging global lock is released on exception in isEnabledFor Jan 7, 2020

bedevere-bot removed the awaiting merge label Jan 7, 2020

vsajip added the needs backport to 3.8 label Jan 7, 2020

bedevere-bot removed the needs backport to 3.8 label Jan 7, 2020

vsajip added the needs backport to 3.7 label Jan 7, 2020

bedevere-bot removed the needs backport to 3.7 label Jan 7, 2020

vsajip added a commit that referenced this pull request Jan 7, 2020

bpo-39198: Ensure logging global lock is released on exception in isE…

Loading status checks…

bff48c6

…nabledFor (GH-17689) (GH-17897) (cherry picked from commit 950c679)

vsajip added a commit that referenced this pull request Jan 7, 2020

bpo-39198: Ensure logging global lock is released on exception in isE…

Loading status checks…

d46dec9

…nabledFor (GH-17689) (GH-17898) (cherry picked from commit 950c679)

python / cpython

bpo-39198: Ensure logging global lock is released on exception in isEnabledFor #17689

bpo-39198: Ensure logging global lock is released on exception in isEnabledFor #17689

DerekTBrown commented Dec 24, 2019 •

edited by bedevere-bot

This comment has been minimized.

the-knights-who-say-ni commented Dec 24, 2019

This comment has been minimized.

DerekTBrown commented Dec 26, 2019

This comment has been minimized.

csabella commented Dec 31, 2019

This comment has been minimized.

DerekTBrown commented Jan 2, 2020 •

edited

This comment has been minimized.

bharel commented Jan 2, 2020 •

edited

vsajip left a comment

This comment has been minimized.

bedevere-bot commented Jan 6, 2020

This comment has been minimized.

DerekTBrown commented Jan 6, 2020

This comment has been minimized.

bedevere-bot commented Jan 6, 2020

This comment has been minimized.

miss-islington commented Jan 7, 2020

This comment has been minimized.

bedevere-bot commented Jan 7, 2020

This comment has been minimized.

miss-islington commented Jan 7, 2020

This comment has been minimized.

bedevere-bot commented Jan 7, 2020

python / cpython

Sponsor python/cpython

Join GitHub today

bpo-39198: Ensure logging global lock is released on exception in isEnabledFor #17689

bpo-39198: Ensure logging global lock is released on exception in isEnabledFor #17689

Conversation

DerekTBrown commented Dec 24, 2019 • edited by bedevere-bot

This comment has been minimized.

the-knights-who-say-ni commented Dec 24, 2019

Recognized GitHub username

This comment has been minimized.

DerekTBrown commented Dec 26, 2019

This comment has been minimized.

csabella commented Dec 31, 2019

This comment has been minimized.

DerekTBrown commented Jan 2, 2020 • edited

This comment has been minimized.

bharel commented Jan 2, 2020 • edited

vsajip left a comment

This comment has been minimized.

bedevere-bot commented Jan 6, 2020

This comment has been minimized.

DerekTBrown commented Jan 6, 2020

This comment has been minimized.

bedevere-bot commented Jan 6, 2020

This comment has been minimized.

miss-islington commented Jan 7, 2020

This comment has been minimized.

bedevere-bot commented Jan 7, 2020

This comment has been minimized.

miss-islington commented Jan 7, 2020

This comment has been minimized.

bedevere-bot commented Jan 7, 2020

DerekTBrown commented Dec 24, 2019 •

edited by bedevere-bot

DerekTBrown commented Jan 2, 2020 •

edited

bharel commented Jan 2, 2020 •

edited