-
Notifications
You must be signed in to change notification settings - Fork 0
/
none.rs
122 lines (105 loc) · 3.15 KB
/
none.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
use crate::ffi_ptr_ext::FfiPtrExt;
use crate::{
ffi, types::any::PyAnyMethods, Borrowed, Bound, IntoPy, PyAny, PyObject, PyTypeInfo, Python,
ToPyObject,
};
/// Represents the Python `None` object.
#[repr(transparent)]
pub struct PyNone(PyAny);
pyobject_native_type_named!(PyNone);
pyobject_native_type_extract!(PyNone);
impl PyNone {
/// Returns the `None` object.
/// Deprecated form of [`PyNone::get_bound`]
#[cfg(feature = "gil-refs")]
#[deprecated(
since = "0.21.0",
note = "`PyNone::get` will be replaced by `PyNone::get_bound` in a future PyO3 version"
)]
#[inline]
pub fn get(py: Python<'_>) -> &PyNone {
Self::get_bound(py).into_gil_ref()
}
/// Returns the `None` object.
#[inline]
pub fn get_bound(py: Python<'_>) -> Borrowed<'_, '_, PyNone> {
unsafe { ffi::Py_None().assume_borrowed(py).downcast_unchecked() }
}
}
unsafe impl PyTypeInfo for PyNone {
const NAME: &'static str = "NoneType";
const MODULE: Option<&'static str> = None;
fn type_object_raw(_py: Python<'_>) -> *mut ffi::PyTypeObject {
unsafe { ffi::Py_TYPE(ffi::Py_None()) }
}
#[inline]
fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool {
// NoneType is not usable as a base type
Self::is_exact_type_of_bound(object)
}
#[inline]
fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool {
object.is(&**Self::get_bound(object.py()))
}
}
/// `()` is converted to Python `None`.
impl ToPyObject for () {
fn to_object(&self, py: Python<'_>) -> PyObject {
PyNone::get_bound(py).into_py(py)
}
}
impl IntoPy<PyObject> for () {
#[inline]
fn into_py(self, py: Python<'_>) -> PyObject {
PyNone::get_bound(py).into_py(py)
}
}
#[cfg(test)]
mod tests {
use crate::types::any::PyAnyMethods;
use crate::types::{PyDict, PyNone};
use crate::{IntoPy, PyObject, PyTypeInfo, Python, ToPyObject};
#[test]
fn test_none_is_itself() {
Python::with_gil(|py| {
assert!(PyNone::get_bound(py).is_instance_of::<PyNone>());
assert!(PyNone::get_bound(py).is_exact_instance_of::<PyNone>());
})
}
#[test]
fn test_none_type_object_consistent() {
Python::with_gil(|py| {
assert!(PyNone::get_bound(py)
.get_type()
.is(&PyNone::type_object_bound(py)));
})
}
#[test]
fn test_none_is_none() {
Python::with_gil(|py| {
assert!(PyNone::get_bound(py)
.downcast::<PyNone>()
.unwrap()
.is_none());
})
}
#[test]
fn test_unit_to_object_is_none() {
Python::with_gil(|py| {
assert!(().to_object(py).downcast_bound::<PyNone>(py).is_ok());
})
}
#[test]
fn test_unit_into_py_is_none() {
Python::with_gil(|py| {
let obj: PyObject = ().into_py(py);
assert!(obj.downcast_bound::<PyNone>(py).is_ok());
})
}
#[test]
fn test_dict_is_not_none() {
Python::with_gil(|py| {
assert!(PyDict::new_bound(py).downcast::<PyNone>().is_err());
})
}
}