Skip to content

/cpython

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[easy] Move _releaseLock() into `finally` #17689

Open
wants to merge 1 commit into
base: master
from
Open

[easy] Move _releaseLock() into `finally` #17689

wants to merge 1 commit into from
+12 −8

Conversation

@DerekTBrown
Copy link

DerekTBrown commented Dec 24, 2019 •
edited

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.
@the-knights-who-say-ni

This comment has been minimized.

Sign in to view
Copy link

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

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 force-pushed the DerekTBrown:logging_deadlock branch 2 times, most recently from 53e9f6b to 9509cc9 Dec 24, 2019
@DerekTBrown DerekTBrown changed the title Fix potential deadlock in logging [easy] Move _releaseLock() into `finally` Dec 24, 2019
@DerekTBrown DerekTBrown force-pushed the DerekTBrown:logging_deadlock branch from 9509cc9 to d9dbc31 Dec 24, 2019
@DerekTBrown
Move _releaseLock into finally block
Loading status checks…
7b778d6
@DerekTBrown DerekTBrown force-pushed the DerekTBrown:logging_deadlock branch from d9dbc31 to 7b778d6 Dec 26, 2019
@DerekTBrown DerekTBrown marked this pull request as ready for review Dec 26, 2019
@DerekTBrown DerekTBrown requested a review from vsajip as a code owner Dec 26, 2019
@DerekTBrown

This comment has been minimized.

Sign in to view
Copy link
Author

DerekTBrown commented Dec 26, 2019

I just signed CLA.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsajip vsajip

Assignees
No one assigned
Labels
CLA not signed awaiting review
Projects
None yet
Milestone
No milestone
3 participants
@DerekTBrown @the-knights-who-say-ni @bedevere-bot
You can’t perform that action at this time.