luxolus
/
pyo3
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3657 from PyO3/is-truthy 

Transition is_true to is_truthy to clarify that the test is not based on identity with or equality to the True singleton.
This commit is contained in:
Adam Reichold 2023-12-16 13:16:49 +00:00 committed by GitHub
parent 867a273afc ced97f80d1
commit ff50285d1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
newsfragments/3657.changed.md Normal file
View File

@ -0,0 +1 @@
Changed `.is_true` to `.is_truthy` on `PyAny` and `Py<PyAny>` to clarify that the test is not based on identity with or equality to the True singleton.

8
src/instance.rs
View File

@ -787,7 +787,15 @@ impl<T> Py<T> {
/// Returns whether the object is considered to be true.
///
/// This is equivalent to the Python expression `bool(self)`.
#[deprecated(since = "0.21.0", note = "use `.is_truthy()` instead")]
pub fn is_true(&self, py: Python<'_>) -> PyResult<bool> {
self.is_truthy(py)
}
/// Returns whether the object is considered to be true.
///
/// This applies truth value testing equivalent to the Python expression `bool(self)`.
pub fn is_truthy(&self, py: Python<'_>) -> PyResult<bool> {
let v = unsafe { ffi::PyObject_IsTrue(self.as_ptr()) };
err::error_on_minusone(py, v)?;
Ok(v != 0)

34
src/types/any.rs
View File

@ -306,7 +306,7 @@ impl PyAny {
/// Python::with_gil(|py| -> PyResult<()> {
/// let a: &PyInt = 0_u8.into_py(py).into_ref(py).downcast()?;
/// let b: &PyInt = 42_u8.into_py(py).into_ref(py).downcast()?;
/// assert!(a.rich_compare(b, CompareOp::Le)?.is_true()?);
/// assert!(a.rich_compare(b, CompareOp::Le)?.is_truthy()?);
/// Ok(())
/// })?;
/// # Ok(())}
@ -640,8 +640,16 @@ impl PyAny {
/// Returns whether the object is considered to be true.
///
/// This is equivalent to the Python expression `bool(self)`.
#[deprecated(since = "0.21.0", note = "use `.is_truthy()` instead")]
pub fn is_true(&self) -> PyResult<bool> {
Py2::borrowed_from_gil_ref(&self).is_true()
self.is_truthy()
}
/// Returns whether the object is considered to be true.
///
/// This applies truth value testing equivalent to the Python expression `bool(self)`.
pub fn is_truthy(&self) -> PyResult<bool> {
Py2::borrowed_from_gil_ref(&self).is_truthy()
}
/// Returns whether the object is considered to be None.
@ -1165,7 +1173,7 @@ pub(crate) trait PyAnyMethods<'py> {
/// Python::with_gil(|py| -> PyResult<()> {
/// let a: &PyInt = 0_u8.into_py(py).into_ref(py).downcast()?;
/// let b: &PyInt = 42_u8.into_py(py).into_ref(py).downcast()?;
/// assert!(a.rich_compare(b, CompareOp::Le)?.is_true()?);
/// assert!(a.rich_compare(b, CompareOp::Le)?.is_truthy()?);
/// Ok(())
/// })?;
/// # Ok(())}
@ -1452,7 +1460,7 @@ pub(crate) trait PyAnyMethods<'py> {
/// Returns whether the object is considered to be true.
///
/// This is equivalent to the Python expression `bool(self)`.
fn is_true(&self) -> PyResult<bool>;
fn is_truthy(&self) -> PyResult<bool>;
/// Returns whether the object is considered to be None.
///
@ -1773,7 +1781,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
let do_compare = |other, op| unsafe {
ffi::PyObject_RichCompare(any.as_ptr(), other, op)
.assume_owned_or_err(any.py())
.and_then(|obj| obj.is_true())
.and_then(|obj| obj.is_truthy())
};
if do_compare(other, ffi::Py_EQ)? {
Ok(Ordering::Equal)
@ -1816,7 +1824,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
O: ToPyObject,
{
self.rich_compare(other, CompareOp::Lt)
.and_then(|any| any.is_true())
.and_then(|any| any.is_truthy())
}
fn le<O>(&self, other: O) -> PyResult<bool>
@ -1824,7 +1832,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
O: ToPyObject,
{
self.rich_compare(other, CompareOp::Le)
.and_then(|any| any.is_true())
.and_then(|any| any.is_truthy())
}
fn eq<O>(&self, other: O) -> PyResult<bool>
@ -1832,7 +1840,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
O: ToPyObject,
{
self.rich_compare(other, CompareOp::Eq)
.and_then(|any| any.is_true())
.and_then(|any| any.is_truthy())
}
fn ne<O>(&self, other: O) -> PyResult<bool>
@ -1840,7 +1848,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
O: ToPyObject,
{
self.rich_compare(other, CompareOp::Ne)
.and_then(|any| any.is_true())
.and_then(|any| any.is_truthy())
}
fn gt<O>(&self, other: O) -> PyResult<bool>
@ -1848,7 +1856,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
O: ToPyObject,
{
self.rich_compare(other, CompareOp::Gt)
.and_then(|any| any.is_true())
.and_then(|any| any.is_truthy())
}
fn ge<O>(&self, other: O) -> PyResult<bool>
@ -1856,7 +1864,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
O: ToPyObject,
{
self.rich_compare(other, CompareOp::Ge)
.and_then(|any| any.is_true())
.and_then(|any| any.is_truthy())
}
fn is_callable(&self) -> bool {
@ -1948,7 +1956,7 @@ impl<'py> PyAnyMethods<'py> for Py2<'py, PyAny> {
self.call_method(name, args, None)
}
fn is_true(&self) -> PyResult<bool> {
fn is_truthy(&self) -> PyResult<bool> {
let v = unsafe { ffi::PyObject_IsTrue(self.as_ptr()) };
err::error_on_minusone(self.py(), v)?;
Ok(v != 0)
@ -2554,7 +2562,7 @@ class SimpleClass:
assert!(!py_int
.rich_compare(py_str, CompareOp::Eq)
.unwrap()
.is_true()
.is_truthy()
.unwrap());
})
}

4
tests/test_proto_methods.rs
View File

@ -159,9 +159,9 @@ fn test_hash() {
fn test_bool() {
Python::with_gil(|py| {
let example_py = make_example(py);
assert!(example_py.is_true().unwrap());
assert!(example_py.is_truthy().unwrap());
example_py.borrow_mut().value = 0;
assert!(!example_py.is_true().unwrap());
assert!(!example_py.is_truthy().unwrap());
})
}