pyo3/types/
notimplemented.rs

1use crate::{
2    ffi, ffi_ptr_ext::FfiPtrExt, types::any::PyAnyMethods, Borrowed, Bound, PyAny, PyTypeInfo,
3    Python,
4};
5
6/// Represents the Python `NotImplemented` object.
7///
8/// Values of this type are accessed via PyO3's smart pointers, e.g. as
9/// [`Py<PyNotImplemented>`][crate::Py] or [`Bound<'py, PyNotImplemented>`][Bound].
10#[repr(transparent)]
11pub struct PyNotImplemented(PyAny);
12
13pyobject_native_type_named!(PyNotImplemented);
14
15impl PyNotImplemented {
16    /// Returns the `NotImplemented` object.
17    #[inline]
18    pub fn get(py: Python<'_>) -> Borrowed<'_, '_, PyNotImplemented> {
19        unsafe {
20            ffi::Py_NotImplemented()
21                .assume_borrowed(py)
22                .downcast_unchecked()
23        }
24    }
25}
26
27unsafe impl PyTypeInfo for PyNotImplemented {
28    const NAME: &'static str = "NotImplementedType";
29    const MODULE: Option<&'static str> = None;
30
31    fn type_object_raw(_py: Python<'_>) -> *mut ffi::PyTypeObject {
32        unsafe { ffi::Py_TYPE(ffi::Py_NotImplemented()) }
33    }
34
35    #[inline]
36    fn is_type_of(object: &Bound<'_, PyAny>) -> bool {
37        // NotImplementedType is not usable as a base type
38        Self::is_exact_type_of(object)
39    }
40
41    #[inline]
42    fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool {
43        object.is(&**Self::get(object.py()))
44    }
45}
46
47#[cfg(test)]
48mod tests {
49    use crate::types::any::PyAnyMethods;
50    use crate::types::{PyDict, PyNotImplemented};
51    use crate::{PyTypeInfo, Python};
52
53    #[test]
54    fn test_notimplemented_is_itself() {
55        Python::with_gil(|py| {
56            assert!(PyNotImplemented::get(py).is_instance_of::<PyNotImplemented>());
57            assert!(PyNotImplemented::get(py).is_exact_instance_of::<PyNotImplemented>());
58        })
59    }
60
61    #[test]
62    fn test_notimplemented_type_object_consistent() {
63        Python::with_gil(|py| {
64            assert!(PyNotImplemented::get(py)
65                .get_type()
66                .is(&PyNotImplemented::type_object(py)));
67        })
68    }
69
70    #[test]
71    fn test_dict_is_not_notimplemented() {
72        Python::with_gil(|py| {
73            assert!(PyDict::new(py).downcast::<PyNotImplemented>().is_err());
74        })
75    }
76}
pyo3/types/notimplemented.rs

pyo3/types/
notimplemented.rs
