ScriptQueue¶

class lsst.ts.scriptqueue.ScriptQueue(index, initial_state=State.STANDBY, standardpath=None, externalpath=None, verbose=False)¶

Bases: lsst.ts.salobj.base_csc.BaseCsc

CSC to load and configure scripts, so they can be run.

Parameters

indexint

ScriptQueue SAL component index:

1 for the Main telescope.
2 for AuxTel.
Any allowed value (see Raises) for unit tests.

initial_statelsst.ts.salobj.State or int, optional

The initial state of the CSC.

standardpathstr, bytes or os.PathLike (optional)

Path to standard SAL scripts. If None then use lsst.ts.standardscripts.get_scripts_dir().

externalpathstr, bytes or os.PathLike (optional)

Path to external SAL scripts. If None then use lsst.ts.externalscripts.get_scripts_dir().

verbosebool

If True then print diagnostic messages to stdout.

Raises

ValueError: If index < 0 or > MAX_SAL_INDEX//100,000 - 1. If standardpath or externalpath is not an existing directory.

Attributes Summary

`default_initial_state`
`disabled_or_enabled`	Return True if the summary state is `State.DISABLED` or `State.ENABLED`.
`domain`
`enable_cmdline_state`
`require_settings`
`simulation_help`
`simulation_mode`	Get the current simulation mode.
`summary_state`	Get the summary state as a `State` enum.
`valid_simulation_modes`
`version`

Methods Summary

`add_arguments`(parser)
`add_kwargs_from_args`(args, kwargs)
`amain`(index, **kwargs)	Make a CSC from command-line arguments and run it.
`assert_enabled`([action])	Assert that an action that requires ENABLED state can be run.
`begin_disable`(data)	Begin do_disable; called before state changes.
`begin_enable`(data)	Begin do_enable; called before state changes.
`begin_exitControl`(data)	Begin do_exitControl; called before state changes.
`begin_standby`(data)	Begin do_standby; called before the state changes.
`begin_start`(data)	Begin do_start; called before state changes.
`close`([exception, cancel_start])	Shut down, clean up resources and set done_task done.
`close_tasks`()	Shut down the queue, terminate all scripts and free resources.
`do_add`(data)	Add a script to the queue.
`do_disable`(data)	Transition from `State.ENABLED` to `State.DISABLED`.
`do_enable`(data)	Transition from `State.DISABLED` to `State.ENABLED`.
`do_exitControl`(data)	Transition from `State.STANDBY` to `State.OFFLINE` and quit.
`do_move`(data)	Move a script within the queue.
`do_pause`(data)	Pause the queue.
`do_requeue`(data)	Put a script back on the queue with the same configuration.
`do_resume`(data)	Run the queue.
`do_setAuthList`(data)	Update the authorization list.
`do_setLogLevel`(data)	Set logging level.
`do_showAvailableScripts`([data])	Output a list of available scripts.
`do_showQueue`(data)	Output the queue event.
`do_showSchema`(data)	Output the config schema for a script.
`do_showScript`(data)	Output the script event for one script.
`do_standby`(data)	Transition from `State.DISABLED` or `State.FAULT` to `State.STANDBY`.
`do_start`(data)	Transition from `State.STANDBY` to `State.DISABLED`.
`do_stopScripts`(data)	Stop one or more queued scripts and/or the current script.
`end_disable`(data)	End do_disable; called after state changes but before command acknowledged.
`end_enable`(data)	End do_enable; called after state changes but before command acknowledged.
`end_exitControl`(data)	End do_exitControl; called after state changes but before command acknowledged.
`end_standby`(data)	End do_standby; called after state changes but before command acknowledged.
`end_start`(data)	End do_start; called after state changes but before command acknowledged.
`fault`(code, report[, traceback])	Enter the fault state and output the `errorCode` event.
`handle_summary_state`()	Called when the summary state has changed.
`implement_simulation_mode`(simulation_mode)	Implement going into or out of simulation mode.
`make_from_cmd_line`(index, **kwargs)	Construct a CSC from command line arguments.
`put_log_level`()	Output the logLevel event.
`put_next_visit`(script_info)	Output the `nextVisit` event.
`put_next_visit_canceled`(script_info)	Output the `nextVisitCanceled` event.
`put_queue`()	Output the queued scripts as a `queue` event.
`put_script`(script_info[, force_output])	Output information about a script as a `script` event.
`report_summary_state`()	Report a new value for summary_state, including current state.
`set_simulation_mode`(simulation_mode)	Set the simulation mode.
`start`()	Finish creating the script queue.

