Merge #2979

2979: allow `create_exception!` to place the exception in a `dotted.module` r=adamreichold a=davidhewitt Closes #2946 Credit fully to `@BlueGlassBlock` Co-authored-by: David Hewitt <[email protected]>
PyO3 · Feb 22, 2023 · 7cffc92 · 7cffc92
2 parents 12ce8d2 + f239d2d
commit 7cffc92
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/newsfragments/2979.changed.md b/newsfragments/2979.changed.md
@@ -0,0 +1 @@
+Allow `create_exception!` to take a `dotted.module` to place the exception in a submodule.
diff --git a/src/exceptions.rs b/src/exceptions.rs
@@ -201,7 +201,7 @@ macro_rules! import_exception {
 ///
 #[macro_export]
 macro_rules! create_exception {
-    ($module: ident, $name: ident, $base: ty) => {
+    ($module: expr, $name: ident, $base: ty) => {
         #[repr(transparent)]
         #[allow(non_camel_case_types)] // E.g. `socket.herror`
         pub struct $name($crate::PyAny);
@@ -210,7 +210,7 @@ macro_rules! create_exception {
 
         $crate::create_exception_type_object!($module, $name, $base, ::std::option::Option::None);
     };
-    ($module: ident, $name: ident, $base: ty, $doc: expr) => {
+    ($module: expr, $name: ident, $base: ty, $doc: expr) => {
         #[repr(transparent)]
         #[allow(non_camel_case_types)] // E.g. `socket.herror`
         #[doc = $doc]
@@ -232,7 +232,7 @@ macro_rules! create_exception {
 #[doc(hidden)]
 #[macro_export]
 macro_rules! create_exception_type_object {
-    ($module: ident, $name: ident, $base: ty, $doc: expr) => {
+    ($module: expr, $name: ident, $base: ty, $doc: expr) => {
         $crate::pyobject_native_type_core!(
             $name,
             *$name::type_object_raw($crate::Python::assume_gil_acquired()),
@@ -876,6 +876,24 @@ mod tests {
         });
     }
 
+    #[test]
+    fn custom_exception_dotted_module() {
+        create_exception!(mymodule.exceptions, CustomError, PyException);
+        Python::with_gil(|py| {
+            let error_type = py.get_type::<CustomError>();
+            let ctx = [("CustomError", error_type)].into_py_dict(py);
+            let type_description: String = py
+                .eval("str(CustomError)", None, Some(ctx))
+                .unwrap()
+                .extract()
+                .unwrap();
+            assert_eq!(
+                type_description,
+                "<class 'mymodule.exceptions.CustomError'>"
+            );
+        });
+    }
+
     #[test]
     fn custom_exception_doc() {
         create_exception!(mymodule, CustomError, PyException, "Some docs");
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Allow `create_exception!` to take a `dotted.module` to place the exception in a submodule.