Merge pull request #138 from wright-group/rename

Add rename transition

attune/__init__.py

@@ -12,6 +12,7 @@
 from ._note import *
 from ._offset import *
 from ._open import *
+from ._rename import *
 from ._setpoint import *
 from ._store import *
 from ._tune import *

attune/_rename.py

@@ -0,0 +1,16 @@
+__all__ = ["rename"]
+
+from ._transition import Transition, TransitionType
+from ._instrument import Instrument
+
+
+def rename(instr: Instrument, name: str):
+    """Rename an instrument.
+
+    Note: this tranistion breaks the history, as the primary key changes.
+    """
+    trans = Transition(TransitionType.rename, metadata={"old_name": instr.name})
+    new_instr = instr.as_dict()
+    new_instr["transition"] = trans
+    new_instr["name"] = name
+    return Instrument(**new_instr)

attune/_transition.py

@@ -14,6 +14,7 @@ class TransitionType(str, Enum):
     create = "create"
     read = "read"
     restore = "restore"
+    rename = "rename"
     offset_to = "offset_to"
     offset_by = "offset_by"
     map_limits = "map_limits"

tests/rename.py

@@ -0,0 +1,8 @@
+import attune
+
+
+def test_rename():
+    i = attune.Instrument({}, name="old")
+    new = attune.rename(i, "new")
+    assert new.name == "new"
+    assert new.transition.metadata["old_name"] == "old"