-
Notifications
You must be signed in to change notification settings - Fork 784
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
291 additions
and
21 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Add `coroutine::CancelHandle` to catch coroutine cancellation |
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| use crate::{PyAny, PyObject}; | ||
| use parking_lot::Mutex; | ||
| use std::future::Future; | ||
| use std::pin::Pin; | ||
| use std::sync::Arc; | ||
| use std::task::{Context, Poll, Waker}; | ||
|
|
||
| #[derive(Debug, Default)] | ||
| struct Inner { | ||
| exception: Option<PyObject>, | ||
| waker: Option<Waker>, | ||
| } | ||
|
|
||
| /// Helper used to wait and retrieve exception thrown in [`Coroutine`](super::Coroutine). | ||
| /// | ||
| /// Only the last exception thrown can be retrieved. | ||
| #[derive(Debug, Default)] | ||
| pub struct CancelHandle(Arc<Mutex<Inner>>); | ||
|
|
||
| impl CancelHandle { | ||
| /// Create a new `CoroutineCancel`. | ||
| pub fn new() -> Self { | ||
| Default::default() | ||
| } | ||
|
|
||
| /// Returns whether the associated coroutine has been cancelled. | ||
| pub fn is_cancelled(&self) -> bool { | ||
| self.0.lock().exception.is_some() | ||
| } | ||
|
|
||
| /// Poll to retrieve the exception thrown in the associated coroutine. | ||
| pub fn poll_cancelled(&mut self, cx: &mut Context<'_>) -> Poll<PyObject> { | ||
| let mut inner = self.0.lock(); | ||
| if let Some(exc) = inner.exception.take() { | ||
| return Poll::Ready(exc); | ||
| } | ||
| if let Some(ref waker) = inner.waker { | ||
| if cx.waker().will_wake(waker) { | ||
| return Poll::Pending; | ||
| } | ||
| } | ||
| inner.waker = Some(cx.waker().clone()); | ||
| Poll::Pending | ||
| } | ||
|
|
||
| /// Retrieve the exception thrown in the associated coroutine. | ||
| pub async fn cancelled(&mut self) -> PyObject { | ||
| Cancelled(self).await | ||
| } | ||
|
|
||
| #[doc(hidden)] | ||
| pub fn throw_callback(&self) -> ThrowCallback { | ||
| ThrowCallback(self.0.clone()) | ||
| } | ||
| } | ||
|
|
||
| // Because `poll_fn` is not available in MSRV | ||
| struct Cancelled<'a>(&'a mut CancelHandle); | ||
|
|
||
| impl Future for Cancelled<'_> { | ||
| type Output = PyObject; | ||
| fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { | ||
| self.0.poll_cancelled(cx) | ||
| } | ||
| } | ||
|
|
||
| #[doc(hidden)] | ||
| pub struct ThrowCallback(Arc<Mutex<Inner>>); | ||
|
|
||
| impl ThrowCallback { | ||
| pub(super) fn throw(&self, exc: &PyAny) { | ||
| let mut inner = self.0.lock(); | ||
| inner.exception = Some(exc.into()); | ||
| if let Some(waker) = inner.waker.take() { | ||
| waker.wake(); | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,18 @@ | ||
| use std::future::Future; | ||
|
|
||
| use crate::coroutine::cancel::ThrowCallback; | ||
| use crate::{coroutine::Coroutine, types::PyString, IntoPy, PyErr, PyObject}; | ||
|
|
||
| pub fn new_coroutine<F, T, E>( | ||
| name: &PyString, | ||
| qualname_prefix: Option<&'static str>, | ||
| throw_callback: Option<ThrowCallback>, | ||
| future: F, | ||
| ) -> Coroutine | ||
| where | ||
| F: Future<Output = Result<T, E>> + Send + 'static, | ||
| T: IntoPy<PyObject>, | ||
| E: Into<PyErr>, | ||
| { | ||
| Coroutine::new(Some(name.into()), qualname_prefix, future) | ||
| Coroutine::new(Some(name.into()), qualname_prefix, throw_callback, future) | ||
| } |
Oops, something went wrong.