Skip to content

Commit

Permalink
implement PyBoolMethods
Browse files Browse the repository at this point in the history
  • Loading branch information
davidhewitt committed Dec 14, 2023
1 parent 79a54cf commit 2a07edc
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
1 change: 1 addition & 0 deletions src/prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ pub use crate::wrap_pyfunction;
// Expected to become public API in 0.21
// pub(crate) use crate::instance::Py2; // Will be stabilized with a different name
// pub(crate) use crate::types::any::PyAnyMethods;
// pub(crate) use crate::types::boolobject::PyBoolMethods;
// pub(crate) use crate::types::sequence::PySequenceMethods;
22 changes: 21 additions & 1 deletion src/types/boolobject.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#[cfg(feature = "experimental-inspect")]
use crate::inspect::types::TypeInfo;
use crate::{ffi, FromPyObject, IntoPy, PyAny, PyObject, PyResult, Python, ToPyObject};
use crate::{
ffi, instance::Py2, FromPyObject, IntoPy, PyAny, PyObject, PyResult, Python, ToPyObject,
};

/// Represents a Python `bool`.
#[repr(transparent)]
Expand All @@ -18,6 +20,24 @@ impl PyBool {
/// Gets whether this boolean is `true`.
#[inline]
pub fn is_true(&self) -> bool {
Py2::<PyBool>::borrowed_from_gil_ref(&self).is_true()
}
}

/// Implementation of functionality for [`PyBool`].
///
/// These methods are defined for the `Py2<'py, PyBool>` smart pointer, so to use method call
/// syntax these methods are separated into a trait, because stable Rust does not yet support
/// `arbitrary_self_types`.
#[doc(alias = "PyBool")]
pub trait PyBoolMethods<'py> {
/// Gets whether this boolean is `true`.
fn is_true(&self) -> bool;
}

impl<'py> PyBoolMethods<'py> for Py2<'py, PyBool> {
#[inline]
fn is_true(&self) -> bool {
self.as_ptr() == unsafe { crate::ffi::Py_True() }
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/types/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ macro_rules! pyobject_native_type {
}

pub(crate) mod any;
mod boolobject;
pub(crate) mod boolobject;
mod bytearray;
mod bytes;
mod capsule;
Expand Down

0 comments on commit 2a07edc

Please sign in to comment.