Added warning for deprecated function inputs

stytra/stimulation/__init__.py

@@ -1,5 +1,6 @@
 import datetime
 from copy import deepcopy
+import warnings
 
 from PyQt5.QtCore import pyqtSignal, QTimer, QObject
 from stytra.stimulation.stimuli import Pause, DynamicStimulus
@@ -112,7 +113,12 @@ def update_protocol(self):
 
         # pass experiment to stimuli for calibrator and asset folders:
         for stimulus in self.stimuli:
-            stimulus.initialise_external(self.experiment, self.experiment.calibrator)
+            try:
+                stimulus.initialise_external(self.experiment, self.experiment.calibrator)
+            except TypeError:
+                stimulus.initialise_external(self.experiment)
+                warnings.warn("Warning: 'initialise_external' will require a calibrator input from the new update!", FutureWarning)
+                warnings.warn("Warning: 'initialise_external' will require a calibrator input from the new update!", DeprecationWarning)
 
         if self.dynamic_log is None:
             self.dynamic_log = DynamicLog(self.stimuli, experiment=self.experiment)

stytra/stimulation/stimuli/generic_stimuli.py

@@ -1,5 +1,6 @@
 import numpy as np
 import datetime
+import warnings
 
 
 class Stimulus:
@@ -112,7 +113,7 @@ def stop(self):
         """
         pass
 
-    def initialise_external(self, experiment, calibrator = None):
+    def initialise_external(self, experiment, calibrator = -999):
         """ Make a reference to the Experiment class inside the Stimulus.
         This is required to access from inside the Stimulus class to the
         Calibrator, the Pyboard, the asset directories with movies or the motor
@@ -131,8 +132,18 @@ def initialise_external(self, experiment, calibrator = None):
             None
 
         """
+
+        if calibrator == -999:
+            self._calibrator = self._experiment.calibrator
+            warnings.warn("Warning: 'initialise_external' will require a calibrator input from the new update!", FutureWarning)
+            warnings.warn("Warning: 'initialise_external' will require a calibrator input from the new update!", DeprecationWarning)
+        else:
+            self._calibrator = calibrator
+
+
         self._experiment = experiment #! TOFIX: Remove
-        self._calibrator = calibrator
+
+
 
 
 class DynamicStimulus(Stimulus):