Merge pull request #140 from PyO3/unsafe-mut

Introduce PyReadOnlyArray

Author: kngwyu

.gitignore

@@ -8,6 +8,10 @@ rusty-tags.*
 # More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock
 Cargo.lock
 
-# cargo fmt
-*.bk
-.tox/
+# Some Python specific files
+.tox/
+build/
+*.so
+*.egg-info/
+**/dist/
+__pycache__

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 - v0.10.0
   - Remove `ErrorKind` and introduce some concrete error types
+  - `PyArray::as_slice`, `PyArray::as_slice_mut`, `PyArray::as_array`, and `PyArray::as_array_mut` is now unsafe.
+  - Introduce `PyArray::as_cell_slice`, `PyArray::to_vec`, and `PyArray::to_owned_array`
 
 - v0.9.0
   - Update PyO3 to 0.10.0

Cargo.toml

@@ -23,3 +23,6 @@ default = []
 # This is no longer needed but setuptools-rust assumes this feature
 python3 = ["pyo3/python3"]
 
+
+[workspace]
+members = ["examples/*"]

README.md

@@ -83,7 +83,8 @@ fn main_<'py>(py: Python<'py>) -> PyResult<()> {
     let pyarray: &PyArray1<i32> = py
         .eval("np.absolute(np.array([-1, -2, -3], dtype='int32'))", Some(&dict), None)?
         .extract()?;
-    let slice = pyarray.as_slice()?;
+    let readonly = pyarray.readonly();
+    let slice = readonly.as_slice().unwrap();
     assert_eq!(slice, &[1, 2, 3]);
     Ok(())
 }
@@ -109,38 +110,38 @@ features = ["extension-module"]
 
 ```rust
 use ndarray::{ArrayD, ArrayViewD, ArrayViewMutD};
-use numpy::{IntoPyArray, PyArrayDyn};
-use pyo3::prelude::{pymodule, Py, PyModule, PyResult, Python};
+use numpy::{IntoPyArray, PyArrayDyn, PyReadonlyArrayDyn};
+use pyo3::prelude::{pymodule, PyModule, PyResult, Python};
 
 #[pymodule]
-fn rust_ext(_py: Python, m: &PyModule) -> PyResult<()> {
+fn rust_ext(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
     // immutable example
-    fn axpy(a: f64, x: ArrayViewD<f64>, y: ArrayViewD<f64>) -> ArrayD<f64> {
+    fn axpy(a: f64, x: ArrayViewD<'_, f64>, y: ArrayViewD<'_, f64>) -> ArrayD<f64> {
         a * &x + &y
     }
 
     // mutable example (no return)
-    fn mult(a: f64, mut x: ArrayViewMutD<f64>) {
+    fn mult(a: f64, mut x: ArrayViewMutD<'_, f64>) {
         x *= a;
     }
 
     // wrapper of `axpy`
     #[pyfn(m, "axpy")]
-    fn axpy_py(
-        py: Python,
+    fn axpy_py<'py>(
+        py: Python<'py>,
         a: f64,
-        x: &PyArrayDyn<f64>,
-        y: &PyArrayDyn<f64>,
-    ) -> Py<PyArrayDyn<f64>> {
+        x: PyReadonlyArrayDyn<f64>,
+        y: PyReadonlyArrayDyn<f64>,
+    ) -> &'py PyArrayDyn<f64> {
         let x = x.as_array();
         let y = y.as_array();
-        axpy(a, x, y).into_pyarray(py).to_owned()
+        axpy(a, x, y).into_pyarray(py)
     }
 
     // wrapper of `mult`
     #[pyfn(m, "mult")]
-    fn mult_py(_py: Python, a: f64, x: &PyArrayDyn<f64>) -> PyResult<()> {
-        let x = x.as_array_mut();
+    fn mult_py(_py: Python<'_>, a: f64, x: &PyArrayDyn<f64>) -> PyResult<()> {
+        let x = unsafe { x.as_array_mut() };
         mult(a, x);
         Ok(())
     }

examples/.gitignore

@@ -1,6 +1,6 @@
 use ndarray::{ArrayD, ArrayViewD, ArrayViewMutD};
-use numpy::{IntoPyArray, PyArrayDyn};
-use pyo3::prelude::{pymodule, Py, PyModule, PyResult, Python};
+use numpy::{IntoPyArray, PyArrayDyn, PyReadonlyArrayDyn};
+use pyo3::prelude::{pymodule, PyModule, PyResult, Python};
 
 #[pymodule]
 fn rust_ext(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
@@ -16,21 +16,21 @@ fn rust_ext(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
 
     // wrapper of `axpy`
     #[pyfn(m, "axpy")]
-    fn axpy_py(
-        py: Python<'_>,
+    fn axpy_py<'py>(
+        py: Python<'py>,
         a: f64,
-        x: &PyArrayDyn<f64>,
-        y: &PyArrayDyn<f64>,
-    ) -> Py<PyArrayDyn<f64>> {
+        x: PyReadonlyArrayDyn<f64>,
+        y: PyReadonlyArrayDyn<f64>,
+    ) -> &'py PyArrayDyn<f64> {
         let x = x.as_array();
         let y = y.as_array();
-        axpy(a, x, y).into_pyarray(py).to_owned()
+        axpy(a, x, y).into_pyarray(py)
     }
 
     // wrapper of `mult`
     #[pyfn(m, "mult")]
     fn mult_py(_py: Python<'_>, a: f64, x: &PyArrayDyn<f64>) -> PyResult<()> {
-        let x = x.as_array_mut();
+        let x = unsafe { x.as_array_mut() };
         mult(a, x);
         Ok(())
     }