pyo3/conversions/std/
option.rs

1use crate::{
2    conversion::IntoPyObject, ffi, types::any::PyAnyMethods, AsPyPointer, Bound, BoundObject,
3    FromPyObject, PyAny, PyResult, Python,
4};
5
6impl<'py, T> IntoPyObject<'py> for Option<T>
7where
8    T: IntoPyObject<'py>,
9{
10    type Target = PyAny;
11    type Output = Bound<'py, Self::Target>;
12    type Error = T::Error;
13
14    fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {
15        self.map_or_else(
16            || Ok(py.None().into_bound(py)),
17            |val| {
18                val.into_pyobject(py)
19                    .map(BoundObject::into_any)
20                    .map(BoundObject::into_bound)
21            },
22        )
23    }
24}
25
26impl<'a, 'py, T> IntoPyObject<'py> for &'a Option<T>
27where
28    &'a T: IntoPyObject<'py>,
29{
30    type Target = PyAny;
31    type Output = Bound<'py, Self::Target>;
32    type Error = <&'a T as IntoPyObject<'py>>::Error;
33
34    #[inline]
35    fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error> {
36        self.as_ref().into_pyobject(py)
37    }
38}
39
40impl<'py, T> FromPyObject<'py> for Option<T>
41where
42    T: FromPyObject<'py>,
43{
44    fn extract_bound(obj: &Bound<'py, PyAny>) -> PyResult<Self> {
45        if obj.is_none() {
46            Ok(None)
47        } else {
48            obj.extract().map(Some)
49        }
50    }
51}
52
53/// Convert `None` into a null pointer.
54unsafe impl<T> AsPyPointer for Option<T>
55where
56    T: AsPyPointer,
57{
58    #[inline]
59    fn as_ptr(&self) -> *mut ffi::PyObject {
60        self.as_ref()
61            .map_or_else(std::ptr::null_mut, |t| t.as_ptr())
62    }
63}
64
65#[cfg(test)]
66mod tests {
67    use crate::{PyObject, Python};
68
69    #[test]
70    fn test_option_as_ptr() {
71        Python::with_gil(|py| {
72            use crate::AsPyPointer;
73            let mut option: Option<PyObject> = None;
74            assert_eq!(option.as_ptr(), std::ptr::null_mut());
75
76            let none = py.None();
77            option = Some(none.clone_ref(py));
78
79            let ref_cnt = none.get_refcnt(py);
80            assert_eq!(option.as_ptr(), none.as_ptr());
81
82            // Ensure ref count not changed by as_ptr call
83            assert_eq!(none.get_refcnt(py), ref_cnt);
84        });
85    }
86}
pyo3/conversions/std/option.rs

pyo3/conversions/std/
option.rs