Attributes Documentation

default_initial_state: State = 5¶

disabled_or_enabled¶

Return True if the summary state is State.DISABLED or State.ENABLED.

This is useful in handle_summary_state to determine if you should start or stop a telemetry loop, and connect to or disconnect from an external controller

domain¶

enable_cmdline_state = True¶

require_settings: bool = False¶

simulation_help: typing.Optional[str] = None¶

simulation_mode¶

Get the current simulation mode.

0 means normal operation (no simulation).

Raises

ExpectedError: If the new simulation mode is not a supported value.

summary_state¶: Get the summary state as a State enum.

valid_simulation_modes: typing.Optional[typing.Sequence[int]] = [0]¶

version = '?'¶

Methods Documentation

classmethod add_arguments(parser)¶

classmethod add_kwargs_from_args(args, kwargs)¶

async classmethod amain(index: Optional[Union[int, enum.IntEnum, bool]], **kwargs: Any) → None¶

Make a CSC from command-line arguments and run it.

Parameters

indexint, enum.IntEnum, True, or None

If the CSC is indexed, do one of the following:

Specify True to make index a required command-line argument that accepts any nonzero index.
Specify an enum.IntEnum class to make index a required command-line argument that only accepts the enum values.
Specify a non-zero integer to use that index. This is rare; if the CSC is indexed then the user should usually be allowed to specify the index.

If the CSC is not indexed, specify None or 0.

**kwargsdict, optional

Additional keyword arguments for your CSC’s constructor.

assert_enabled(action: str = '') → None¶

Assert that an action that requires ENABLED state can be run.

Parameters

actionstr, optional: Action attempted. Not needed if this is called at the beginning of a do_... method, since the user will know what command was called.

