bec_lib.tests.utils.ScansMock#
- class ScansMock(parent)[source]#
Bases:
Scans
Methods
close_scan_def
close_scan_group
translate type string into python type
open_scan_def
Prepare scan request message with given scan arguments
Context manager / decorator for exporting scans
umv
Attributes
Context manager / decorator for setting the dataset id on hold
Context manager / decorator for hiding the report
Context manager / decorator for defining new scans
Context manager / decorator for defining scan groups
- property dataset_id_on_hold#
Context manager / decorator for setting the dataset id on hold
- static get_arg_type(in_type: str)#
translate type string into python type
- property hide_report#
Context manager / decorator for hiding the report
- static prepare_scan_request(scan_name: str, scan_info: dict, *args, **kwargs) ScanQueueMessage #
Prepare scan request message with given scan arguments
- Parameters:
scan_name (str) – scan name (matching a scan name on the scan server)
scan_info (dict) – dictionary describing the scan (e.g. doc string, required kwargs etc.)
- Raises:
TypeError – Raised if not all required keyword arguments have been specified.
TypeError – Raised if the number of args do fit into the required bundling pattern.
TypeError – Raised if an argument is not of the required type as specified in scan_info.
- Returns:
scan request message
- Return type:
- property scan_def#
Context manager / decorator for defining new scans
- scan_export(output_file: str)#
Context manager / decorator for exporting scans
- property scan_group#
Context manager / decorator for defining scan groups