Replace lexicographic with natural sorting

Replicates graphql/graphql-js@16d2535

Author: Cito

src/graphql/pyutils/__init__.py

@@ -23,6 +23,7 @@
 from .is_collection import is_collection
 from .is_finite import is_finite
 from .is_integer import is_integer
+from .natural_compare import natural_comparison_key
 from .awaitable_or_value import AwaitableOrValue
 from .suggestion_list import suggestion_list
 from .frozen_error import FrozenError
@@ -48,6 +49,7 @@
     "is_collection",
     "is_finite",
     "is_integer",
+    "natural_comparison_key",
     "AwaitableOrValue",
     "suggestion_list",
     "FrozenError",

src/graphql/pyutils/natural_compare.py

@@ -0,0 +1,19 @@
+import re
+from typing import Tuple
+
+from itertools import cycle
+
+__all__ = ["natural_comparison_key"]
+
+_re_digits = re.compile(r"(\d+)")
+
+
+def natural_comparison_key(key: str) -> Tuple:
+    """Comparison key function for sorting strings by natural sort order.
+
+    See: https://en.wikipedia.org/wiki/Natural_sort_order
+    """
+    return tuple(
+        (int(part), part) if is_digit else part
+        for part, is_digit in zip(_re_digits.split(key), cycle((False, True)))
+    )

src/graphql/pyutils/suggestion_list.py

@@ -1,5 +1,7 @@
 from typing import Collection, Optional, List
 
+from .natural_compare import natural_comparison_key
+
 __all__ = ["suggestion_list"]
 
 
@@ -21,7 +23,10 @@ def suggestion_list(input_: str, options: Collection[str]) -> List[str]:
     # noinspection PyShadowingNames
     return sorted(
         options_by_distance,
-        key=lambda option: (options_by_distance.get(option, 0), option),
+        key=lambda option: (
+            options_by_distance.get(option, 0),
+            natural_comparison_key(option),
+        ),
     )
 
 

src/graphql/utilities/find_breaking_changes.py

@@ -1,9 +1,8 @@
 from enum import Enum
-from operator import attrgetter
 from typing import Any, Dict, List, NamedTuple, Union, cast
 
 from ..language import print_ast, visit, ObjectValueNode, Visitor
-from ..pyutils import inspect, FrozenList, Undefined
+from ..pyutils import inspect, natural_comparison_key, FrozenList, Undefined
 from ..type import (
     GraphQLEnumType,
     GraphQLField,
@@ -563,7 +562,10 @@ def enter_object_value(
             object_value_node: ObjectValueNode, *_args: Any
         ) -> ObjectValueNode:
             object_value_node.fields = FrozenList(
-                sorted(object_value_node.fields, key=attrgetter("name.value"))
+                sorted(
+                    object_value_node.fields,
+                    key=lambda node: natural_comparison_key(node.name.value),
+                )
             )
             return object_value_node
 

src/graphql/utilities/lexicographic_sort_schema.py

@@ -1,7 +1,7 @@
 from typing import Dict, List, Optional, Tuple, Union, cast
 
 from ..language import DirectiveLocation
-from ..pyutils import inspect, FrozenList
+from ..pyutils import inspect, natural_comparison_key, FrozenList
 from ..type import (
     GraphQLArgument,
     GraphQLDirective,
@@ -174,7 +174,5 @@ def sort_named_type(type_: GraphQLNamedType) -> GraphQLNamedType:
 
 def sort_by_name_key(
     type_: Union[GraphQLNamedType, GraphQLDirective, DirectiveLocation]
-) -> Tuple[bool, str]:
-    name = type_.name
-    # GraphQL.JS sorts '_' first using localeCompare
-    return not name.startswith("_"), name
+) -> Tuple:
+    return natural_comparison_key(type_.name)

src/graphql/validation/rules/fields_on_correct_type.py

@@ -14,7 +14,7 @@
 )
 from ...error import GraphQLError
 from ...language import FieldNode
-from ...pyutils import did_you_mean, suggestion_list
+from ...pyutils import did_you_mean, natural_comparison_key, suggestion_list
 from . import ValidationRule
 
 __all__ = ["FieldsOnCorrectTypeRule"]
@@ -109,9 +109,11 @@ def cmp(
         ):
             return 1
 
-        if type_a.name > type_b.name:
+        name_a = natural_comparison_key(type_a.name)
+        name_b = natural_comparison_key(type_b.name)
+        if name_a > name_b:
             return 1
-        if type_a.name < type_b.name:
+        if name_a < name_b:
             return -1
         return 0
 

tests/pyutils/test_natural_compare.py

@@ -0,0 +1,29 @@
+from graphql.pyutils import natural_comparison_key
+
+key = natural_comparison_key
+
+
+def describe_natural_compare():
+    def handles_empty_strings():
+        assert key("") < key("a")
+        assert key("") < key("1")
+
+    def handles_strings_of_different_length():
+        assert key("A") < key("AA")
+        assert key("A1") < key("A1A")
+
+    def handles_numbers():
+        assert key("1") < key("2")
+        assert key("2") < key("11")
+
+    def handles_numbers_with_leading_zeros():
+        assert key("0") < key("00")
+        assert key("02") < key("11")
+        assert key("011") < key("200")
+
+    def handles_numbers_embedded_into_names():
+        assert key("a0a") < key("a9a")
+        assert key("a00a") < key("a09a")
+        assert key("a0a1") < key("a0a9")
+        assert key("a10a11a") < key("a10a19a")
+        assert key("a10a11a") < key("a10a11b")

tests/pyutils/test_suggestion_list.py

@@ -46,12 +46,14 @@ def returns_options_sorted_based_on_lexical_distance():
             ["GraphQL", "graphics"],
         )
 
-    def returns_options_with_the_same_lexical_distance_sorted_lexicographically():
+    def returns_options_with_the_same_lexical_distance_sorted_naturally():
         expect_suggestions("a", ["az", "ax", "ay"], ["ax", "ay", "az"])
 
         expect_suggestions("boo", ["moo", "foo", "zoo"], ["foo", "moo", "zoo"])
 
-    def returns_options_sorted_first_by_lexical_distance_then_lexicographically():
+        expect_suggestions("abc", ["a1", "a12", "a2"], ["a1", "a2", "a12"])
+
+    def returns_options_sorted_first_by_lexical_distance_then_naturally():
         expect_suggestions(
             "csutomer",
             ["store", "customer", "stomer", "some", "more"],