Merge pull request #81 from kngwyu/to-owned

Return Py<T> in to_owned

Author: kngwyu

README.md

@@ -115,7 +115,7 @@ extern crate pyo3;
 
 use ndarray::{ArrayD, ArrayViewD, ArrayViewMutD};
 use numpy::{IntoPyArray, PyArrayDyn};
-use pyo3::prelude::{pymodinit, PyModule, PyResult, Python};
+use pyo3::prelude::{pymodinit, Py, PyModule, PyResult, Python};
 
 #[pymodinit]
 fn rust_ext(_py: Python, m: &PyModule) -> PyResult<()> {
@@ -136,12 +136,10 @@ fn rust_ext(_py: Python, m: &PyModule) -> PyResult<()> {
         a: f64,
         x: &PyArrayDyn<f64>,
         y: &PyArrayDyn<f64>,
-    ) -> PyResult<PyArrayDyn<f64>> {
-        // you can convert numpy error into PyErr via ?
+    ) -> Py<PyArrayDyn<f64>> {
         let x = x.as_array();
-        // you can also specify your error context, via closure
         let y = y.as_array();
-        Ok(axpy(a, x, y).into_pyarray(py).to_owned(py))
+        axpy(a, x, y).into_pyarray(py).to_owned()
     }
 
     // wrapper of `mult`

examples/simple-extension/src/lib.rs

@@ -4,7 +4,7 @@ extern crate pyo3;
 
 use ndarray::{ArrayD, ArrayViewD, ArrayViewMutD};
 use numpy::{IntoPyArray, PyArrayDyn};
-use pyo3::prelude::{pymodinit, PyModule, PyResult, Python};
+use pyo3::prelude::{pymodinit, Py, PyModule, PyResult, Python};
 
 #[pymodinit]
 fn rust_ext(_py: Python, m: &PyModule) -> PyResult<()> {
@@ -25,12 +25,10 @@ fn rust_ext(_py: Python, m: &PyModule) -> PyResult<()> {
         a: f64,
         x: &PyArrayDyn<f64>,
         y: &PyArrayDyn<f64>,
-    ) -> PyResult<PyArrayDyn<f64>> {
-        // you can convert numpy error into PyErr via ?
+    ) -> Py<PyArrayDyn<f64>> {
         let x = x.as_array();
-        // you can also specify your error context, via closure
         let y = y.as_array();
-        Ok(axpy(a, x, y).into_pyarray(py).to_owned(py))
+        axpy(a, x, y).into_pyarray(py).to_owned()
     }
 
     // wrapper of `mult`

src/array.rs

@@ -146,29 +146,28 @@ impl<T, D> PyArray<T, D> {
         self.as_ptr() as _
     }
 
-    // TODO: 'increasing ref counts' is really collect approach for extension?
-    /// Get `PyArray` from `&PyArray`, by increasing ref counts.
+    /// Get `Py<PyArray>` from `&PyArray`, which is the owned wrapper of PyObject.
     ///
     /// You can use this method when you have to avoid lifetime annotation to your function args
     /// or return types, like used with pyo3's `pymethod`.
     ///
     /// # Example
     /// ```
     /// # extern crate pyo3; extern crate numpy; fn main() {
-    /// use pyo3::{GILGuard, Python};
+    /// use pyo3::{GILGuard, Python, Py, AsPyRef};
     /// use numpy::PyArray1;
-    /// fn return_py_array() -> PyArray1<i32> {
+    /// fn return_py_array() -> Py<PyArray1<i32>> {
     ///    let gil = Python::acquire_gil();
     ///    let array = PyArray1::zeros(gil.python(), [5], false);
-    ///    array.to_owned(gil.python())
+    ///    array.to_owned()
     /// }
+    /// let gil = Python::acquire_gil();
     /// let array = return_py_array();
-    /// assert_eq!(array.as_slice(), &[0, 0, 0, 0, 0]);
+    /// assert_eq!(array.as_ref(gil.python()).as_slice(), &[0, 0, 0, 0, 0]);
     /// # }
     /// ```
-    pub fn to_owned(&self, py: Python) -> Self {
-        let obj = unsafe { PyObject::from_borrowed_ptr(py, self.as_ptr()) };
-        PyArray(obj, PhantomData, PhantomData)
+    pub fn to_owned(&self) -> Py<Self> {
+        unsafe { Py::from_borrowed_ptr(self.as_ptr()) }
     }
 
     /// Constructs `PyArray` from raw python object without incrementing reference counts.