Fix ruff check complaints

Author: ptsOSL

src/pytac/__init__.py

@@ -18,16 +18,6 @@
 # Default argument flag.
 DEFAULT = "default"
 
-from . import (
-    data_source,
-    device,
-    element,
-    exceptions,
-    lattice,
-    load_csv,
-    units,
-    utils,
-)
 
 __all__ = [
     "__version__",

tests/conftest.py

@@ -31,7 +31,7 @@ def pytest_sessionstart():
     (caget and caput).
     """
 
-    class ca_nothing(Exception):
+    class ca_nothing(Exception):  # noqa: N801, N818
         """A minimal mock of the cothread ca_nothing exception class."""
 
         def __init__(self, name, errorcode=True):

tests/test_cothread_cs.py

@@ -55,7 +55,7 @@ def test_set_multiple_calls_caput_correctly(cs):
     )
 
 
-def test_get_multiple_raises_ControlSystemException(cs):
+def test_get_multiple_raises_control_system_exception(cs):
     """Here we check that errors are thrown, suppressed and logged correctly."""
     caget.return_value = [12, ca_nothing("pv", False)]
     with pytest.raises(pytac.exceptions.ControlSystemException):
@@ -65,7 +65,7 @@ def test_get_multiple_raises_ControlSystemException(cs):
     log.check(("root", "WARNING", "Cannot connect to pv."))
 
 
-def test_set_multiple_raises_ControlSystemException(cs):
+def test_set_multiple_raises_control_system_exception(cs):
     """Here we check that errors are thrown, suppressed and logged correctly."""
     caput.return_value = [ca_nothing("pv1", True), ca_nothing("pv2", False)]
     with pytest.raises(pytac.exceptions.ControlSystemException):
@@ -75,7 +75,7 @@ def test_set_multiple_raises_ControlSystemException(cs):
     log.check(("root", "WARNING", "Cannot connect to pv2."))
 
 
-def test_get_single_raises_ControlSystemException(cs):
+def test_get_single_raises_control_system_exception(cs):
     """Here we check that errors are thrown, suppressed and logged correctly."""
     caget.side_effect = ca_nothing("pv", False)
     with LogCapture() as log:
@@ -85,7 +85,7 @@ def test_get_single_raises_ControlSystemException(cs):
     log.check(("root", "WARNING", "Cannot connect to prefix:rb."))
 
 
-def test_set_single_raises_ControlSystemException(cs):
+def test_set_single_raises_control_system_exception(cs):
     """Here we check that errors are thrown, suppressed and logged correctly."""
     caput.side_effect = ca_nothing("pv", False)
     with LogCapture() as log:
@@ -95,7 +95,7 @@ def test_set_single_raises_ControlSystemException(cs):
     log.check(("root", "WARNING", "Cannot connect to prefix:sp."))
 
 
-def test_set_multiple_raises_ValueError_on_input_length_mismatch(cs):
+def test_set_multiple_raises_value_error_on_input_length_mismatch(cs):
     with pytest.raises(ValueError):
         cs.set_multiple([SP_PV], [42, 6])
     with pytest.raises(ValueError):

tests/test_device.py

@@ -61,7 +61,7 @@ def test_get_simple_device_value_with_handle():
     assert device.get_value(handle=pytac.RB) == 1.0
 
 
-def test_simple_device_raises_DataSourceException_if_readonly_and_set_value_called():
+def test_simple_device_raises_data_source_exception_if_readonly_and_set_value_called():
     device = SimpleDevice(10, readonly=True)
     with pytest.raises(DataSourceException):
         device.set_value(4)
@@ -79,7 +79,7 @@ def test_device_is_enabled_by_default(device_creation_function):
 @pytest.mark.parametrize(
     "device_creation_function", [create_epics_device, create_simple_device]
 )
-def test_device_is_disabled_if_False_enabler(device_creation_function):
+def test_device_is_disabled_if_false_enabler(device_creation_function):
     device = device_creation_function(enabled=False)
     assert not device.is_enabled()
 
@@ -93,7 +93,7 @@ def test_device_is_enabled_returns_bool_value(device_creation_function):
 
 
 # PvEnabler test.
-def test_PvEnabler(mock_cs):
+def test_pv_enabler(mock_cs):
     pve = PvEnabler("enable-pv", 40, mock_cs)
     assert pve
     mock_cs.get_single.return_value = 50

tests/test_element.py

@@ -18,7 +18,7 @@ def test_create_element():
     assert e._lattice == lat
 
 
-def test_element_properties_are_None_without_lattice():
+def test_element_properties_are_none_without_lattice():
     e = Element(1.2, "SEXT")
     assert e.index is None
     assert e.s is None
@@ -53,7 +53,7 @@ def test_add_element_to_family_and_case_insensitive_retrieval():
     assert e.is_in_family("FAM")
 
 
-def test_device_methods_raise_DataSourceException_if_no_live_data_source(
+def test_device_methods_raise_data_source_exception_if_no_live_data_source(
     simple_element,
 ):
     basic_element = simple_element
@@ -66,7 +66,7 @@ def test_device_methods_raise_DataSourceException_if_no_live_data_source(
         basic_element.get_device("x")
 
 
-def test_get_device_raises_KeyError_if_device_not_present(simple_element):
+def test_get_device_raises_key_error_if_device_not_present(simple_element):
     with pytest.raises(pytac.exceptions.FieldException):
         simple_element.get_device("not-a-device")
 
@@ -76,15 +76,15 @@ def test_get_unitconv_returns_unitconv_object(simple_element, unit_uc, double_uc
     assert simple_element.get_unitconv("y") == double_uc
 
 
-def test_set_unit_conv(simple_element):
+def test_set_unitconv(simple_element):
     with pytest.raises(KeyError):
         simple_element._data_source_manager._uc["field1"]
     uc = mock.Mock()
     simple_element.set_unitconv("field1", uc)
     assert simple_element._data_source_manager._uc["field1"] == uc
 
 
-def test_get_unitconv_raises_FieldException_if_device_not_present(simple_element):
+def test_get_unitconv_raises_field_exception_if_device_not_present(simple_element):
     with pytest.raises(pytac.exceptions.FieldException):
         simple_element.get_unitconv("not-a-device")
 
@@ -144,7 +144,7 @@ def test_identity_conversion(simple_element):
 
 
 def test_get_fields(simple_element):
-    assert set(simple_element.get_fields()[pytac.LIVE]) == set(["y", "x"])
+    assert set(simple_element.get_fields()[pytac.LIVE]) == {"y", "x"}
 
 
 def test_element_representation():

tests/test_epics.py

@@ -93,12 +93,12 @@ def test_get_value_uses_cs_if_data_source_live(simple_epics_element, mock_cs):
     mock_cs.get_single.assert_called_with(RB_PV, True)
 
 
-def test_get_value_raises_HandleExceptions(simple_epics_element):
+def test_get_value_raises_handle_exceptions(simple_epics_element):
     with pytest.raises(pytac.exceptions.HandleException):
         simple_epics_element.get_value("y", "unknown_handle")
 
 
-def test_lattice_get_pv_name_raises_DataSourceException(simple_epics_lattice):
+def test_lattice_get_pv_name_raises_data_source_exception(simple_epics_lattice):
     basic_epics_lattice = simple_epics_lattice
     with pytest.raises(pytac.exceptions.DataSourceException):
         basic_epics_lattice.get_pv_name("basic", pytac.RB)
@@ -107,7 +107,7 @@ def test_lattice_get_pv_name_raises_DataSourceException(simple_epics_lattice):
         basic_epics_lattice.get_pv_name("x", pytac.RB)
 
 
-def test_set_element_values_length_mismatch_raises_IndexError(simple_epics_lattice):
+def test_set_element_values_length_mismatch_raises_index_error(simple_epics_lattice):
     with pytest.raises(IndexError):
         simple_epics_lattice.set_element_values("family", "x", [1, 2])
     with pytest.raises(IndexError):
@@ -125,6 +125,6 @@ def test_element_get_pv_name_raises_exceptions(simple_epics_element):
         basic_epics_element.get_pv_name("x", pytac.RB)
 
 
-def test_create_EpicsDevice_raises_DataSourceException_if_no_PVs_are_given():
+def test_create_epics_device_raises_data_source_exception_if_no_PVs_are_given():  # noqa: N802
     with pytest.raises(pytac.exceptions.DataSourceException):
         pytac.device.EpicsDevice("device_1", "a_control_system")

tests/test_invalid_classes.py

@@ -3,7 +3,7 @@
 from pytac import cs, data_source, device
 
 
-def test_ControlSystem_throws_NotImplementedError():
+def test_control_system_throws_not_implemented_error():
     test_cs = cs.ControlSystem()
     with pytest.raises(NotImplementedError):
         test_cs.get_single("dummy", "throw")
@@ -15,7 +15,7 @@ def test_ControlSystem_throws_NotImplementedError():
         test_cs.set_multiple(["dummy_1", "dummy_2"], [1, 2], "throw")
 
 
-def test_DataSource_throws_NotImplementedError():
+def test_data_source_throws_not_implemented_error():
     test_ds = data_source.DataSource()
     with pytest.raises(NotImplementedError):
         test_ds.get_fields()
@@ -25,7 +25,7 @@ def test_DataSource_throws_NotImplementedError():
         test_ds.set_value("field", 0.0, "throw")
 
 
-def test_Device_throws_NotImplementedError():
+def test_device_throws_not_implemented_error():
     test_d = device.Device()
     with pytest.raises(NotImplementedError):
         test_d.is_enabled()

tests/test_lattice.py

@@ -39,7 +39,7 @@ def test_lattice_without_symmetry():
 
 def test_lattice_cell_properties():
     lat = Lattice("", 2)
-    for i in range(5):
+    for _ in range(5):
         lat.add_element(Element(0.5, "DRIFT"))
     assert lat.cell_length == 1.25
     assert lat.cell_bounds == [1, 4, 5]
@@ -51,7 +51,7 @@ def test_get_element_devices(simple_lattice):
     assert devices[0].name == "x_device"
 
 
-def test_device_methods_raise_DataSourceException_if_no_live_data_source(
+def test_device_methods_raise_data_source_exception_if_no_live_data_source(
     simple_lattice,
 ):
     basic_lattice = simple_lattice
@@ -64,7 +64,7 @@ def test_device_methods_raise_DataSourceException_if_no_live_data_source(
         basic_lattice.get_device("x")
 
 
-def test_get_unitconv_raises_FieldException_if_no_uc_for_field(simple_lattice):
+def test_get_unitconv_raises_field_exception_if_no_uc_for_field(simple_lattice):
     with pytest.raises(pytac.exceptions.FieldException):
         simple_lattice.get_unitconv("not_a_field")
 
@@ -93,7 +93,7 @@ def test_set_value_raises_exceptions_correctly(simple_lattice):
         simple_lattice.set_value("not_a_field", 0)
 
 
-def test_get_element_devices_raises_ValueError_for_mismatched_family(simple_lattice):
+def test_get_element_devices_raises_value_error_for_mismatched_family(simple_lattice):
     with pytest.raises(ValueError):
         devices = simple_lattice.get_element_devices("not-a-family", "x")
     basic_element = simple_lattice.get_elements("family")[0]
@@ -104,7 +104,9 @@ def test_get_element_devices_raises_ValueError_for_mismatched_family(simple_latt
     assert devices == []
 
 
-def test_get_element_devices_raises_FieldException_if_field_not_matched(simple_lattice):
+def test_get_element_devices_raises_field_exception_if_field_not_matched(
+    simple_lattice,
+):
     with pytest.raises(pytac.exceptions.FieldException):
         simple_lattice.get_element_devices("family", "not-a-field")
 
@@ -176,7 +178,7 @@ def test_set_element_values(simple_lattice):
     )
 
 
-def test_set_element_values_raises_Exceptions_correctly(simple_lattice):
+def test_set_element_values_raises_exceptions_correctly(simple_lattice):
     with pytest.raises(IndexError):
         simple_lattice.set_element_values("family", "x", [1, 2])
     with pytest.raises(IndexError):
@@ -240,7 +242,7 @@ def test_convert_family_values(simple_lattice):
     assert post_values == [12]
 
 
-def test_convert_family_values_length_mismatch_raises_IndexError(simple_lattice):
+def test_convert_family_values_length_mismatch_raises_index_error(simple_lattice):
     with pytest.raises(IndexError):
         simple_lattice.convert_family_values(
             "family", "x", [1, 2], pytac.ENG, pytac.PHYS

tests/test_load.py

@@ -10,7 +10,7 @@
 
 
 @pytest.fixture
-def mock_cs_raises_ImportError():
+def mock_cs_raises_import_error():
     """We create a mock control system to replace CothreadControlSystem, so
         that we can check that when it raises an ImportError load_csv.load
         catches it and raises a ControlSystemException instead.
@@ -21,8 +21,9 @@ def mock_cs_raises_ImportError():
      ImportError when the code is compiled.
     """
 
-    def CothreadControlSystem():
-        raise ImportError
+    class CothreadControlSystem:
+        def __init__(self):
+            raise ImportError
 
     return CothreadControlSystem
 
@@ -37,13 +38,13 @@ def test_default_control_system_import():
     assert isinstance(load(TESTING_MODE)._cs, pytac.cothread_cs.CothreadControlSystem)
 
 
-def test_import_fail_raises_ControlSystemException(mock_cs_raises_ImportError):
+def test_import_fail_raises_control_system_exception(mock_cs_raises_import_error):
     """In this test we:
     - check that load corectly fails if cothread cannot be imported
     - check that when the import of the CothreadControlSystem fails the
        ImportError raised is replaced with a ControlSystemException
     """
-    with patch("pytac.cothread_cs.CothreadControlSystem", mock_cs_raises_ImportError):
+    with patch("pytac.cothread_cs.CothreadControlSystem", mock_cs_raises_import_error):
         with pytest.raises(pytac.exceptions.ControlSystemException):
             load(TESTING_MODE)
 
@@ -69,10 +70,16 @@ def test_devices_loaded(lattice):
 
 
 def test_families_loaded(lattice):
-    assert lattice.get_all_families() == set(
-        ["drift", "sext", "quad", "ds", "qf", "qs", "sd"]
-    )
-    assert lattice.get_elements("quad")[0].families == set(["quad", "qf", "qs"])
+    assert lattice.get_all_families() == {
+        "drift",
+        "sext",
+        "quad",
+        "ds",
+        "qf",
+        "qs",
+        "sd",
+    }
+    assert lattice.get_elements("quad")[0].families == {"quad", "qf", "qs"}
 
 
 def test_load_unitconv_warns_if_pchip_or_poly_data_file_not_found(
@@ -94,7 +101,7 @@ def test_load_unitconv_warns_if_pchip_or_poly_data_file_not_found(
     )
 
 
-def test_resolve_unitconv_raises_UnitsException_if_pchip_or_poly_data_file_not_found(
+def test_resolve_unitconv_raises_units_exception_if_pchip_or_poly_data_file_not_found(
     polyconv_file, pchipconv_file
 ):
     uc_params = {
@@ -119,7 +126,7 @@ def test_resolve_unitconv_raises_UnitsException_if_pchip_or_poly_data_file_not_f
         resolve_unitconv(uc_params, {}, polyconv_file, pchipconv_file)
 
 
-def test_resolve_unitconv_raises_UnitsException_if_unrecognised_UnitConv_type(
+def test_resolve_unitconv_raises_units_exception_if_unrecognised_unitconv_type(
     polyconv_file, pchipconv_file
 ):
     uc_params = {

tests/test_machine.py

@@ -99,7 +99,7 @@ def test_load_quadrupoles(lattice, n_quads, request):
     quads = lattice.get_elements("Quadrupole")
     assert len(quads) == n_quads
     for quad in quads:
-        assert set(quad.get_fields()[pytac.LIVE]) == set(["b1"])
+        assert set(quad.get_fields()[pytac.LIVE]) == {"b1"}
         device = quad.get_device("b1")
         assert re.match("SR.*Q.*:I", device.rb_pv)
         assert re.match("SR.*Q.*:SETI", device.sp_pv)
@@ -197,11 +197,11 @@ def test_quad_unitconv_raise_exception():
 
 
 def test_quad_unitconv_known_failing_test():
-    LAT_ENERGY = 3000
+    lat_energy = 3000
 
     uc = pytac.units.PchipUnitConv([50.0, 100.0, 180.0], [-4.95, -9.85, -17.56])
-    uc._post_eng_to_phys = pytac.utils.get_div_rigidity(LAT_ENERGY)
-    uc._pre_phys_to_eng = pytac.utils.get_mult_rigidity(LAT_ENERGY)
+    uc._post_eng_to_phys = pytac.utils.get_div_rigidity(lat_energy)
+    uc._pre_phys_to_eng = pytac.utils.get_mult_rigidity(lat_energy)
     numpy.testing.assert_allclose(uc.eng_to_phys(70), -0.69133465)
     numpy.testing.assert_allclose(uc.phys_to_eng(-0.7), 70.8834284954)