[AGIPD][DARK] Improvements for reading conditions by creating new dataclass for multiple runs

Description

While working on a feature to sort dark runs for AGIPD, I realized that the AGIDP dark notebook might need some improvements. This is a refactor to AGIPD darks with no new functionalities.

1- Introduce AgipdCtrlRuns data class

2- Convert AgipdCtrl class to dataclass

3- Replace cells for reading/validating AGIPD Conditions with AgipdCtrlRuns

4- Now I add more tests to untested pieces in the dark notebook.

This leads to simpler code and better performance while reading conditions. This can also be used with other notebooks, e.g. Gain notebooks that reads more than one run.

How Has This Been Tested?

• TBD

Relevant Documents (optional)

Types of changes

• Refactor (refactoring code with no functionality changes)
• Test (additional or refactored tests)
• Chore (non-code changes, e.g. comments, readme, grammar, etc...)

Checklist:

• Add unit tests

Reviewers

@kluyvert @schmidtp

tests/test_agipdlib.py

@@ -10,6 +10,7 @@ SPB_AGIPD_INST_SRC = 'SPB_DET_AGIPD1M-1/DET/0CH0:xtdf'
 SPB_AGIPD_KARABO_CTRL_ID = 'SPB_IRU_AGIPD1M1'
 CTRL_SRC = f'{SPB_AGIPD_KARABO_CTRL_ID}/MDL/FPGA_COMP'
 
+
 def test_get_acq_rate_ctrl(mock_agipd1m_run):
     # Current up to date data with acq_rate stored
     # as repetition rate in slow data.
@@ -225,58 +226,60 @@ ADAPTIVE_CTRL_RUNS = AgipdCtrlRuns(
     ctrl_src=CTRL_SRC,
 )
 
+
 @pytest.mark.requires_gpfs
 def test_get_memory_cells_runs():
-    assert 352 == FIXED_CTRL_RUNS.get_memory_cells()
+    assert FIXED_CTRL_RUNS.get_memory_cells() == 352
 
-    assert 352 == ADAPTIVE_CTRL_RUNS.get_memory_cells()
+    assert ADAPTIVE_CTRL_RUNS.get_memory_cells() == 352
 
 
 @pytest.mark.requires_gpfs
 def test_get_bias_voltage_runs():
-    assert 300 == FIXED_CTRL_RUNS.get_bias_voltage(SPB_AGIPD_KARABO_CTRL_ID)
+    assert FIXED_CTRL_RUNS.get_bias_voltage(SPB_AGIPD_KARABO_CTRL_ID) == 300
 
-    assert 300 == ADAPTIVE_CTRL_RUNS.get_bias_voltage(SPB_AGIPD_KARABO_CTRL_ID)
+    assert ADAPTIVE_CTRL_RUNS.get_bias_voltage(SPB_AGIPD_KARABO_CTRL_ID) == 300
 
 
 @pytest.mark.requires_gpfs
 def test_get_integration_time_runs():
-    assert 12 == FIXED_CTRL_RUNS.get_integration_time()
+    assert FIXED_CTRL_RUNS.get_integration_time() == 12
 
-    assert 20 == ADAPTIVE_CTRL_RUNS.get_integration_time()
+    assert ADAPTIVE_CTRL_RUNS.get_integration_time() == 20
 
 
 @pytest.mark.requires_gpfs
 def test_get_acquisition_rate_runs():
-    assert 1.1 == FIXED_CTRL_RUNS.get_acq_rate()
+    assert FIXED_CTRL_RUNS.get_acq_rate() == 1.1
 
-    assert 1.1 == ADAPTIVE_CTRL_RUNS.get_acq_rate()
+    assert ADAPTIVE_CTRL_RUNS.get_acq_rate() == 1.1
 
 
 @pytest.mark.requires_gpfs
 def test_get_gain_setting_runs():
-    assert 0 == FIXED_CTRL_RUNS.get_gain_setting()
+    assert FIXED_CTRL_RUNS.get_gain_setting() == 0
 
-    assert 0 == ADAPTIVE_CTRL_RUNS.get_gain_setting()
+    assert ADAPTIVE_CTRL_RUNS.get_gain_setting() == 0
 
 
 @pytest.mark.requires_gpfs
 def test_get_gain_mode_runs():
-    assert [
+    assert FIXED_CTRL_RUNS.get_gain_modes() == [
         AgipdGainMode.FIXED_HIGH_GAIN,
         AgipdGainMode.FIXED_MEDIUM_GAIN,
         AgipdGainMode.FIXED_LOW_GAIN
-    ] == FIXED_CTRL_RUNS.get_gain_modes()
+    ]
 
-    assert [
-        AgipdGainMode.ADAPTIVE_GAIN]*3 == ADAPTIVE_CTRL_RUNS.get_gain_modes()
+    assert ADAPTIVE_CTRL_RUNS.get_gain_modes() == [
+        AgipdGainMode.ADAPTIVE_GAIN]*3
 
 
 @pytest.mark.requires_gpfs
 def test_fixed_gain_mode():
-    assert True == FIXED_CTRL_RUNS.fixed_gain_mode()
+    assert FIXED_CTRL_RUNS.fixed_gain_mode()
+
+    assert not ADAPTIVE_CTRL_RUNS.fixed_gain_mode()
 
-    assert False == ADAPTIVE_CTRL_RUNS.fixed_gain_mode()
 
 @pytest.mark.requires_gpfs
 def test_raise_fixed_gain_mode():
@@ -284,11 +287,12 @@ def test_raise_fixed_gain_mode():
         raw_folder=TEST_RAW_FOLDER,
         runs=[9011, 9016, 9017],
         image_src=SPB_AGIPD_INST_SRC,
-        ctrl_src=CTRL_SRC,    
+        ctrl_src=CTRL_SRC,
     )
-    with pytest.raises(ValueError) as e:
+    with pytest.raises(ValueError):
         adaptive_fixed_ctrls.fixed_gain_mode()
 
+
 @pytest.mark.requires_gpfs
 def test_raise_validate_gain_modes():
     adaptive_fixed_ctrls = AgipdCtrlRuns(
@@ -297,7 +301,7 @@ def test_raise_validate_gain_modes():
         image_src=SPB_AGIPD_INST_SRC,
         ctrl_src=CTRL_SRC,
     )
-    with pytest.raises(ValueError) as e:
+    with pytest.raises(ValueError):
         adaptive_fixed_ctrls.validate_gain_modes()
 
     unsorted_fixed_gain_ctrls = AgipdCtrlRuns(
@@ -306,5 +310,5 @@ def test_raise_validate_gain_modes():
         image_src=SPB_AGIPD_INST_SRC,
         ctrl_src=CTRL_SRC,
     )
-    with pytest.raises(ValueError) as e:
+    with pytest.raises(ValueError):
         unsorted_fixed_gain_ctrls.validate_gain_modes()