Extract "did_you_mean" util function

Replicates graphql/graphql-js@f5a975f

Author: Cito

README.md

@@ -13,7 +13,7 @@ a query language for APIs created by Facebook.
 [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
 The current version 1.0.5 of GraphQL-core-next is up-to-date with GraphQL.js version
-14.3.1. All parts of the API are covered by an extensive test suite of currently 1790
+14.3.1. All parts of the API are covered by an extensive test suite of currently 1784
 unit tests.
 
 

docs/modules/pyutils.rst

@@ -9,6 +9,7 @@ PyUtils
 .. autofunction:: snake_to_camel
 .. autofunction:: cached_property
 .. autofunction:: dedent
+.. autofunction:: did_you_mean
 .. autoclass:: EventEmitter
 .. autoclass:: EventEmitterAsyncIterator
 .. autofunction:: inspect
@@ -17,8 +18,6 @@ PyUtils
 .. autofunction:: is_invalid
 .. autofunction:: is_nullish
 .. autoclass:: AwaitableOrValue
-.. autofunction:: or_list
-.. autofunction:: quoted_or_list
 .. autofunction:: suggestion_list
 .. autoclass:: FrozenError
 .. autoclass:: FrozenList

graphql/pyutils/__init__.py

@@ -11,15 +11,14 @@
 from .convert_case import camel_to_snake, snake_to_camel
 from .cached_property import cached_property
 from .dedent import dedent
+from .did_you_mean import did_you_mean
 from .event_emitter import EventEmitter, EventEmitterAsyncIterator
 from .inspect import inspect
 from .is_finite import is_finite
 from .is_integer import is_integer
 from .is_invalid import is_invalid
 from .is_nullish import is_nullish
 from .awaitable_or_value import AwaitableOrValue
-from .or_list import or_list
-from .quoted_or_list import quoted_or_list
 from .suggestion_list import suggestion_list
 from .frozen_error import FrozenError
 from .frozen_list import FrozenList
@@ -30,6 +29,7 @@
     "snake_to_camel",
     "cached_property",
     "dedent",
+    "did_you_mean",
     "EventEmitter",
     "EventEmitterAsyncIterator",
     "inspect",
@@ -38,8 +38,6 @@
     "is_invalid",
     "is_nullish",
     "AwaitableOrValue",
-    "or_list",
-    "quoted_or_list",
     "suggestion_list",
     "FrozenError",
     "FrozenList",

graphql/pyutils/did_you_mean.py

@@ -0,0 +1,21 @@
+from typing import Sequence, List
+
+__all__ = ["did_you_mean"]
+
+MAX_LENGTH = 5
+
+
+def did_you_mean(suggestions: Sequence[str], sub_message: str = None) -> str:
+    """Given [ A, B, C ] return ' Did you mean A, B, or C?'"""
+    parts: List[str] = []
+    if suggestions:
+        append = parts.append
+        append(" Did you mean")
+        if sub_message:
+            append(sub_message)
+        suggestions = suggestions[:MAX_LENGTH]
+        if len(suggestions) > 1:
+            append(", ".join(suggestions[:-1]))
+            append("or")
+        append(suggestions[-1] + "?")
+    return " ".join(parts)

graphql/pyutils/or_list.py

@@ -1,9 +1,9 @@
-from typing import Collection
+from typing import Collection, List
 
 __all__ = ["suggestion_list"]
 
 
-def suggestion_list(input_: str, options: Collection[str]):
+def suggestion_list(input_: str, options: Collection[str]) -> List[str]:
     """Get list with suggestions for a given input.
 
     Given an invalid input string and list of valid options, returns a filtered list

graphql/pyutils/quoted_or_list.py

@@ -2,7 +2,7 @@
 
 from ..error import GraphQLError, INVALID
 from ..language import Node
-from ..pyutils import inspect, is_invalid, or_list, suggestion_list
+from ..pyutils import did_you_mean, inspect, is_invalid, suggestion_list
 from ..type import (
     GraphQLEnumType,
     GraphQLInputObjectType,
@@ -75,7 +75,7 @@ def coerce_value(
                         f"Expected type {type_.name}",
                         blame_node,
                         path,
-                        str(error),
+                        f" {error}",
                         error,
                     )
                 ]
@@ -89,11 +89,13 @@ def coerce_value(
             if enum_value:
                 return of_value(value if enum_value.value is None else enum_value.value)
         suggestions = suggestion_list(str(value), values)
-        did_you_mean = f"did you mean {or_list(suggestions)}?" if suggestions else None
         return of_errors(
             [
                 coercion_error(
-                    f"Expected type {type_.name}", blame_node, path, did_you_mean
+                    f"Expected type {type_.name}",
+                    blame_node,
+                    path,
+                    did_you_mean(suggestions),
                 )
             ]
         )
@@ -160,16 +162,13 @@ def coerce_value(
         for field_name in value:
             if field_name not in fields:
                 suggestions = suggestion_list(field_name, fields)
-                did_you_mean = (
-                    f"did you mean {or_list(suggestions)}?" if suggestions else None
-                )
                 errors = add(
                     errors,
                     coercion_error(
                         f"Field '{field_name}' is not defined by type {type_.name}",
                         blame_node,
                         path,
-                        did_you_mean,
+                        did_you_mean(suggestions),
                     ),
                 )
 
@@ -205,15 +204,17 @@ def coercion_error(
     original_error: Exception = None,
 ) -> GraphQLError:
     """Return a GraphQLError instance"""
-    if path:
-        path_str = print_path(path)
+    path_str = print_path(path)
+    if path_str:
         message += f" at {path_str}"
-    message += f"; {sub_message}" if sub_message else "."
+    message += "."
+    if sub_message:
+        message += sub_message
     # noinspection PyArgumentEqualDefault
     return GraphQLError(message, blame_node, None, None, None, original_error)
 
 
-def print_path(path: Path) -> str:
+def print_path(path: Optional[Path]) -> str:
     """Build string describing the path into the value where error was found"""
     path_str = ""
     current_path: Optional[Path] = path

graphql/pyutils/suggestion_list.py

@@ -11,7 +11,7 @@
 )
 from ...error import GraphQLError
 from ...language import FieldNode
-from ...pyutils import quoted_or_list, suggestion_list
+from ...pyutils import did_you_mean, suggestion_list
 from . import ValidationRule
 
 __all__ = ["FieldsOnCorrectTypeRule", "undefined_field_message"]
@@ -23,14 +23,10 @@ def undefined_field_message(
     suggested_type_names: List[str],
     suggested_field_names: List[str],
 ) -> str:
-    message = f"Cannot query field '{field_name}' on type '{type_}'."
-    if suggested_type_names:
-        suggestions = quoted_or_list(suggested_type_names)
-        message += f" Did you mean to use an inline fragment on {suggestions}?"
-    elif suggested_field_names:
-        suggestions = quoted_or_list(suggested_field_names)
-        message += f" Did you mean {suggestions}?"
-    return message
+    hint = did_you_mean(
+        [f"'{s}'" for s in suggested_type_names], "to use an inline fragment on"
+    ) or did_you_mean([f"'{s}'" for s in suggested_field_names])
+    return f"Cannot query field '{field_name}' on type '{type_}'.{hint}"
 
 
 class FieldsOnCorrectTypeRule(ValidationRule):

graphql/utilities/coerce_value.py

@@ -2,7 +2,7 @@
 
 from ...error import GraphQLError
 from ...language import ArgumentNode, DirectiveDefinitionNode, DirectiveNode, SKIP
-from ...pyutils import quoted_or_list, suggestion_list
+from ...pyutils import did_you_mean, suggestion_list
 from ...type import specified_directives
 from . import ASTValidationRule, SDLValidationContext, ValidationContext
 
@@ -17,22 +17,18 @@
 def unknown_arg_message(
     arg_name: str, field_name: str, type_name: str, suggested_args: List[str]
 ) -> str:
-    message = (
+    hint = did_you_mean([f"'{s}'" for s in suggested_args])
+    return (
         f"Unknown argument '{arg_name}' on field '{field_name}'"
-        f" of type '{type_name}'."
+        f" of type '{type_name}'.{hint}"
     )
-    if suggested_args:
-        message += f" Did you mean {quoted_or_list(suggested_args)}?"
-    return message
 
 
 def unknown_directive_arg_message(
     arg_name: str, directive_name: str, suggested_args: List[str]
 ) -> str:
-    message = f"Unknown argument '{arg_name}' on directive '@{directive_name}'."
-    if suggested_args:
-        message += f" Did you mean {quoted_or_list(suggested_args)}?"
-    return message
+    hint = did_you_mean([f"'{s}'" for s in suggested_args])
+    return f"Unknown argument '{arg_name}' on directive '@{directive_name}'. {hint}"
 
 
 class KnownArgumentNamesOnDirectivesRule(ASTValidationRule):