Rename MaybeAwaitable to AwaitableOrValue

Replicates graphql/graphql-js@329f357

Author: Cito

Pipfile

@@ -20,3 +20,6 @@ pyyaml = ">=4.0"
 
 [pipenv]
 allow_prereleases = true
+
+[packages]
+graphql-core-next = {editable = true,path = "."}

Pipfile.lock

@@ -13,7 +13,7 @@ PyUtils
 .. autofunction:: is_integer
 .. autofunction:: is_invalid
 .. autofunction:: is_nullish
-.. autoclass:: MaybeAwaitable
+.. autoclass:: AwaitableOrValue
 .. autofunction:: or_list
 .. autofunction:: quoted_or_list
 .. autofunction:: suggestion_list

docs/modules/pyutils.rst

@@ -26,7 +26,7 @@
     OperationType,
     SelectionSetNode,
 )
-from ..pyutils import inspect, is_invalid, is_nullish, MaybeAwaitable
+from ..pyutils import inspect, is_invalid, is_nullish, AwaitableOrValue
 from ..utilities import get_operation_root_type, type_from_ast
 from ..type import (
     GraphQLAbstractType,
@@ -116,7 +116,7 @@ def execute(
     type_resolver: GraphQLTypeResolver = None,
     middleware: Middleware = None,
     execution_context_class: Type["ExecutionContext"] = None,
-) -> MaybeAwaitable[ExecutionResult]:
+) -> AwaitableOrValue[ExecutionResult]:
     """Execute a GraphQL operation.
 
     Implements the "Evaluating requests" section of the GraphQL specification.
@@ -304,8 +304,8 @@ def build(
         )
 
     def build_response(
-        self, data: MaybeAwaitable[Optional[Dict[str, Any]]]
-    ) -> MaybeAwaitable[ExecutionResult]:
+        self, data: AwaitableOrValue[Optional[Dict[str, Any]]]
+    ) -> AwaitableOrValue[ExecutionResult]:
         """Build response.
 
         Given a completed execution context and data, build the (data, errors) response
@@ -328,7 +328,7 @@ async def build_response_async():
 
     def execute_operation(
         self, operation: OperationDefinitionNode, root_value: Any
-    ) -> Optional[MaybeAwaitable[Any]]:
+    ) -> Optional[AwaitableOrValue[Any]]:
         """Execute an operation.
 
         Implements the "Evaluating operations" section of the spec.
@@ -377,7 +377,7 @@ def execute_fields_serially(
         source_value: Any,
         path: Optional[ResponsePath],
         fields: Dict[str, List[FieldNode]],
-    ) -> MaybeAwaitable[Dict[str, Any]]:
+    ) -> AwaitableOrValue[Dict[str, Any]]:
         """Execute the given fields serially.
 
         Implements the "Evaluating selection sets" section of the spec for "write" mode.
@@ -427,7 +427,7 @@ def execute_fields(
         source_value: Any,
         path: Optional[ResponsePath],
         fields: Dict[str, List[FieldNode]],
-    ) -> MaybeAwaitable[Dict[str, Any]]:
+    ) -> AwaitableOrValue[Dict[str, Any]]:
         """Execute the given fields concurrently.
 
         Implements the "Evaluating selection sets" section of the spec for "read" mode.
@@ -581,7 +581,7 @@ def resolve_field(
         source: Any,
         field_nodes: List[FieldNode],
         path: ResponsePath,
-    ) -> MaybeAwaitable[Any]:
+    ) -> AwaitableOrValue[Any]:
         """Resolve the field on the given source object.
 
         In particular, this figures out the value that the field returns by calling its
@@ -652,7 +652,7 @@ def complete_value_catching_error(
         info: GraphQLResolveInfo,
         path: ResponsePath,
         result: Any,
-    ) -> MaybeAwaitable[Any]:
+    ) -> AwaitableOrValue[Any]:
         """Complete a value while catching an error.
 
         This is a small wrapper around completeValue which detects and logs errors in
@@ -713,7 +713,7 @@ def complete_value(
         info: GraphQLResolveInfo,
         path: ResponsePath,
         result: Any,
-    ) -> MaybeAwaitable[Any]:
+    ) -> AwaitableOrValue[Any]:
         """Complete a value.
 
         Implements the instructions for completeValue as defined in the "Field entries"
@@ -797,7 +797,7 @@ def complete_list_value(
         info: GraphQLResolveInfo,
         path: ResponsePath,
         result: Iterable[Any],
-    ) -> MaybeAwaitable[Any]:
+    ) -> AwaitableOrValue[Any]:
         """Complete a list value.
 
         Complete a list value by completing each item in the list with the inner type.
@@ -866,7 +866,7 @@ def complete_abstract_value(
         info: GraphQLResolveInfo,
         path: ResponsePath,
         result: Any,
-    ) -> MaybeAwaitable[Any]:
+    ) -> AwaitableOrValue[Any]:
         """Complete an abstract value.
 
         Complete a value of an abstract type by determining the runtime object type of
