Skip to content

Conversation

@DerekTBrown
Copy link
Contributor

@DerekTBrown DerekTBrown commented Dec 24, 2019

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

  1. 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.
  2. 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
Copy link

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!

@DerekTBrown DerekTBrown changed the title Fix potential deadlock in logging [easy] Move _releaseLock() into finally Dec 24, 2019
@DerekTBrown DerekTBrown marked this pull request as ready for review December 26, 2019 01:13
@DerekTBrown DerekTBrown requested a review from vsajip as a code owner December 26, 2019 01:13
@DerekTBrown
Copy link
Contributor Author

I just signed CLA.

@csabella
Copy link
Contributor

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!

@DerekTBrown 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
@DerekTBrown 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
@DerekTBrown
Copy link
Contributor Author

DerekTBrown commented Jan 2, 2020

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
Copy link
Contributor

bharel commented Jan 2, 2020

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

@csabella csabella requested review from vsajip and removed request for vsajip January 5, 2020 20:30
Copy link
Member

@vsajip vsajip left a comment

Choose a reason for hiding this comment

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

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
Copy link

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.

@DerekTBrown
Copy link
Contributor Author

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
Copy link

Thanks for making the requested changes!

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

@bedevere-bot bedevere-bot requested a review from vsajip January 6, 2020 22:58
@vsajip 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
@vsajip vsajip merged commit 950c679 into python:master Jan 7, 2020
@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 7, 2020
…nabledFor (pythonGH-17689) (cherry picked from commit 950c679) Co-authored-by: Derek Brown <derek@allderek.com>
@bedevere-bot
Copy link

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

@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 7, 2020
…nabledFor (pythonGH-17689) (cherry picked from commit 950c679) Co-authored-by: Derek Brown <derek@allderek.com>
@bedevere-bot
Copy link

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

vsajip pushed a commit that referenced this pull request Jan 7, 2020
vsajip pushed a commit that referenced this pull request Jan 7, 2020
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

8 participants