menzelandClaude Opus 5
64c2fff6e6
Readout is a property of the detector, not a beamline constant: a 9M has more modules than a 1.5M, and the Falcon needs 3 ms against the delay generator's 200 us. The per-model constants therefore stay, with comments saying the duplication is deliberate so nobody consolidates them again. They all hold 2e-4 today only because no measured per-model value exists yet. Writing a test for the deviceConfig override exposed that it never worked. Both subclasses passed readout_time to super() while also forwarding **kwargs, so supplying it raised "got multiple values for keyword argument" -- and through BEC it never even got that far, because readout_time was not a named parameter of the subclass signature and the device server drops config keys it cannot see (the same rule behind the recent prefix incident). Both subclasses now name it with the model constant as default, and a test asserts the signatures keep it. Also documents frame_time_us in DetectorSettings as required-but-ignored for the Eiger, and warns that its 500 is microseconds while every other time in the module is seconds. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KLnmUurqcNd1FiDY5M2uZr
Getting Started with Testing using pytest
BEC is using the pytest framework. It can be installed via
pip install pytest
in your python environment.
We note that pytest is part of the optional-dependencies [dev] of the plugin package.
Introduction
Tests in this package should be stored in the tests directory.
We suggest to sort tests of different submodules, i.e. scans or devices in the respective folder structure, and to folow a naming convention of <test_module_name.py>.
It is mandatory for test files to begin with test_ for pytest to discover them.
To run all tests, navigate to the directory of the plugin from the command line, and run the command
pytest -v --random-order ./tests
Note, the python environment needs to be active.
The additional arg -v allows pytest to run in verbose mode which provides more detailed information about the tests being run.
The argument --random-order instructs pytest to run the tests in random order, which is the default in the CI pipelines.
Test examples
Writing tests can be quite specific for the given function. We recommend writing tests as isolated as possible, i.e. try to test single functions instead of full classes. A very useful class to enable isolated testing is MagicMock. In addition, we also recommend to take a look at the How-to guides from pytest.