Deprecate acquire_gil #2549
Closed
Deprecate acquire_gil #2549
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidhewitt
reviewed
Aug 14, 2022
proptest-regressions/types/num.txt
Outdated
| # It is recommended to check this file in to source control so that | ||
| # everyone who runs the test benefits from these saved cases. | ||
| cc 3f6554f5f2102b81ec5751bf443502711acd649bfb5f9b131119a0015037c378 # shrinks to x = 0 | ||
| cc aeb61d75c7fbb350d0f8ca1b4165defa949f29dcb3a19659b232d039cadca507 # shrinks to x = 0 |
There was a problem hiding this comment.
Doesn't look related to this change, though I'm also not against having this file checked in.
CHANGELOG.md
Outdated
Comment on lines
58
to
60
| - Deprecated `Python::acquire_gil` [#2549](https://github.com/PyO3/pyo3/pull/2549). This change was made for several reasons: | ||
| - GIL drop order tracking has turned out to be [error prone](https://github.com/PyO3/pyo3/issues/1683). With a scoped API like `Python::with_gil`, these are always dropped in the correct order. | ||
| - It promotes passing and keeping the GILGuard around, which is almost always not what you actually want. |
There was a problem hiding this comment.
I think I'd rather just have
Suggested change
| - Deprecated `Python::acquire_gil` [#2549](https://github.com/PyO3/pyo3/pull/2549). This change was made for several reasons: | |
| - GIL drop order tracking has turned out to be [error prone](https://github.com/PyO3/pyo3/issues/1683). With a scoped API like `Python::with_gil`, these are always dropped in the correct order. | |
| - It promotes passing and keeping the GILGuard around, which is almost always not what you actually want. | |
| - Deprecate `Python::acquire_gil` [#2549](https://github.com/PyO3/pyo3/pull/2549). |
And then let's move the explanation of why this is deprecated onto the documentation for acquire_gil?
src/marker.rs
Outdated
| @@ -382,6 +382,7 @@ impl<'py> Python<'py> { | |||
| /// [`PyGILState_Ensure`]: crate::ffi::PyGILState_Ensure | |||
| /// [`auto-initialize`]: https://pyo3.rs/main/features.html#auto-initialize | |||
| #[inline] | |||
| #[deprecated(since = "0.17.0", note = "prefer Python::with_gil")] | |||
| pub fn acquire_gil() -> GILGuard { | |||
| GILGuard::acquire() | |||
There was a problem hiding this comment.
Is it worth adding a comment here to remind us as maintainers that when we remove this API for good we can also remove the drop-order tracking from GILGuard?
|
I don't know how I messed this up, but I'll just open a new PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per #1788 (comment)