Merge branch 'main' of https://github.com/garcia/simfile into main

Author: garcia

docs/source/examples.rst

@@ -253,7 +253,8 @@ sort_by_difficulty.py
     so that they are sorted by difficulty in StepMania.
 
     This script finds the hardest chart of a given stepstype (dance-single by default)
-    and puts its meter (difficulty number) between brackets at the start of the title.
+    and puts its meter (difficulty number) between brackets at the start of the title
+    and titletranslit.
 
     Usage examples:
 
@@ -321,7 +322,7 @@ sort_by_difficulty.py
 
     def prefix_title_with_meter(simfile_path: str, args: SortByDifficultyArgs):
         """
-        Add (or remove) a numeric prefix to the simfile's title.
+        Add (or remove) a numeric prefix to the simfile's title and titletranslit.
 
         This saves the updated simfile to its original location
         and writes a backup copy with a ~ appended to the filename.
@@ -336,18 +337,27 @@ sort_by_difficulty.py
             # It's very unlikely for the title property to be blank or missing.
             # This is mostly to satisfy type-checkers.
             current_title = sf.title or ""
+            current_titletranslit = sf.titletranslit or ""
 
             if args.remove:
-                # Look for a number in brackets at the start of the title
-                if current_title.startswith("["):
-                    open_bracket_index = current_title.find("[")
-                    close_bracket_index = current_title.find("]")
-                    bracketed_text = current_title[
-                        open_bracket_index + 1 : close_bracket_index
-                    ]
-                    if bracketed_text.isnumeric():
-                        # Remove the bracketed number from the title
-                        sf.title = current_title[close_bracket_index + 1 :].lstrip(" ")
+                def remove_starting_brackets(current_text: str) -> str:
+                    """
+                    If current_text has a bracketed number at the start of the text, remove it and return it
+                    Otherwise, return current_text unchanged. 
+                    """
+                    # Look for a number in brackets at the start of the text
+                    if current_text.startswith("["):
+                        open_bracket_index = current_text.find("[")
+                        close_bracket_index = current_text.find("]")
+                        bracketed_text = current_text[
+                            open_bracket_index + 1 : close_bracket_index
+                        ]
+                        if bracketed_text.isnumeric():
+                            # Remove the bracketed number from the text
+                            return current_title[close_bracket_index + 1 :].lstrip(" ")
+                    return current_title
+                sf.title = remove_starting_brackets(sf.title)
+                sf.titletranslit = remove_starting_brackets(sf.titletranslit)
             else:
                 # Find the hardest chart (numerically) within a stepstype
                 # and use it to prefix the title
@@ -365,6 +375,7 @@ sort_by_difficulty.py
                 # Put the meter at the start of the title,
                 # filling in leading zeros per arguments
                 sf.title = f"[{meter.zfill(args.digits)}] {current_title}"
+                sf.titletranslit = f"[{meter.zfill(args.digits)}] {current_titletranslit}"
 
 
     def main(argv):

simfile/__init__.py

@@ -22,7 +22,7 @@
 from .types import Simfile
 
 
-__version__ = "2.1.0"
+__version__ = "2.1.1"
 __all__ = [
     "load",
     "loads",

simfile/ssc.py

@@ -99,20 +99,28 @@ def _parse(self, parser: MSD_ITERATOR) -> None:
             raise ValueError("expected NOTEDATA property first")
 
         for param in iterator:
-            self[param.key] = param.value
+            if param.key in BaseSimfile.MULTI_VALUE_PROPERTIES:
+                self[param.key] = ":".join(param.components[1:])
+            else:
+                self[param.key] = param.value
             if param.value is self.notes:
                 break
 
     def serialize(self, file):
         file.write(f"{MSDParameter(('NOTEDATA', ''))}\n")
         notes_key = "NOTES"
+
         for (key, value) in self.items():
-            # notes must always be the last property in a chart
+            # Either NOTES or NOTES2 must be the last chart property
             if value is self.notes:
                 notes_key = key
                 continue
-            param = MSDParameter((key, value))
+            if key in BaseSimfile.MULTI_VALUE_PROPERTIES:
+                param = MSDParameter((key, *value.split(":")))
+            else:
+                param = MSDParameter((key, value))
             file.write(f"{param}\n")
+
         notes_param = MSDParameter((notes_key, self[notes_key]))
         file.write(f"{notes_param}\n\n")
 
@@ -208,7 +216,7 @@ def _parse(self, parser: MSD_ITERATOR):
         partial_chart: Optional[SSCChart] = None
         for param in parser:
             key = param.key.upper()
-            if key not in BaseSimfile.MULTI_VALUE_PROPERTIES:
+            if key in BaseSimfile.MULTI_VALUE_PROPERTIES:
                 value: Optional[str] = ":".join(param.components[1:])
             else:
                 value = param.value

simfile/tests/test_sm.py

@@ -159,6 +159,20 @@ def test_init_handles_animations_property(self):
         self.assertEqual(with_bgchanges.bgchanges, with_animations.bgchanges)
         self.assertNotIn("BGCHANGES", with_animations)
         self.assertIn("ANIMATIONS", with_animations)
+    
+    def test_init_handles_multi_value_properties(self):
+        with_multi_value_properties = SMSimfile(string='''
+            #TITLE:Colons should be preserved below: but not here;
+            #DISPLAYBPM:60:240;
+            #ATTACKS:TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse;
+        ''')
+        self.assertEqual('Colons should be preserved below', with_multi_value_properties.title)
+        self.assertEqual('60:240', with_multi_value_properties.displaybpm)
+        self.assertEqual(
+            'TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse',
+            with_multi_value_properties.attacks,
+        )
+        
 
     def test_repr(self):
         unit = SMSimfile(string=testing_simfile())
@@ -198,3 +212,19 @@ def test_charts(self):
 
         unit.charts = SMCharts()
         self.assertEqual(0, len(unit.charts))
+
+    def test_serialize_handles_multi_value_properties(self):
+        expected = SMSimfile(string='''
+            #TITLE:Colons should be preserved below;
+            #DISPLAYBPM:60:240;
+            #ATTACKS:TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse;
+        ''')
+        
+        # None of the colons should be escaped
+        serialized = str(expected)
+        self.assertNotIn('\\', serialized)
+        
+        deserialized = SMSimfile(string=serialized)
+        self.assertEqual(expected.title, deserialized.title)
+        self.assertEqual(expected.displaybpm, deserialized.displaybpm)
+        self.assertEqual(expected.attacks, deserialized.attacks)

simfile/tests/test_ssc.py

@@ -59,6 +59,29 @@ def test_init_and_properties(self):
         self.assertEqual("0.793,1.205,0.500,0.298,0.961", unit.radarvalues)
         self.assertEqual("\n\n0000\n0000\n0000\n0000\n", unit.notes)
 
+    def test_init_handles_multi_value_properties(self):
+        with_multi_value_properties = SSCChart.from_str(
+            """
+            #NOTEDATA:;
+            #CHARTNAME:Colons should be preserved below: but not here;
+            #DISPLAYBPM:60:240;
+            #ATTACKS:TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse;
+            #NOTES:
+                0000
+                0000
+                0000
+                0000
+            ;"""
+        )
+        self.assertEqual(
+            "Colons should be preserved below", with_multi_value_properties.chartname
+        )
+        self.assertEqual("60:240", with_multi_value_properties.displaybpm)
+        self.assertEqual(
+            "TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse",
+            with_multi_value_properties.attacks,
+        )
+
     def test_serialize(self):
         unit = SSCChart.from_str(testing_chart())
         expected = (
@@ -81,6 +104,31 @@ def test_serialize(self):
             "\n"
         )
 
+    def test_serialize_handles_multi_value_properties(self):
+        expected = SSCChart.from_str(
+            """
+            #NOTEDATA:;
+            #CHARTNAME:Colons in values below should be preserved;
+            #DISPLAYBPM:60:240;
+            #ATTACKS:TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse;
+            #NOTES:
+                0000
+                0000
+                0000
+                0000
+            ;"""
+        )
+        serialized = SSCChart.from_str(str(expected))
+
+        # None of the colons should be escaped
+        serialized = str(expected)
+        self.assertNotIn("\\", serialized)
+
+        deserialized = SSCChart.from_str(str(serialized))
+        self.assertEqual(expected.chartname, deserialized.chartname)
+        self.assertEqual(expected.displaybpm, deserialized.displaybpm)
+        self.assertEqual(expected.attacks, deserialized.attacks)
+
     def test_serialize_with_escapes(self):
         unit = SSCChart.from_str(testing_chart())
         unit.chartname = "A:B;C//D\\E"
@@ -194,6 +242,43 @@ def test_init_handles_animations_property(self):
         self.assertNotIn("BGCHANGES", with_animations)
         self.assertIn("ANIMATIONS", with_animations)
 
+    def test_init_handles_multi_value_properties(self):
+        with_multi_value_properties = SSCSimfile(
+            string="""
+            #VERSION:0.83;
+            #TITLE:Colons should be preserved below: but not here;
+            #DISPLAYBPM:60:240;
+            #ATTACKS:TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse;
+        """
+        )
+        self.assertEqual(
+            "Colons should be preserved below", with_multi_value_properties.title
+        )
+        self.assertEqual("60:240", with_multi_value_properties.displaybpm)
+        self.assertEqual(
+            "TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse",
+            with_multi_value_properties.attacks,
+        )
+
+    def test_serialize_handles_multi_value_properties(self):
+        expected = SSCSimfile(
+            string="""
+            #VERSION:0.83;
+            #TITLE:Colons should be preserved below;
+            #DISPLAYBPM:60:240;
+            #ATTACKS:TIME=1.000:LEN=0.500:MODS=*5 -2.5 reverse;
+        """
+        )
+
+        # None of the colons should be escaped
+        serialized = str(expected)
+        self.assertNotIn("\\", serialized)
+
+        deserialized = SSCSimfile(string=serialized)
+        self.assertEqual(expected.title, deserialized.title)
+        self.assertEqual(expected.displaybpm, deserialized.displaybpm)
+        self.assertEqual(expected.attacks, deserialized.attacks)
+
     def test_repr(self):
         unit = SSCSimfile(string=testing_simfile())