Skip to content

Commit

Permalink
Add types for built-in singletons
Browse files Browse the repository at this point in the history
None, Ellipsis, and NotImplemented
  • Loading branch information
rytheo committed Aug 18, 2023
1 parent 9363491 commit ecadc62
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 17 deletions.
13 changes: 0 additions & 13 deletions src/conversion.rs
Original file line number Diff line number Diff line change
Expand Up @@ -263,19 +263,6 @@ where
}
}

/// `()` is converted to Python `None`.
impl ToPyObject for () {
fn to_object(&self, py: Python<'_>) -> PyObject {
py.None()
}
}

impl IntoPy<PyObject> for () {
fn into_py(self, py: Python<'_>) -> PyObject {
py.None()
}
}

impl<T> IntoPy<PyObject> for &'_ T
where
T: AsPyPointer,
Expand Down
10 changes: 6 additions & 4 deletions src/marker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@
use crate::err::{self, PyDowncastError, PyErr, PyResult};
use crate::gil::{GILGuard, GILPool, SuspendGIL};
use crate::impl_::not_send::NotSend;
use crate::types::{PyAny, PyDict, PyModule, PyString, PyType};
use crate::types::{
PyAny, PyDict, PyEllipsis, PyModule, PyNone, PyNotImplemented, PyString, PyType,
};
use crate::version::PythonVersionInfo;
use crate::{ffi, FromPyPointer, IntoPy, Py, PyNativeType, PyObject, PyTryFrom, PyTypeInfo};
use std::ffi::{CStr, CString};
Expand Down Expand Up @@ -690,21 +692,21 @@ impl<'py> Python<'py> {
#[allow(non_snake_case)] // the Python keyword starts with uppercase
#[inline]
pub fn None(self) -> PyObject {
unsafe { PyObject::from_borrowed_ptr(self, ffi::Py_None()) }
PyNone::get(self).into()
}

/// Gets the Python builtin value `Ellipsis`, or `...`.
#[allow(non_snake_case)] // the Python keyword starts with uppercase
#[inline]
pub fn Ellipsis(self) -> PyObject {
unsafe { PyObject::from_borrowed_ptr(self, ffi::Py_Ellipsis()) }
PyEllipsis::get(self).into()
}

/// Gets the Python builtin value `NotImplemented`.
#[allow(non_snake_case)] // the Python keyword starts with uppercase
#[inline]
pub fn NotImplemented(self) -> PyObject {
unsafe { PyObject::from_borrowed_ptr(self, ffi::Py_NotImplemented()) }
PyNotImplemented::get(self).into()
}

/// Gets the running Python interpreter version as a string.
Expand Down
19 changes: 19 additions & 0 deletions src/types/ellipsis.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
use crate::{ffi, PyAny, Python};

/// Represents the Python `Ellipsis` object.
#[repr(transparent)]
pub struct PyEllipsis(PyAny);

pyobject_native_type!(
PyEllipsis,
ffi::PyObject,
pyobject_native_static_type_object!(ffi::PyEllipsis_Type)
);

impl PyEllipsis {
/// Returns the `Ellipsis` object.
#[inline]
pub fn get(py: Python<'_>) -> &PyEllipsis {
unsafe { py.from_borrowed_ptr(ffi::Py_Ellipsis()) }
}
}
6 changes: 6 additions & 0 deletions src/types/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ pub use self::datetime::{
pub use self::dict::{IntoPyDict, PyDict};
#[cfg(not(PyPy))]
pub use self::dict::{PyDictItems, PyDictKeys, PyDictValues};
pub use self::ellipsis::PyEllipsis;
pub use self::floatob::PyFloat;
#[cfg(all(not(Py_LIMITED_API), not(PyPy)))]
pub use self::frame::PyFrame;
Expand All @@ -27,6 +28,8 @@ pub use self::iterator::PyIterator;
pub use self::list::PyList;
pub use self::mapping::PyMapping;
pub use self::module::PyModule;
pub use self::none::PyNone;
pub use self::notimplemented::PyNotImplemented;
pub use self::num::PyLong;
pub use self::num::PyLong as PyInt;
#[cfg(not(PyPy))]
Expand Down Expand Up @@ -278,6 +281,7 @@ mod complex;
#[cfg(not(Py_LIMITED_API))]
mod datetime;
mod dict;
mod ellipsis;
mod floatob;
#[cfg(all(not(Py_LIMITED_API), not(PyPy)))]
mod frame;
Expand All @@ -287,6 +291,8 @@ mod iterator;
pub(crate) mod list;
mod mapping;
mod module;
mod none;
mod notimplemented;
mod num;
#[cfg(not(PyPy))]
mod pysuper;
Expand Down
33 changes: 33 additions & 0 deletions src/types/none.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
use crate::{ffi, IntoPy, PyAny, PyObject, Python, ToPyObject};

/// Represents the Python `None` object.
#[repr(transparent)]
pub struct PyNone(PyAny);

pyobject_native_type!(
PyNone,
ffi::PyObject,
pyobject_native_static_type_object!(ffi::_PyNone_Type)
);

impl PyNone {
/// Returns the `None` object.
#[inline]
pub fn get(py: Python<'_>) -> &PyNone {
unsafe { py.from_borrowed_ptr(ffi::Py_None()) }
}
}

/// `()` is converted to Python `None`.
impl ToPyObject for () {
fn to_object(&self, py: Python<'_>) -> PyObject {
PyNone::get(py).into()
}
}

impl IntoPy<PyObject> for () {
#[inline]
fn into_py(self, py: Python<'_>) -> PyObject {
PyNone::get(py).into()
}
}
19 changes: 19 additions & 0 deletions src/types/notimplemented.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
use crate::{ffi, PyAny, Python};

/// Represents the Python `NotImplemented` object.
#[repr(transparent)]
pub struct PyNotImplemented(PyAny);

pyobject_native_type!(
PyNotImplemented,
ffi::PyObject,
pyobject_native_static_type_object!(ffi::_PyNotImplemented_Type)
);

impl PyNotImplemented {
/// Returns the `NotImplemented` object.
#[inline]
pub fn get(py: Python<'_>) -> &PyNotImplemented {
unsafe { py.from_borrowed_ptr(ffi::Py_NotImplemented()) }
}
}

0 comments on commit ecadc62

Please sign in to comment.