Apply __bool__ conversion only to numpy.bool_ to avoid false positives.

newsfragments/3638.changed.md

@@ -1 +1 @@
-Values of type `bool` can now be extracted from all Python values defining a `__bool__` magic method.
+Values of type `bool` can now be extracted from NumPy's `bool_`.

pytests/src/misc.rs

@@ -12,9 +12,15 @@ fn get_type_full_name(obj: &PyAny) -> PyResult<Cow<'_, str>> {
     obj.get_type().name()
 }
 
+#[pyfunction]
+fn accepts_bool(val: bool) -> bool {
+    val
+}
+
 #[pymodule]
 pub fn misc(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(issue_219, m)?)?;
     m.add_function(wrap_pyfunction!(get_type_full_name, m)?)?;
+    m.add_function(wrap_pyfunction!(accepts_bool, m)?)?;
     Ok(())
 }

pytests/tests/test_misc.py

@@ -54,3 +54,13 @@ def test_type_full_name_includes_module():
     numpy = pytest.importorskip("numpy")
 
     assert pyo3_pytests.misc.get_type_full_name(numpy.bool_(True)) == "numpy.bool_"
+
+
+def test_accepts_numpy_bool():
+    # binary numpy wheel not available on all platforms
+    numpy = pytest.importorskip("numpy")
+
+    assert pyo3_pytests.misc.accepts_bool(True) is True
+    assert pyo3_pytests.misc.accepts_bool(False) is False
+    assert pyo3_pytests.misc.accepts_bool(numpy.bool_(True)) is True
+    assert pyo3_pytests.misc.accepts_bool(numpy.bool_(False)) is False

src/types/boolobject.rs

@@ -77,10 +77,16 @@ impl IntoPy<PyObject> for bool {
 /// Fails with `TypeError` if the input is not a Python `bool`.
 impl<'source> FromPyObject<'source> for bool {
     fn extract(obj: &'source PyAny) -> PyResult<Self> {
-        if let Ok(obj) = obj.downcast::<PyBool>() {
+        let err = match obj.downcast::<PyBool>() {
-            return Ok(obj.is_true());
+            Ok(obj) => return Ok(obj.is_true()),
-        }
+            Err(err) => err,
+        };
 
+        if obj
+            .get_type()
+            .name()
+            .map_or(false, |name| name == "numpy.bool_")
+        {
             let missing_conversion = |obj: &PyAny| {
                 PyTypeError::new_err(format!(
                     "object of type '{}' does not define a '__bool__' conversion",
@@ -102,7 +108,7 @@ impl<'source> FromPyObject<'source> for bool {
                     }
                 }
 
-            Err(missing_conversion(obj))
+                return Err(missing_conversion(obj));
             }
 
             #[cfg(any(Py_LIMITED_API, PyPy))]
@@ -112,10 +118,13 @@ impl<'source> FromPyObject<'source> for bool {
                     .ok_or_else(|| missing_conversion(obj))?;
 
                 let obj = meth.call0()?.downcast::<PyBool>()?;
-            Ok(obj.is_true())
+                return Ok(obj.is_true());
             }
         }
 
+        Err(err.into())
+    }
+
     #[cfg(feature = "experimental-inspect")]
     fn type_input() -> TypeInfo {
         Self::type_output()
@@ -124,7 +133,7 @@ impl<'source> FromPyObject<'source> for bool {
 
 #[cfg(test)]
 mod tests {
-    use crate::types::{PyAny, PyBool, PyModule};
+    use crate::types::{PyAny, PyBool};
     use crate::Python;
     use crate::ToPyObject;
 
@@ -147,48 +156,4 @@ mod tests {
             assert!(false.to_object(py).is(PyBool::new(py, false)));
         });
     }
-
-    #[test]
-    fn test_magic_method() {
-        Python::with_gil(|py| {
-            let module = PyModule::from_code(
-                py,
-                r#"
-class A:
-    def __bool__(self): return True
-class B:
-    def __bool__(self): return "not a bool"
-class C:
-    def __len__(self): return 23
-class D:
-    pass
-                "#,
-                "test.py",
-                "test",
-            )
-            .unwrap();
-
-            let a = module.getattr("A").unwrap().call0().unwrap();
-            assert!(a.extract::<bool>().unwrap());
-
-            let b = module.getattr("B").unwrap().call0().unwrap();
-            assert!(matches!(
-                &*b.extract::<bool>().unwrap_err().to_string(),
-                "TypeError: 'str' object cannot be converted to 'PyBool'"
-                    | "TypeError: __bool__ should return bool, returned str"
-            ));
-
-            let c = module.getattr("C").unwrap().call0().unwrap();
-            assert_eq!(
-                c.extract::<bool>().unwrap_err().to_string(),
-                "TypeError: object of type '<class 'test.C'>' does not define a '__bool__' conversion",
-            );
-
-            let d = module.getattr("D").unwrap().call0().unwrap();
-            assert_eq!(
-                d.extract::<bool>().unwrap_err().to_string(),
-                "TypeError: object of type '<class 'test.D'>' does not define a '__bool__' conversion",
-            );
-        });
-    }
 }