perf: allow skipping of field plan generation

Replicates graphql/graphql-js@6d777e6

Author: Cito

docs/conf.py

@@ -172,6 +172,7 @@
  "GraphQLTypeResolver",
  "GraphQLWrappedResult",
  "GroupedFieldSet",
+ "IncrementalContext",
  "IncrementalDataRecord",
  "IncrementalResult",
  "Middleware",
@@ -188,7 +189,10 @@
  "enum.Enum",
  "graphql.execution.build_field_plan.FieldGroup",
  "graphql.execution.build_field_plan.FieldPlan",
+ "graphql.execution.collect_fields.CollectedFields",
  "graphql.execution.collect_fields.DeferUsage",
+ "graphql.execution.collect_fields.FieldDetails",
+ "graphql.execution.execute.IncrementalContext",
  "graphql.execution.execute.StreamArguments",
  "graphql.execution.execute.SubFieldPlan",
  "graphql.execution.execute.StreamUsage",
@@ -224,7 +228,7 @@
  "graphql.validation.rules.provided_required_arguments.ProvidedRequiredArgumentsOnDirectivesRule",
 }
 
-ignore_references.update(__builtins__.keys())
+ignore_references.update(__builtins__)
 
 
 def on_missing_reference(app, env, node, contnode):

pyproject.toml

@@ -276,6 +276,7 @@ disallow_untyped_defs = false
 # silence pyright since we're using mypy already
 reportArgumentType = false
 reportIncompatibleVariableOverride = false
+reportInvalidTypeForm = false
 reportMissingModuleSource = false
 reportMissingTypeArgument = false
 reportReturnType = false

src/graphql/execution/build_field_plan.py

@@ -2,14 +2,10 @@
 
 from __future__ import annotations
 
-import sys
-from typing import TYPE_CHECKING, Dict, NamedTuple
+from typing import NamedTuple
 
 from ..pyutils import RefMap, RefSet
-from .collect_fields import DeferUsage, FieldDetails
-
-if TYPE_CHECKING:
- from ..language import FieldNode
+from .collect_fields import DeferUsage, FieldGroup, GroupedFieldSet
 
 try:
  from typing import TypeAlias
