pyo3/types/
ellipsis.rs

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

pyo3/types/
ellipsis.rs
