Ensure returned arrays are not writeable

Author: AlexanderWells-diamond

CHANGELOG.rst

@@ -23,6 +23,7 @@ Removed:
 Changed:
 
 - `AsyncioDispatcher cleanup tasks atexit <../../pull/138>`_
+- `Ensure returned numpy arrays are not writeable <../../pull/164>`_
 
 Fixed:
 

softioc/device.py

@@ -467,7 +467,12 @@ def _value_to_epics(self, value):
         # common class of bug, at the cost of duplicated code and data, here we
         # ensure a copy is taken of the value.
         assert len(value) <= self._nelm, 'Value too long for waveform'
-        return numpy.copy(value)
+
+        value = numpy.copy(value)
+        # As we return a reference to the numpy array, ensure it cannot be
+        # modified under our noses
+        value.flags.writeable = False
+        return value
 
     def _epics_to_value(self, value):
         if self._dtype.char == 'S':

tests/test_records.py

@@ -340,6 +340,19 @@ def test_record_wrapper_str():
     # If we never receive R it probably means an assert failed
     select_and_recv(parent_conn, "R")
 
+def test_waveform_values_not_modifiable():
+    """Test that arrays returned from waveform records are not modifiable"""
+
+    wi = builder.WaveformIn("WI", [1, 2, 3])
+    wo = builder.WaveformOut("WO", [1, 2, 3])
+
+    with pytest.raises(ValueError):
+        wi.get()[0] = 5
+
+    with pytest.raises(ValueError):
+        wo.get()[0] = 5
+
+
 def validate_fixture_names(params):
     """Provide nice names for the out_records fixture in TestValidate class"""
     return params[0].__name__