@@ -18,7 +14,6 @@
 
 __all__ = [
  "DeferUsageSet",
- "FieldGroup",
  "FieldPlan",
  "GroupedFieldSet",
  "build_field_plan",
@@ -28,23 +23,6 @@
 DeferUsageSet: TypeAlias = RefSet[DeferUsage]
 
 
-class FieldGroup(NamedTuple):
- """A group of fields with defer usages."""
-
- fields: list[FieldDetails]
- defer_usages: DeferUsageSet | None = None
-
- def to_nodes(self) -> list[FieldNode]:
- """Return the field nodes in this group."""
- return [field_details.node for field_details in self.fields]
-
-
-if sys.version_info < (3, 9):
- GroupedFieldSet: TypeAlias = Dict[str, FieldGroup]
-else: # Python >= 3.9
- GroupedFieldSet: TypeAlias = dict[str, FieldGroup]
-
-
 class FieldPlan(NamedTuple):
  """A plan for executing fields."""
 
@@ -53,7 +31,7 @@ class FieldPlan(NamedTuple):
 
 
 def build_field_plan(
- fields: dict[str, list[FieldDetails]],
+ original_grouped_field_set: GroupedFieldSet,
  parent_defer_usages: DeferUsageSet | None = None,
 ) -> FieldPlan:
  """Build a plan for executing fields."""
@@ -64,12 +42,12 @@ def build_field_plan(
 
  new_grouped_field_sets: RefMap[DeferUsageSet, GroupedFieldSet] = RefMap()
 
- map_: dict[str, tuple[DeferUsageSet, list[FieldDetails]]] = {}
+ map_: dict[str, tuple[DeferUsageSet, FieldGroup]] = {}
 
- for response_key, field_details_list in fields.items():
+ for response_key, field_group in original_grouped_field_set.items():
  defer_usage_set: RefSet[DeferUsage] = RefSet()
  in_original_result = False
- for field_details in field_details_list:
+ for field_details in field_group:
  defer_usage = field_details.defer_usage
  if defer_usage is None:
  in_original_result = True
@@ -85,15 +63,11 @@ def build_field_plan(
  ancestor in defer_usage_set for ancestor in defer_usage.ancestors
  )
  }
- map_[response_key] = (defer_usage_set, field_details_list)
+ map_[response_key] = (defer_usage_set, field_group)
 
- for response_key, [defer_usage_set, field_details_list] in map_.items():
+ for response_key, [defer_usage_set, field_group] in map_.items():
  if defer_usage_set == parent_defer_usages:
- field_group = grouped_field_set.get(response_key)
- if field_group is None: # pragma: no cover else
- field_group = FieldGroup([], defer_usage_set)
- grouped_field_set[response_key] = field_group
- field_group.fields.extend(field_details_list)
+ grouped_field_set[response_key] = field_group
  continue
 
  for (
@@ -107,10 +81,6 @@ def build_field_plan(
  new_grouped_field_set = {}
  new_grouped_field_sets[defer_usage_set] = new_grouped_field_set
 
- field_group = new_grouped_field_set.get(response_key)
- if field_group is None: # pragma: no cover else
- field_group = FieldGroup([], defer_usage_set)
- new_grouped_field_set[response_key] = field_group
- field_group.fields.extend(field_details_list)
+ new_grouped_field_set[response_key] = field_group
 
  return FieldPlan(grouped_field_set, new_grouped_field_sets)

src/graphql/execution/collect_fields.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import sys
 from collections import defaultdict
 from typing import Any, NamedTuple
 
@@ -25,11 +26,18 @@
 from ..utilities.type_from_ast import type_from_ast
 from .values import get_directive_values
 
+try:
+ from typing import TypeAlias
+except ImportError: # Python < 3.10
+ from typing_extensions import TypeAlias
+
 __all__ = [
  "CollectFieldsContext",
  "CollectedFields",
  "DeferUsage",
  "FieldDetails",
+ "FieldGroup",
+ "GroupedFieldSet",
  "collect_fields",
  "collect_subfields",
 ]
@@ -59,6 +67,16 @@ class FieldDetails(NamedTuple):
  defer_usage: DeferUsage | None
 
 
+if sys.version_info < (3, 9):
+ from typing import Dict, List
+
+ FieldGroup: TypeAlias = List[FieldDetails]
+ GroupedFieldSet: TypeAlias = Dict[str, FieldGroup]
+else: # Python >= 3.9
+ FieldGroup: TypeAlias = list[FieldDetails]
+ GroupedFieldSet: TypeAlias = dict[str, FieldGroup]
+
+
 class CollectFieldsContext(NamedTuple):
  """Context for collecting fields."""
 
@@ -73,7 +91,7 @@ class CollectFieldsContext(NamedTuple):
 class CollectedFields(NamedTuple):
  """Collected fields with new defer usages."""
 
- fields: dict[str, list[FieldDetails]]
+ grouped_field_set: GroupedFieldSet
  new_defer_usages: list[DeferUsage]
 
 
@@ -117,7 +135,7 @@ def collect_subfields(
  variable_values: dict[str, Any],
  operation: OperationDefinitionNode,
  return_type: GraphQLObjectType,
- field_details: list[FieldDetails],
+ field_group: FieldGroup,
 ) -> CollectedFields:
  """Collect subfields.
 
@@ -141,7 +159,7 @@ def collect_subfields(
  sub_grouped_field_set: dict[str, list[FieldDetails]] = defaultdict(list)
  new_defer_usages: list[DeferUsage] = []
 
- for field_detail in field_details:
+ for field_detail in field_group:
  node = field_detail.node
  if node.selection_set:
  collect_fields_impl(