Rename methods making the names consistent with existing methods

Author: psomhorst

eitprocessing/datahandling/continuousdata.py

@@ -57,7 +57,7 @@ def __setattr__(self, attr: str, value: Any):  # noqa: ANN401
         except AttributeError:
             pass
         else:
-            if self.is_lockable(attr) and self.is_locked(attr):
+            if self.islockable(attr) and self.islocked(attr):
                 msg = f"Attribute '{attr}' is locked and can't be overwritten."
                 raise AttributeError(msg)
         super().__setattr__(attr, value)

eitprocessing/datahandling/mixins/locking.py

@@ -7,7 +7,7 @@
 class Lockable:
     """Adds locking functionality to subclass.
 
-    This class provides the methods lock(), unlock(), lock_all(), unlock_all(), is_locked() and is_lockable(), and the
+    This class provides the methods lock(), unlock(), lock_all(), unlock_all(), islocked() and islockable(), and the
     property _lock_action_defaults.
     """
 
@@ -29,7 +29,7 @@ def lock(self, *attr: str) -> None:
             # default values are not allowed when using *attr, so set a default here if none is supplied
             attr = tuple(self._lock_action_defaults)
         for attr_ in attr:
-            if not self.is_lockable(attr_):
+            if not self.islockable(attr_):
                 msg = f"Attribute {attr_} is not lockable."
                 raise ValueError(msg)
             getattr(self, attr_).flags["WRITEABLE"] = False
@@ -59,7 +59,7 @@ def unlock(self, *attr: str) -> None:
             # default values are not allowed when using *attr, so set a default here if none is supplied
             attr = tuple(self._lock_action_defaults)
         for attr_ in attr:
-            if not self.is_lockable(attr_):
+            if not self.islockable(attr_):
                 msg = f"Attribute {attr_} is not (un)lockable."
                 raise ValueError(msg)
             getattr(self, attr_).flags["WRITEABLE"] = True
@@ -70,7 +70,7 @@ def lock_all(self) -> None:
         See lock().
         """
         for attr in vars(self):
-            if self.is_lockable(attr):
+            if self.islockable(attr):
                 self.lock(attr)
 
     def unlock_all(self) -> None:
@@ -79,17 +79,17 @@ def unlock_all(self) -> None:
         See unlock().
         """
         for attr in vars(self):
-            if self.is_lockable(attr):
+            if self.islockable(attr):
                 self.unlock(attr)
 
-    def is_locked(self, attr: str = "values") -> bool:
+    def islocked(self, attr: str = "values") -> bool:
         """Return whether an attribute is locked.
 
         See lock().
         """
         return not getattr(self, attr).flags["WRITEABLE"]
 
-    def is_lockable(self, attr: str = "values") -> bool:
+    def islockable(self, attr: str = "values") -> bool:
         """Return whether an attribute is lockable.
 
         See lock().

tests/test_locking.py

@@ -13,13 +13,13 @@ def test_lock_continuousdata_values(draeger1: Sequence):
         pytest.fail("No continuous data available in sequence")
 
     assert isinstance(cd, ContinuousData)
-    assert cd.is_lockable("values")
-    assert cd.is_locked("values")
+    assert cd.islockable("values")
+    assert cd.islocked("values")
     try:
         cd.unlock("values")
     except:
         pytest.fail("Can't unlock attribute")
-    assert not cd.is_locked("values")
+    assert not cd.islocked("values")
     try:
         cd.lock("values")
     except: