JP-3728: Deprecate Step.__call__ (#8761)

changes/8761.stpipe.rst

@@ -0,0 +1 @@
+Add warning that ``Step.__call__`` is deprecated.

jwst/extract_2d/tests/test_grisms.py

@@ -209,7 +209,7 @@ def test_create_box_fits():
  # Add fake data to pass a shape to wfss_imaging_wcs
  im.data = np.zeros((512, 512))
  aswcs = AssignWcsStep()
- imwcs = aswcs(im)
+ imwcs = aswcs.run(im)
  imwcs.meta.source_catalog = source_catalog
  refs = get_reference_files(im)
  test_boxes = create_grism_bbox(imwcs, refs,
@@ -242,7 +242,7 @@ def test_create_box_gwcs():
  # The data array is not relevant
  im.data = np.zeros((512, 512))
  aswcs = AssignWcsStep()
- imwcs = aswcs(im)
+ imwcs = aswcs.run(im)
  imwcs.meta.source_catalog = source_catalog
  refs = get_reference_files(im)
  test_boxes = create_grism_bbox(imwcs, refs,
@@ -268,7 +268,7 @@ def setup_image_cat():
  im.data = np.zeros((512, 512))
  im.meta.source_catalog = source_catalog
  aswcs = AssignWcsStep()
- imwcs = aswcs(im)
+ imwcs = aswcs.run(im)
  refs = get_reference_files(im)
 
  return imwcs, refs

jwst/stpipe/core.py

@@ -3,6 +3,7 @@
 """
 from functools import wraps
 import logging
+import warnings
 
 from stdatamodels.jwst.datamodels import JwstDataModel
 from stdatamodels.jwst import datamodels
@@ -102,6 +103,19 @@ def run(self, *args, **kwargs):
  log.info(f"Results used jwst version: {__version__}")
  return result
 
+ @wraps(Step.__call__)
+ def __call__(self, *args, **kwargs):
+ if not self.parent:
+ warnings.warn(
+ "Step.__call__ is deprecated. It is equivalent to Step.run "
+ "and is not recommended. See "
+ "https://jwst-pipeline.readthedocs.io/en/latest/jwst/"
+ "user_documentation/running_pipeline_python.html"
+ "#advanced-use-pipeline-run-vs-pipeline-call for more details.",
+ UserWarning
+ )
+ return super().__call__(*args, **kwargs)
+
 
 # JwstPipeline needs to inherit from Pipeline, but also
 # be a subclass of JwstStep so that it will pass checks

jwst/stpipe/tests/test_step.py

@@ -623,3 +623,9 @@ def test_finalize_logging(monkeypatch):
  monkeypatch.setattr(logging.getLogger("jwst.stpipe.core"), "info", watcher)
  pipeline.run(model)
  assert watcher.seen
+
+
+def test_dunder_call_warning():
+ pipeline = EmptyPipeline()
+ with pytest.warns(UserWarning, match="Step.__call__ is deprecated"):
+ pipeline(None)

jwst/tweakreg/tests/test_tweakreg.py

@@ -193,7 +193,7 @@ def test_tweakreg_step(example_input, with_shift):
  step = tweakreg_step.TweakRegStep()
 
  # run the step on the example input modified above
- result = step(example_input)
+ result = step.run(example_input)
 
  # check that step completed
  with result:
@@ -227,7 +227,7 @@ def test_src_confusion_pars(example_input, alignment_type):
  "abs_refcat": REFCAT,
  }
  step = tweakreg_step.TweakRegStep(**pars)
- result = step(example_input)
+ result = step.run(example_input)
 
  # check that step was skipped
  with result:
@@ -356,7 +356,7 @@ def patched_construct_wcs_corrector(wcs, wcsinfo, catalog, group_id, _seen=[]):
  monkeypatch.setattr(twk, "construct_wcs_corrector", patched_construct_wcs_corrector)
 
  with pytest.raises(ValueError, match="done testing"):
- step(str(asn_path))
+ step.run(str(asn_path))
 
 
 @pytest.mark.parametrize("with_shift", [True, False])
@@ -384,7 +384,7 @@ def test_sip_approx(example_input, with_shift):
  step.sip_npoints = 12
 
  # run the step on the example input modified above
- result = step(example_input)
+ result = step.run(example_input)
 
  with result:
  r0 = result.borrow(0)