Merge 23aeda5 into b1330dd

praatio/data_classes/textgrid.py

@@ -11,6 +11,7 @@
     Dict,
 )
 from typing_extensions import Literal
+from collections import OrderedDict
 
 
 from praatio.utilities.constants import (
@@ -50,8 +51,7 @@ def __init__(self, minTimestamp: float = None, maxTimestamp: float = None):
             maxTimestamp: the maximum allowable timestamp in the textgrid
         """
 
-        self.tierNameList: List[str] = []  # Preserves the order of the tiers
-        self.tierDict: Dict[str, textgrid_tier.TextgridTier] = {}
+        self.tierDict: OrderedDict[str, textgrid_tier.TextgridTier] = OrderedDict()
 
         # Timestamps are determined by the first tier added
         self.minTimestamp: float = minTimestamp  # type: ignore[assignment]
@@ -72,6 +72,10 @@ def __eq__(self, other):
 
         return isEqual
 
+    @property
+    def tierNameList(self):
+        return tuple(self.tierDict.keys())
+
     def addTier(
         self,
         tier: textgrid_tier.TextgridTier,
@@ -103,15 +107,17 @@ def addTier(
         )
         errorReporter = utils.getErrorReporter(reportingMode)
 
-        if tier.name in list(self.tierDict.keys()):
+        if tier.name in self.tierNameList:
             raise errors.TierNameExistsError("Tier name already in tier")
 
-        if tierIndex is None:
-            self.tierNameList.append(tier.name)
-        else:
-            self.tierNameList.insert(tierIndex, tier.name)
-
+        tmpTierNameList = list(self.tierNameList)
         self.tierDict[tier.name] = tier
+        if tierIndex is not None:  # Need to recreate the tierDict with the new order
+            tmpTierNameList.insert(tierIndex, tier.name)
+            newTierDict = OrderedDict()
+            for tmpName in tmpTierNameList:
+                newTierDict[tmpName] = self.tierDict[tmpName]
+            self.tierDict = newTierDict
 
         minV = tier.minTimestamp
         if self.minTimestamp is not None and minV < self.minTimestamp:
@@ -148,7 +154,7 @@ def appendTextgrid(self, tg: "Textgrid", onlyMatchingNames: bool) -> "Textgrid":
 
         # Get all tier names.  Ordered first by this textgrid and
         # then by the other textgrid.
-        combinedTierNameList = self.tierNameList[:]
+        combinedTierNameList = list(self.tierNameList)
         for tierName in tg.tierNameList:
             if tierName not in combinedTierNameList:
                 combinedTierNameList.append(tierName)
@@ -493,7 +499,6 @@ def renameTier(self, oldName: str, newName: str) -> None:
         self.addTier(oldTier.new(newName, oldTier.entryList), tierIndex)
 
     def removeTier(self, name: str) -> textgrid_tier.TextgridTier:
-        self.tierNameList.pop(self.tierNameList.index(name))
         return self.tierDict.pop(name)
 
     def replaceTier(

tests/test_io.py

@@ -167,7 +167,7 @@ def test_openTextgrid_can_rename_tiers_when_textgrid_has_duplicate_tier_names(se
             inputFN, False, duplicateNamesMode=constants.DuplicateNames.RENAME
         )
 
-        self.assertEqual(["Mary", "Mary_2", "Mary_3"], sut.tierNameList)
+        self.assertSequenceEqual(["Mary", "Mary_2", "Mary_3"], sut.tierNameList)
 
     def test_tg_io_long_vs_short(self):
         """Tests reading of long vs short textgrids"""

tests/test_textgrid.py

@@ -83,7 +83,7 @@ def test_add_tier_can_add_a_tier_to_a_tg(self):
         sut.addTier(tier2, reportingMode="error")
         sut.addTier(tier3, reportingMode="error")
 
-        self.assertEqual(["words", "phrases", "max pitch"], sut.tierNameList)
+        self.assertSequenceEqual(["words", "phrases", "max pitch"], sut.tierNameList)
         self.assertEqual(tier1, sut.tierDict["words"])
         self.assertEqual(tier2, sut.tierDict["phrases"])
         self.assertEqual(tier3, sut.tierDict["max pitch"])
@@ -99,7 +99,7 @@ def test_add_tier_can_add_a_tier_to_a_tg_at_specific_indices(self):
         sut.addTier(tier3, tierIndex=1, reportingMode="error")
 
         # tier3 was inserted last but with index 1, so it will appear second
-        self.assertEqual(["words", "max pitch", "phrases"], sut.tierNameList)
+        self.assertSequenceEqual(["words", "max pitch", "phrases"], sut.tierNameList)
         self.assertEqual(tier1, sut.tierDict["words"])
         self.assertEqual(tier3, sut.tierDict["max pitch"])
         self.assertEqual(tier2, sut.tierDict["phrases"])
@@ -140,7 +140,7 @@ def test_append_textgrid_with_matching_names_only(self):
 
         self.assertEqual(0, sut.minTimestamp)
         self.assertEqual(10, sut.maxTimestamp)
-        self.assertEqual(["words", "max pitch"], sut.tierNameList)
+        self.assertSequenceEqual(["words", "max pitch"], sut.tierNameList)
         self.assertEqual(expectedTier1, sut.tierDict["words"])
         self.assertEqual(expectedTier2, sut.tierDict["max pitch"])
 
@@ -190,7 +190,7 @@ def test_append_textgrid_without_matching_names_only(self):
 
         self.assertEqual(0, sut.minTimestamp)
         self.assertEqual(10, sut.maxTimestamp)
-        self.assertEqual(
+        self.assertSequenceEqual(
             ["words", "max pitch", "phrases", "min pitch", "cats", "dogs"],
             sut.tierNameList,
         )
@@ -844,8 +844,7 @@ def test_rename_tier_renames_a_tier(self):
         expectedRenamedTier = makeIntervalTier("cats", [[5, 6.7, "hey there"]])
 
         self.assertEqual(expectedRenamedTier, sut.tierDict["cats"])
-        self.assertEqual(["phrases", "cats", "phones"], sut.tierNameList)
-        self.assertCountEqual(["phrases", "cats", "phones"], sut.tierDict.keys())
+        self.assertSequenceEqual(["phrases", "cats", "phones"], sut.tierNameList)
 
     def test_remove_tier_removes_a_tier(self):
         sut = textgrid.Textgrid(0, 10)
@@ -860,8 +859,7 @@ def test_remove_tier_removes_a_tier(self):
         removedTier = sut.removeTier("words")
 
         self.assertEqual(removedTier, tier2)
-        self.assertEqual(["phrases", "phones"], sut.tierNameList)
-        self.assertCountEqual(["phrases", "phones"], sut.tierDict.keys())
+        self.assertSequenceEqual(["phrases", "phones"], sut.tierNameList)
 
     def test_replace_tier_replaces_one_tier_with_another(self):
         sut = textgrid.Textgrid(0, 10)
@@ -872,12 +870,11 @@ def test_replace_tier_replaces_one_tier_with_another(self):
         sut.addTier(tier1)
         sut.addTier(tier2)
 
-        self.assertEqual(["words", "phones"], sut.tierNameList)
+        self.assertSequenceEqual(["words", "phones"], sut.tierNameList)
 
         sut.replaceTier("words", newTier1)
 
-        self.assertEqual(["cats", "phones"], sut.tierNameList)
-        self.assertCountEqual(["cats", "phones"], sut.tierDict.keys())
+        self.assertSequenceEqual(["cats", "phones"], sut.tierNameList)
         self.assertEqual(newTier1, sut.tierDict["cats"])
 
     def test_replace_tier_reports_if_new_tier_is_larger_than_textgrid(self):
@@ -909,23 +906,6 @@ def test_validate_throws_error_if_reporting_mode_is_invalid(self):
         with self.assertRaises(errors.WrongOption) as _:
             sut.validate("bird")
 
-    def test_validate_throws_error_if_two_tiers_have_the_same_name(self):
-        # Users shouldn't be manually manipulating the tierNameList
-        # (currently its the only way to trigger this error)
-        sut = textgrid.Textgrid()
-        tier1 = makeIntervalTier(name="phones")
-        tier2 = makeIntervalTier(name="words")
-
-        sut.addTier(tier1)
-        sut.addTier(tier2)
-        self.assertTrue(sut.validate())
-
-        sut.tierNameList.append("phones")
-        self.assertFalse(sut.validate(constants.ErrorReportingMode.SILENCE))
-
-        with self.assertRaises(errors.TierNameExistsError) as _:
-            sut.validate(constants.ErrorReportingMode.ERROR)
-
     def test_validate_throws_error_if_tiers_and_textgrid_dont_agree_on_min_timestamp(
         self,
     ):