Update class.md - add example of new returning a PyResult (#1688)

* Update class.md - add example of `new` returning a `PyResult` * Update class.md
PyO3 · Jun 23, 2021 · 13cd092 · 13cd092
1 parent dc66afa
commit 13cd092
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/guide/src/class.md b/guide/src/class.md
@@ -169,6 +169,23 @@ impl MyClass {
 }
 ```
 
+Alternatively, if your `new` method may fail you can return `PyResult<Self>`.
+```rust
+# use pyo3::prelude::*;
+#[pyclass]
+struct MyClass {
+    num: i32,
+}
+
+#[pymethods]
+impl MyClass {
+    #[new]
+    fn new(num: i32) -> PyResult<Self> {
+        Ok(MyClass { num })
+    }
+}
+```
+
 If no method marked with `#[new]` is declared, object instances can only be
 created from Rust, but not from Python.