Merge pull request #308 from PyO3/datetime

Add support for datetime64 and timedelta64 element types

Author: adamreichold

CHANGELOG.md

@@ -4,11 +4,13 @@
   - Add dynamic borrow checking to safely construct references into the interior of NumPy arrays. ([#274](https://github.com/PyO3/rust-numpy/pull/274))
     - The deprecated iterator builders `NpySingleIterBuilder::{readonly,readwrite}` and `NpyMultiIterBuilder::add_{readonly,readwrite}` now take referencces to `PyReadonlyArray` and `PyReadwriteArray` instead of consuming them.
     - The destructive `PyArray::resize` method is now unsafe if used without an instance of `PyReadwriteArray`. ([#302](https://github.com/PyO3/rust-numpy/pull/302))
+  - Add support for `datetime64` and `timedelta64` element types via the `datetime` module. ([#308](https://github.com/PyO3/rust-numpy/pull/308))
   - Add support for IEEE 754-2008 16-bit floating point numbers via an optional dependency on the `half` crate. ([#314](https://github.com/PyO3/rust-numpy/pull/314))
   - The `inner`, `dot` and `einsum` functions can also return a scalar instead of a zero-dimensional array to match NumPy's types ([#285](https://github.com/PyO3/rust-numpy/pull/285))
   - The `PyArray::resize` function supports n-dimensional contiguous arrays. ([#312](https://github.com/PyO3/rust-numpy/pull/312))
   - Deprecate `PyArray::from_exact_iter` after optimizing `PyArray::from_iter`. ([#292](https://github.com/PyO3/rust-numpy/pull/292))
   - Remove `DimensionalityError` and `TypeError` from the public API as they never used directly. ([#315](https://github.com/PyO3/rust-numpy/pull/315))
+  - Remove the deprecated `PyArrayDescr::get_type` which was replaced by `PyArrayDescr::typeobj` in the last cycle. ([#308](https://github.com/PyO3/rust-numpy/pull/308))
   - Fix returning invalid slices from `PyArray::{strides,shape}` for rank zero arrays. ([#303](https://github.com/PyO3/rust-numpy/pull/303))
 
 - v0.16.2

examples/simple/src/lib.rs

@@ -1,6 +1,8 @@
-use numpy::ndarray::{ArrayD, ArrayViewD, ArrayViewMutD};
+use numpy::ndarray::{ArrayD, ArrayViewD, ArrayViewMutD, Zip};
 use numpy::{
-    Complex64, IntoPyArray, PyArray1, PyArrayDyn, PyReadonlyArrayDyn, PyReadwriteArrayDyn,
+    datetime::{units, Timedelta},
+    Complex64, IntoPyArray, PyArray1, PyArrayDyn, PyReadonlyArray1, PyReadonlyArrayDyn,
+    PyReadwriteArray1, PyReadwriteArrayDyn,
 };
 use pyo3::{
     pymodule,
@@ -70,5 +72,17 @@ fn rust_ext(_py: Python<'_>, m: &PyModule) -> PyResult<()> {
         x.readonly().as_array().sum()
     }
 
+    // example using timedelta64 array
+    #[pyfn(m)]
+    fn add_minutes_to_seconds(
+        mut x: PyReadwriteArray1<Timedelta<units::Seconds>>,
+        y: PyReadonlyArray1<Timedelta<units::Minutes>>,
+    ) {
+        #[allow(deprecated)]
+        Zip::from(x.as_array_mut())
+            .and(y.as_array())
+            .apply(|x, y| *x = (i64::from(*x) + 60 * i64::from(*y)).into());
+    }
+
     Ok(())
 }

examples/simple/tests/test_ext.py

@@ -1,5 +1,5 @@
 import numpy as np
-from rust_ext import axpy, conj, mult, extract
+from rust_ext import axpy, conj, mult, extract, add_minutes_to_seconds
 
 
 def test_axpy():
@@ -24,3 +24,12 @@ def test_extract():
     x = np.arange(5.0)
     d = {"x": x}
     np.testing.assert_almost_equal(extract(d), 10.0)
+
+
+def test_add_minutes_to_seconds():
+    x = np.array([10, 20, 30], dtype="timedelta64[s]")
+    y = np.array([1, 2, 3], dtype="timedelta64[m]")
+
+    add_minutes_to_seconds(x, y)
+
+    assert np.all(x == np.array([70, 140, 210], dtype="timedelta64[s]"))