async begin_disable(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Begin do_disable; called before state changes.

Parameters

dataDataType: Command data

async begin_enable(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Begin do_enable; called before state changes.

Parameters

dataDataType: Command data

async begin_exitControl(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Begin do_exitControl; called before state changes.

Parameters

dataDataType: Command data

async begin_standby(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Begin do_standby; called before the state changes.

Parameters

dataDataType: Command data

async begin_start(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Begin do_start; called before state changes.

Parameters

dataDataType: Command data

async close(exception: Optional[Exception] = None, cancel_start: bool = True) → None¶

Shut down, clean up resources and set done_task done.

May be called multiple times. The first call closes the Controller; subsequent calls wait until the Controller is closed.

Subclasses should override close_tasks instead of close, unless you have a good reason to do otherwise.

Parameters

exceptionException, optional: The exception that caused stopping, if any, in which case the self.done_task exception is set to this value. Specify None for a normal exit, in which case the self.done_task result is set to None.
cancel_startbool, optional: Cancel the start task? Leave this true unless calling this from the start task.

Notes

Removes the SAL log handler, calls close_tasks to stop all background tasks, pauses briefly to allow final SAL messages to be sent, then closes the dds domain.

async close_tasks()¶: Shut down the queue, terminate all scripts and free resources.

async do_add(data)¶

Add a script to the queue.

Start and configure a script SAL component, but don’t run it.

On success the result field of the final acknowledgement contains str(index) where index is the SAL index of the added Script.

async do_disable(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Transition from State.ENABLED to State.DISABLED.

Parameters

datacmd_disable.DataType: Command data

async do_enable(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Transition from State.DISABLED to State.ENABLED.

Parameters

datacmd_enable.DataType: Command data

async do_exitControl(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Transition from State.STANDBY to State.OFFLINE and quit.

Parameters

datacmd_exitControl.DataType: Command data

do_move(data)¶: Move a script within the queue.

do_pause(data)¶

Pause the queue. A no-op if already paused.

Unlike most commands, this can be issued in any state.

Parameters

datacmd_pause.DataType (optional): Command data. Ignored.

async do_requeue(data)¶: Put a script back on the queue with the same configuration.

do_resume(data)¶

Run the queue. A no-op if already running.

Parameters

datacmd_resume.DataType (optional): Command data. Ignored.

do_setAuthList(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Update the authorization list.

Parameters

datacmd_setAuthList.DataType: Authorization lists.

Notes

Add items if the data string starts with “+”, ignoring duplicates (both with respect to the existing items and within the data string). Remove items if the data string starts with “-”, ignoring missing items (items specified for removal that do not exist). Ignore whitespace after each comma and after the +/- prefix.

do_setLogLevel(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Set logging level.

Parameters

datacmd_setLogLevel.DataType: Logging level.

do_showAvailableScripts(data=None)¶

Output a list of available scripts.

Parameters

datacmd_showAvailableScripts.DataType: Command data. Ignored.

do_showQueue(data)¶

Output the queue event.

Parameters

datacmd_showQueue.DataType (optional): Command data. Ignored.

async do_showSchema(data)¶

Output the config schema for a script.

Parameters

datacmd_showSchema.DataType: Command data specifying the script.

do_showScript(data)¶

Output the script event for one script.

Parameters

datacmd_showScript.DataType (optional): Command data. Ignored.

async do_standby(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Transition from State.DISABLED or State.FAULT to State.STANDBY.

Parameters

datacmd_standby.DataType: Command data

async do_start(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

Transition from State.STANDBY to State.DISABLED.

Parameters

datacmd_start.DataType: Command data

async do_stopScripts(data)¶

Stop one or more queued scripts and/or the current script.

If you stop the current script, it is moved to the history. If you stop queued scripts they are not not moved to the history.

async end_disable(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

End do_disable; called after state changes but before command acknowledged.

Parameters

dataDataType: Command data

async end_enable(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

End do_enable; called after state changes but before command acknowledged.

Parameters

dataDataType: Command data

async end_exitControl(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

End do_exitControl; called after state changes but before command acknowledged.

Parameters

dataDataType: Command data

async end_standby(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

End do_standby; called after state changes but before command acknowledged.

Parameters

dataDataType: Command data

async end_start(data: lsst.ts.salobj.type_hints.BaseDdsDataType) → None¶

End do_start; called after state changes but before command acknowledged.

Parameters

dataDataType: Command data

fault(code: Optional[int], report: str, traceback: str = '') → None¶

Enter the fault state and output the errorCode event.

Parameters

codeint: Error code for the errorCode event. If None then errorCode is not output and you should output it yourself. Specifying None is deprecated; please always specify an integer error code.
reportstr: Description of the error.
tracebackstr, optional: Description of the traceback, if any.

async handle_summary_state() → None¶

Called when the summary state has changed.

Override to perform tasks such as starting and stopping telemetry (example).

Notes

The versions in BaseCsc and ConfigurableCsc do nothing, so if you subclass one of those you do not need to call await super().handle_summary_state().

async implement_simulation_mode(simulation_mode: int) → None¶

Implement going into or out of simulation mode.

Deprecated. See simulation mode for details.

Parameters

simulation_modeint: Requested simulation mode; 0 for normal operation.

Raises

ExpectedError: If simulation_mode is not a supported value.

classmethod make_from_cmd_line(index: Optional[Union[int, enum.IntEnum, bool]], **kwargs: Any) → lsst.ts.salobj.base_csc.BaseCsc¶

Construct a CSC from command line arguments.

Parameters

indexint, enum.IntEnum, True, or None

If the CSC is indexed, do one of the following:

Specify True to make index a required command-line argument that accepts any nonzero index.
Specify an enum.IntEnum class to make index a required command-line argument that only accepts the enum values.
Specify a non-zero integer to use that index. This is rare; if the CSC is indexed then the user should usually be allowed to specify the index.

If the CSC is not indexed, specify None or 0.

**kwargsdict, optional

Additional keyword arguments for your CSC’s constructor.

Returns

csccls: The CSC.

Notes

To add additional command-line arguments, override add_arguments and add_kwargs_from_args.

put_log_level() → None¶: Output the logLevel event.

put_next_visit(script_info)¶: Output the nextVisit event.

put_next_visit_canceled(script_info)¶: Output the nextVisitCanceled event.

put_queue()¶

Output the queued scripts as a queue event.

The data is put even if the queue has not changed. That way commands which alter the queue can rely on the event being published, even if the command has no effect (e.g. moving a script before itself).

put_script(script_info, force_output=False)¶

Output information about a script as a script event.

Designed to be used as a QueueModel script_callback.

Parameters

script_infoScriptInfo: Information about the script.
force_outputbool (optional): If True the output even if not changed.

report_summary_state()¶

Report a new value for summary_state, including current state.

Subclasses may wish to override for code that depends on the current state (rather than the state transition command that got it into that state).

async set_simulation_mode(simulation_mode: int) → None¶

Set the simulation mode.

Await implement_simulation_mode, update the simulation mode property and report the new value.

Parameters

simulation_modeint: Requested simulation mode; 0 for normal operation.

async start()¶: Finish creating the script queue.

Navigation

ScriptQueue¶