Merge pull request #85 from funkelab/73-deprecate-node_id_to_track_id-dict

Mark node_id_to_track_id for deprecation

Author: cmalinmayor

src/funtracks/data_model/solution_tracks.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import warnings
 from typing import TYPE_CHECKING
 
 import networkx as nx
@@ -59,6 +60,12 @@ def from_tracks(cls, tracks: Tracks):
 
     @property
     def node_id_to_track_id(self) -> dict[Node, int]:
+        warnings.warn(
+            "node_id_to_track_id property will be removed in funtracks v2. "
+            "Use `get_track_id` instead for better performance.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return nx.get_node_attributes(self.graph, NodeAttr.TRACK_ID.value)
 
     def get_next_track_id(self) -> int:

tests/data_model/test_solution_tracks.py

@@ -1,5 +1,6 @@
 import networkx as nx
 import numpy as np
+import pytest
 
 from funtracks.actions import AddNode
 from funtracks.data_model import NodeAttr, SolutionTracks, Tracks
@@ -16,6 +17,15 @@ def test_next_track_id(graph_2d):
     assert tracks.get_next_track_id() == 11
 
 
+def test_node_id_to_track_id(graph_2d):
+    tracks = SolutionTracks(graph_2d, ndim=3)
+    with pytest.warns(
+        DeprecationWarning,
+        match="node_id_to_track_id property will be removed in funtracks v2. ",
+    ):
+        tracks.node_id_to_track_id  # noqa B018
+
+
 def test_from_tracks_cls(graph_2d):
     tracks = Tracks(
         graph_2d, ndim=3, pos_attr="POSITION", time_attr="TIME", scale=(2, 2, 2)