@@ -947,7 +947,7 @@ def complete_object_value(
         info: GraphQLResolveInfo,
         path: ResponsePath,
         result: Any,
-    ) -> MaybeAwaitable[Dict[str, Any]]:
+    ) -> AwaitableOrValue[Dict[str, Any]]:
         """Complete an Object value by executing all sub-selections."""
         # If there is an `is_type_of()` predicate function, call it with the current
         # result. If `is_type_of()` returns False, then raise an error rather than
@@ -981,7 +981,7 @@ def collect_and_execute_subfields(
         field_nodes: List[FieldNode],
         path: ResponsePath,
         result: Any,
-    ) -> MaybeAwaitable[Dict[str, Any]]:
+    ) -> AwaitableOrValue[Dict[str, Any]]:
         """Collect sub-fields to execute to complete this value."""
         sub_field_nodes = self.collect_subfields(return_type, field_nodes)
         return self.execute_fields(return_type, result, path, sub_field_nodes)
@@ -1100,7 +1100,7 @@ def invalid_return_type_error(
 
 def default_type_resolver(
     value: Any, info: GraphQLResolveInfo, abstract_type: GraphQLAbstractType
-) -> MaybeAwaitable[Optional[Union[GraphQLObjectType, str]]]:
+) -> AwaitableOrValue[Optional[Union[GraphQLObjectType, str]]]:
     """Default type resolver function.
 
     If a resolve_type function is not given, then a default resolve behavior is used

graphql/execution/execute.py

@@ -16,7 +16,7 @@ class MiddlewareManager:
     If middleware is provided as an object, it must provide a method `resolve` that is
     used as the middleware function.
 
-    Note that since resolvers return "MaybeAwaitable" values, all middleware functions
+    Note that since resolvers return "AwaitableOrValue"s, all middleware functions
     must be aware of this and check whether values are awaitable before awaiting them.
     """
 

graphql/execution/middleware.py

@@ -5,7 +5,7 @@
 from .error import GraphQLError
 from .execution import execute, ExecutionResult, ExecutionContext, Middleware
 from .language import parse, Source
-from .pyutils import MaybeAwaitable
+from .pyutils import AwaitableOrValue
 from .type import (
     GraphQLFieldResolver,
     GraphQLSchema,
@@ -141,7 +141,7 @@ def graphql_impl(
     type_resolver,
     middleware,
     execution_context_class,
-) -> MaybeAwaitable[ExecutionResult]:
+) -> AwaitableOrValue[ExecutionResult]:
     """Execute a query, return asynchronously only if necessary."""
     # Validate Schema
     schema_validation_errors = validate_schema(schema)

graphql/graphql.py

@@ -17,7 +17,7 @@
 from .is_integer import is_integer
 from .is_invalid import is_invalid
 from .is_nullish import is_nullish
-from .maybe_awaitable import MaybeAwaitable
+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
@@ -34,7 +34,7 @@
     "is_integer",
     "is_invalid",
     "is_nullish",
-    "MaybeAwaitable",
+    "AwaitableOrValue",
     "or_list",
     "quoted_or_list",
     "suggestion_list",

graphql/pyutils/__init__.py

@@ -0,0 +1,8 @@
+from typing import Awaitable, TypeVar, Union
+
+__all__ = ["AwaitableOrValue"]
+
+
+T = TypeVar("T")
+
+AwaitableOrValue = Union[Awaitable[T], T]

graphql/pyutils/awaitable_or_value.py

@@ -42,7 +42,7 @@
     UnionTypeExtensionNode,
     ValueNode,
 )
-from ..pyutils import MaybeAwaitable, cached_property, inspect
+from ..pyutils import AwaitableOrValue, cached_property, inspect
 from ..utilities.value_from_ast_untyped import value_from_ast_untyped
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -513,12 +513,12 @@ class GraphQLResolveInfo(NamedTuple):
 # the context is passed as part of the GraphQLResolveInfo:
 GraphQLTypeResolver = Callable[
     [Any, GraphQLResolveInfo, "GraphQLAbstractType"],
-    MaybeAwaitable[Optional[Union["GraphQLObjectType", str]]],
+    AwaitableOrValue[Optional[Union["GraphQLObjectType", str]]],
 ]
 
 # Note: Contrary to the Javascript implementation of GraphQLIsTypeOfFn,
 # the context is passed as part of the GraphQLResolveInfo:
-GraphQLIsTypeOfFn = Callable[[Any, GraphQLResolveInfo], MaybeAwaitable[bool]]
+GraphQLIsTypeOfFn = Callable[[Any, GraphQLResolveInfo], AwaitableOrValue[bool]]
 
 
 class GraphQLArgument: