Introspection: improve exception support (#5710)

- Fixes type hint of exception (do not swap module and name)
- When an exception is included in a module, consider it as incomplete (we don't generate stubs for exceptions yet)

Author: Tpt

newsfragments/5710.fixed.md

@@ -0,0 +1,2 @@
+- Correct `PyTypeInfo::TYPE_HINT` on user exceptions that was swapping module and name
+- Stub generation: tag modules containing exception as incomplete (we do not generate stubs for exceptions yet)

pyo3-introspection/src/introspection.rs

@@ -72,18 +72,25 @@ fn convert_module(
     id: &str,
     name: &str,
     members: &[String],
-    incomplete: bool,
+    mut incomplete: bool,
     chunks_by_id: &HashMap<&str, &Chunk>,
     chunks_by_parent: &HashMap<&str, Vec<&Chunk>>,
 ) -> Result<Module> {
-    let (modules, classes, functions, attributes) = convert_members(
-        members
-            .iter()
-            .filter_map(|id| chunks_by_id.get(id.as_str()).copied())
-            .chain(chunks_by_parent.get(&id).into_iter().flatten().copied()),
-        chunks_by_id,
-        chunks_by_parent,
-    )?;
+    let mut member_chunks = chunks_by_parent
+        .get(&id)
+        .into_iter()
+        .flatten()
+        .copied()
+        .collect::<Vec<_>>();
+    for member in members {
+        if let Some(c) = chunks_by_id.get(member.as_str()) {
+            member_chunks.push(*c);
+        } else {
+            incomplete = true; // We don't find an element
+        }
+    }
+    let (modules, classes, functions, attributes) =
+        convert_members(member_chunks, chunks_by_id, chunks_by_parent)?;
 
     Ok(Module {
         name: name.into(),

pytests/src/exception.rs

@@ -0,0 +1,38 @@
+use pyo3::create_exception;
+use pyo3::exceptions::PyValueError;
+use pyo3::prelude::*;
+
+create_exception!(pytests.exception, MyValueError, PyValueError);
+
+#[pymodule(gil_used = false)]
+pub mod exception {
+    use pyo3::exceptions::PyValueError;
+    use pyo3::prelude::*;
+
+    #[pymodule_export]
+    use super::MyValueError;
+
+    #[pyfunction]
+    fn raise_my_value_error() -> PyResult<()> {
+        Err(MyValueError::new_err("error"))
+    }
+
+    #[pyfunction]
+    fn return_value_error<'py>(py: Python<'py>) -> PyResult<Bound<'py, PyValueError>> {
+        Ok(PyValueError::new_err("error")
+            .into_pyobject(py)?
+            .cast_into()?)
+    }
+
+    #[pyfunction]
+    fn return_my_value_error<'py>(py: Python<'py>) -> PyResult<Bound<'py, MyValueError>> {
+        Ok(MyValueError::new_err("error")
+            .into_pyobject(py)?
+            .cast_into()?)
+    }
+
+    #[pyfunction]
+    fn return_pyerr() -> PyErr {
+        MyValueError::new_err("error")
+    }
+}

pytests/src/lib.rs

@@ -9,6 +9,7 @@ mod consts;
 pub mod datetime;
 pub mod dict_iter;
 pub mod enums;
+mod exception;
 pub mod misc;
 pub mod objstore;
 pub mod othermod;
@@ -27,8 +28,8 @@ mod pyo3_pytests {
     use buf_and_str::buf_and_str;
     #[pymodule_export]
     use {
-        comparisons::comparisons, consts::consts, enums::enums, pyclasses::pyclasses,
-        pyfunctions::pyfunctions, subclassing::subclassing,
+        comparisons::comparisons, consts::consts, enums::enums, exception::exception,
+        pyclasses::pyclasses, pyfunctions::pyfunctions, subclassing::subclassing,
     };
 
     // Inserting to sys.modules allows importing submodules nicely from Python

pytests/stubs/exception.pyi

@@ -0,0 +1,8 @@
+from _typeshed import Incomplete
+from pytests.exception import MyValueError
+
+def raise_my_value_error() -> None: ...
+def return_my_value_error() -> MyValueError: ...
+def return_pyerr() -> BaseException: ...
+def return_value_error() -> ValueError: ...
+def __getattr__(name: str) -> Incomplete: ...

src/exceptions.rs

@@ -207,8 +207,8 @@ macro_rules! create_exception_type_object {
         $crate::pyobject_native_type_core!(
             $name,
             $name::type_object_raw,
-            stringify!($name),
             stringify!($module),
+            stringify!($name),
             #module=::std::option::Option::Some(stringify!($module))
         );