Struct PyPythonTask 

pub struct PyPythonTask { /* private fields */ }

Python-visible wrapper for a one-shot PythonTask.

Exposed to Python as monarch._rust_bindings.monarch_hyperactor.pytokio.PythonTask. This object owns the underlying Rust task and is consumed when it is run (e.g. via spawn(), spawn_abortable(), or block_on()), hence inner: Option<_>.

Implementations

impl PyPythonTask

pub fn new<F, T>(fut: F) -> PyResult<Self>

where F: Future<Output = PyResult<T>> + Send + 'static, T: for<'py> IntoPyObject<'py> + Send,

Construct a PythonTask, capturing a creation-site traceback if enabled.

See new_with_traceback for conversion semantics (T -> Python object under the GIL).

impl PyPythonTask

pub fn take_task( &mut self, ) -> PyResult<Pin<Box<dyn Future<Output = Result<Py<PyAny>, PyErr>> + Send + 'static>>>

Consume this PythonTask and return the underlying Rust future.

This is a one-shot operation: after calling take_task, the PyPythonTask is considered consumed and cannot be spawned/awaited/blocked-on again.

Trait Implementations

impl<'py> IntoPyObject<'py> for PyPythonTask

type Target = PyPythonTask

The Python output type

type Output = Bound<'py, <PyPythonTask as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyPythonTask

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyPythonTask

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Python-visible wrapper for a one-shot `PythonTask`. /// /// Exposed to Python as /// `monarch._rust_bindings.monarch_hyperactor.pytokio.PythonTask`. /// This object owns the underlying Rust task and is *consumed* when /// it is run (e.g. via `spawn()`, `spawn_abortable()`, or /// `block_on()`), hence `inner: Option<_>`.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyPythonTask>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyPythonTask

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder PyPythonTask

type Holder = Option<PyClassGuard<'a, PyPythonTask>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut PyPythonTask

type Holder = Option<PyClassGuardMut<'a, PyPythonTask>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyTypeInfo for PyPythonTask

const NAME: &'static str = "PythonTask"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PyPythonTask