Struct PyWeakrefReference

#[repr(transparent)]
pub struct PyWeakrefReference(PyAny);

Represents a Python weakref.ReferenceType.

In Python this is created by calling weakref.ref.

Tuple Fields

0: PyAny

Implementations

impl PyWeakrefReference

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

impl PyWeakrefReference

pub fn new<'py>( object: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyWeakrefReference>>

Constructs a new Weak Reference (weakref.ref/weakref.ReferenceType) for the given object.

Returns a TypeError if object is not weak referenceable (Most native types and PyClasses without weakref flag).

Examples

use pyo3::prelude::*;
use pyo3::types::PyWeakrefReference;

#[pyclass(weakref)]
struct Foo { /* fields omitted */ }

Python::with_gil(|py| {
    let foo = Bound::new(py, Foo {})?;
    let weakref = PyWeakrefReference::new(&foo)?;
    assert!(
        // In normal situations where a direct `Bound<'py, Foo>` is required use `upgrade::<Foo>`
        weakref.upgrade()
            .map_or(false, |obj| obj.is(&foo))
    );

    let weakref2 = PyWeakrefReference::new(&foo)?;
    assert!(weakref.is(&weakref2));

    drop(foo);

    assert!(weakref.upgrade().is_none());
    Ok(())
})

pub fn new_bound<'py>( object: &Bound<'py, PyAny>, ) -> PyResult<Bound<'py, PyWeakrefReference>>

👎Deprecated since 0.23.0: renamed to PyWeakrefReference::new

Deprecated name for PyWeakrefReference::new.

pub fn new_with<'py, C>( object: &Bound<'py, PyAny>, callback: C, ) -> PyResult<Bound<'py, PyWeakrefReference>>

where C: IntoPyObject<'py>,

Constructs a new Weak Reference (weakref.ref/weakref.ReferenceType) for the given object with a callback.

Returns a TypeError if object is not weak referenceable (Most native types and PyClasses without weakref flag) or if the callback is not callable or None.

Examples

use pyo3::prelude::*;
use pyo3::types::PyWeakrefReference;
use pyo3::ffi::c_str;

#[pyclass(weakref)]
struct Foo { /* fields omitted */ }

#[pyfunction]
fn callback(wref: Bound<'_, PyWeakrefReference>) -> PyResult<()> {
        let py = wref.py();
        assert!(wref.upgrade_as::<Foo>()?.is_none());
        py.run(c_str!("counter = 1"), None, None)
}

Python::with_gil(|py| {
    py.run(c_str!("counter = 0"), None, None)?;
    assert_eq!(py.eval(c_str!("counter"), None, None)?.extract::<u32>()?, 0);
    let foo = Bound::new(py, Foo{})?;

    // This is fine.
    let weakref = PyWeakrefReference::new_with(&foo, py.None())?;
    assert!(weakref.upgrade_as::<Foo>()?.is_some());
    assert!(
        // In normal situations where a direct `Bound<'py, Foo>` is required use `upgrade::<Foo>`
        weakref.upgrade()
            .map_or(false, |obj| obj.is(&foo))
    );
    assert_eq!(py.eval(c_str!("counter"), None, None)?.extract::<u32>()?, 0);

    let weakref2 = PyWeakrefReference::new_with(&foo, wrap_pyfunction!(callback, py)?)?;
    assert!(!weakref.is(&weakref2)); // Not the same weakref
    assert!(weakref.eq(&weakref2)?);  // But Equal, since they point to the same object

    drop(foo);

    assert!(weakref.upgrade_as::<Foo>()?.is_none());
    assert_eq!(py.eval(c_str!("counter"), None, None)?.extract::<u32>()?, 1);
    Ok(())
})

pub fn new_bound_with<'py, C>( object: &Bound<'py, PyAny>, callback: C, ) -> PyResult<Bound<'py, PyWeakrefReference>>

where C: ToPyObject,

👎Deprecated since 0.23.0: renamed to PyWeakrefReference::new_with

Deprecated name for PyWeakrefReference::new_with.

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsRef<PyAny> for PyWeakrefReference

fn as_ref(&self) -> &PyAny

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyWeakrefReference

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyClassBaseType for PyWeakrefReference

Available on non-Py_LIMITED_API only.

type LayoutAsBase = PyClassObjectBase<_PyWeakReference>

type BaseNativeType = PyWeakrefReference

type Initializer = PyNativeTypeInitializer<PyWeakrefReference>

type PyClassMutability = ImmutableClass

impl PyTypeInfo for PyWeakrefReference

const NAME: &'static str = "PyWeakrefReference"

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 is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Returns the safe abstraction over the type object.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::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.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyWeakrefReference

impl PyLayout<PyWeakrefReference> for PyWeakReference

impl PySizedLayout<PyWeakrefReference> for PyWeakReference