feat: numerically sort snapshots if possible, close #657

Author: noahnu

src/syrupy/extensions/amber/serializer.py

@@ -11,6 +11,7 @@
     Dict,
     Generator,
     Iterable,
+    List,
     NamedTuple,
     Optional,
     Set,
@@ -87,6 +88,25 @@ class Marker:
         Name = "name"
         Divider = "---"
 
+    @classmethod
+    def __maybe_int(cls, part: str) -> Tuple[int, Union[str, int]]:
+        try:
+            # cast to int only if the string is the exact representation of the int
+            # for example, '012' != str(int('012'))
+            i = int(part)
+            if str(i) == part:
+                return (1, i)
+            return (0, part)
+        except ValueError:
+            # the nested tuple is to prevent comparing a str to an int
+            return (0, part)
+
+    @classmethod
+    def __snapshot_sort_key(
+        cls, snapshot: "Snapshot"
+    ) -> List[Tuple[int, Union[str, int]]]:
+        return [cls.__maybe_int(part) for part in snapshot.name.split(".")]
+
     @classmethod
     def write_file(
         cls, snapshot_collection: "SnapshotCollection", merge: bool = False
@@ -102,7 +122,9 @@ def write_file(
 
         with open(filepath, "w", encoding=TEXT_ENCODING, newline=None) as f:
             f.write(f"{cls._marker_prefix}{cls.Marker.Version}: {cls.VERSION}\n")
-            for snapshot in sorted(snapshot_collection, key=lambda s: s.name):
+            for snapshot in sorted(
+                snapshot_collection, key=lambda s: cls.__snapshot_sort_key(s)
+            ):
                 snapshot_data = str(snapshot.data)
                 if snapshot_data is not None:
                     f.write(f"{cls._marker_prefix}{cls.Marker.Name}: {snapshot.name}\n")

tests/syrupy/__snapshots__/test_doctest.ambr

@@ -4,11 +4,6 @@
     obj_attr='test class attr',
   )
 # ---
-# name: DocTestClass.1
-  DocTestClass(
-    obj_attr='test class attr',
-  )
-# ---
 # name: DocTestClass.NestedDocTestClass
   NestedDocTestClass(
     nested_obj_attr='nested doc test class attr',
@@ -20,6 +15,11 @@
 # name: DocTestClass.doctest_method
   'doc test method return value'
 # ---
+# name: DocTestClass.1
+  DocTestClass(
+    obj_attr='test class attr',
+  )
+# ---
 # name: doctest_fn
   'doc test fn return value'
 # ---

tests/syrupy/extensions/amber/__snapshots__/test_amber_serializer.ambr

@@ -247,6 +247,81 @@
     }),
   ])
 # ---
+# name: test_many_sorted
+  0
+# ---
+# name: test_many_sorted.1
+  1
+# ---
+# name: test_many_sorted.2
+  2
+# ---
+# name: test_many_sorted.3
+  3
+# ---
+# name: test_many_sorted.4
+  4
+# ---
+# name: test_many_sorted.5
+  5
+# ---
+# name: test_many_sorted.6
+  6
+# ---
+# name: test_many_sorted.7
+  7
+# ---
+# name: test_many_sorted.8
+  8
+# ---
+# name: test_many_sorted.9
+  9
+# ---
+# name: test_many_sorted.10
+  10
+# ---
+# name: test_many_sorted.11
+  11
+# ---
+# name: test_many_sorted.12
+  12
+# ---
+# name: test_many_sorted.13
+  13
+# ---
+# name: test_many_sorted.14
+  14
+# ---
+# name: test_many_sorted.15
+  15
+# ---
+# name: test_many_sorted.16
+  16
+# ---
+# name: test_many_sorted.17
+  17
+# ---
+# name: test_many_sorted.18
+  18
+# ---
+# name: test_many_sorted.19
+  19
+# ---
+# name: test_many_sorted.20
+  20
+# ---
+# name: test_many_sorted.21
+  21
+# ---
+# name: test_many_sorted.22
+  22
+# ---
+# name: test_many_sorted.23
+  23
+# ---
+# name: test_many_sorted.24
+  24
+# ---
 # name: test_multiline_string_in_dict
   dict({
     'value': '''

tests/syrupy/extensions/amber/test_amber_serializer.py

@@ -228,3 +228,8 @@ def test_ordered_dict(snapshot):
     d["b"] = 0
     d["a"] = 1
     assert snapshot == d
+
+
+def test_many_sorted(snapshot):
+    for i in range(25):
+        assert i == snapshot