Prepare BaseBlockScript for deprecation.

Description

Recently, BaseScript added support for the block metadata, which is now backed up by the script queue. This means the base class we used to add support for this metadata (BaseBlockScript) is no longer necessary. However, there are some functionality that it provides that is actually missing from the BaseScript, for example, setting up the block name (e.g. BLOCK-000 or BLOCK-T000), as the script only receives the unique id associated with the block (e.g. BL0_O_20240923_000001).

For that we should maintain the functionality provided by BaseBlockScript while still preparing to remove it in the future. Especially, we need to ensure the base script is no longer generating the unique id from the camera image server.

For this ticket we should make sure:

  1. A deprecation warning message is post for all usages of BaseBlockScript.

  2. The BaseBlockScript no longer generates the unique id, e.g., the get_obs_id method should just return None.

  3. We can remove the test case functionality, which we never use.

Issue Matrix

hide

Activity

Igor Suarez Sola 
April 30, 2025 at 5:01 PM

The BaseBlockScripts class is used in a bunch of scripts, deprecating it’s methods would also mean moving the below scripts to the salobj BaseScript class, is this within the scope of this ticket? Alternatively, I thought that setting a warning for now would be a interim solution. Please advice, thanks!

./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/enable_aos_closed_loop.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/check_actuators.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/enable_m1m3_balance_system.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/enable_m1m3_slew_controller_flags.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/lower_m1m3.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/check_hardpoint.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/disable_m1m3_balance_system.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m1m3/raise_m1m3.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/disable_aos_closed_loop.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/mtrotator/move_rotator.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/move_p2p.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/disable_hexapod_compensation_mode.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m2/disable_closed_loop.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m2/check_actuators.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/m2/enable_closed_loop.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/take_image_anycam.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/laser_tracker/measure.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/laser_tracker/align.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/laser_tracker/shut_down.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/laser_tracker/set_up.py
./ts_maintel_standardscripts/python/lsst/ts/maintel/standardscripts/enable_hexapod_compensation_mode.py
./ts_maintel_standardscripts/tests/test_maintel_raise_m1m3.py
./ts_maintel_standardscripts/tests/test_maintel_mtrotator_move_rotator.py
./ts_maintel_standardscripts/tests/test_maintel_m2_check_actuators.py
./ts_maintel_standardscripts/tests/test_maintel_disable_hexapod_compensation_mode.py
./ts_maintel_standardscripts/tests/test_maintel_point_azel.py
./ts_maintel_standardscripts/tests/test_maintel_m1m3_enable_m1m3_controller_flags.py
./ts_maintel_standardscripts/tests/test_maintel_m1m3_check_hardpoint.py
./ts_maintel_standardscripts/tests/test_maintel_m2_enable_closed_loop.py
./ts_maintel_standardscripts/tests/test_maintel_m2_disable_closed_loop.py
./ts_maintel_standardscripts/tests/test_maintel_move_p2p.py
./ts_maintel_standardscripts/tests/test_maintel_lower_m1m3.py
./ts_maintel_standardscripts/tests/test_maintel_disable_m1m3_balance_system.py
./ts_maintel_standardscripts/tests/test_maintel_enable_m1m3_balance_system.py
./ts_maintel_standardscripts/tests/test_maintel_m1m3_check_actuators.py
./ts_maintel_standardscripts/tests/test_maintel_track_target.py
./ts_maintel_standardscripts/tests/test_maintel_enable_hexapod_compensation_mode.py
./ts_standardscripts/python/lsst/ts/standardscripts/dummy_block_script.py
./ts_standardscripts/python/lsst/ts/standardscripts/base_point_azel.py
./ts_standardscripts/python/lsst/ts/standardscripts/base_block_script.py
./ts_standardscripts/python/lsst/ts/standardscripts/base_take_aos_sequence.py
./ts_standardscripts/python/lsst/ts/standardscripts/base_focus_sweep.py
./ts_standardscripts/python/lsst/ts/standardscripts/base_track_target.py
./ts_standardscripts/tests/test_base_block_script.py
./ts_externalscripts/python/lsst/ts/externalscripts/base_take_ptc_flats.py
./ts_externalscripts/python/lsst/ts/externalscripts/base_take_twilight_flats.py
./ts_externalscripts/python/lsst/ts/externalscripts/maintel/take_whitelight_flats_lsstcam.py
./ts_externalscripts/python/lsst/ts/externalscripts/maintel/tma/short_long_slews.py
./ts_externalscripts/python/lsst/ts/externalscripts/maintel/take_comcam_guider_image.py
./ts_externalscripts/python/lsst/ts/externalscripts/base_parameter_march.py
./ts_externalscripts/python/lsst/ts/externalscripts/base_make_calibrations.py
./ts_externalscripts/tests/test_base_make_calibrations.py
./ts_externalscripts/tests/auxtel/test_make_latiss_calibrations.py
./ts_externalscripts/tests/maintel/test_make_lsstcam_calibrations.py
./ts_externalscripts/tests/maintel/test_make_comcam_calibrations.py
./ts_auxtel_standardscripts/python/lsst/ts/auxtel/standardscripts/calibrations/run_calibration_sequence.py
./ts_auxtel_standardscripts/tests/test_auxtel_point_azel.py

Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Reviewers

Erik Dennihy

RubinTeam

Checklist

Created September 23, 2024 at 11:26 PM
Updated May 5, 2025 at 8:13 PM