-
-
Notifications
You must be signed in to change notification settings - Fork 137
/
Copy pathexecute.py
2348 lines (2042 loc) · 83.7 KB
/
execute.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""GraphQL execution"""
from __future__ import annotations
from asyncio import ensure_future, gather, shield, wait_for
from contextlib import suppress
from copy import copy
from typing import (
Any,
AsyncGenerator,
AsyncIterable,
AsyncIterator,
Awaitable,
Callable,
Iterable,
List,
Mapping,
NamedTuple,
Optional,
Sequence,
Tuple,
Union,
cast,
)
try:
from typing import TypeAlias, TypeGuard # noqa: F401
except ImportError: # Python < 3.10
from typing_extensions import TypeAlias
try: # only needed for Python < 3.11
from asyncio.exceptions import TimeoutError # noqa: A004
except ImportError: # Python < 3.7
from concurrent.futures import TimeoutError # noqa: A004
from ..error import GraphQLError, located_error
from ..language import (
DocumentNode,
FragmentDefinitionNode,
OperationDefinitionNode,
OperationType,
)
from ..pyutils import (
AwaitableOrValue,
Path,
RefMap,
Undefined,
async_reduce,
inspect,
is_iterable,
)
from ..pyutils import is_awaitable as default_is_awaitable
from ..type import (
GraphQLAbstractType,
GraphQLField,
GraphQLFieldResolver,
GraphQLLeafType,
GraphQLList,
GraphQLObjectType,
GraphQLOutputType,
GraphQLResolveInfo,
GraphQLSchema,
GraphQLStreamDirective,
GraphQLTypeResolver,
assert_valid_schema,
is_abstract_type,
is_leaf_type,
is_list_type,
is_non_null_type,
is_object_type,
)
from .async_iterables import map_async_iterable
from .collect_fields import (
NON_DEFERRED_TARGET_SET,
CollectFieldsResult,
DeferUsage,
DeferUsageSet,
FieldDetails,
FieldGroup,
GroupedFieldSet,
GroupedFieldSetDetails,
collect_fields,
collect_subfields,
)
from .incremental_publisher import (
ASYNC_DELAY,
DeferredFragmentRecord,
DeferredGroupedFieldSetRecord,
ExecutionResult,
ExperimentalIncrementalExecutionResults,
IncrementalDataRecord,
IncrementalPublisher,
InitialResultRecord,
StreamItemsRecord,
StreamRecord,
)
from .middleware import MiddlewareManager
from .values import get_argument_values, get_directive_values, get_variable_values
try: # pragma: no cover
anext # noqa: B018 # pyright: ignore
except NameError: # pragma: no cover (Python < 3.10)
# noinspection PyShadowingBuiltins
async def anext(iterator: AsyncIterator) -> Any:
"""Return the next item from an async iterator."""
return await iterator.__anext__()
__all__ = [
"ASYNC_DELAY",
"ExecutionContext",
"Middleware",
"create_source_event_stream",
"default_field_resolver",
"default_type_resolver",
"execute",
"execute_sync",
"experimental_execute_incrementally",
"subscribe",
]
suppress_exceptions = suppress(Exception)
suppress_timeout_error = suppress(TimeoutError)
# Terminology
#
# "Definitions" are the generic name for top-level statements in the document.
# Examples of this include:
# 1) Operations (such as a query)
# 2) Fragments
#
# "Operations" are a generic name for requests in the document.
# Examples of this include:
# 1) query,
# 2) mutation
#
# "Selections" are the definitions that can appear legally and at
# single level of the query. These include:
# 1) field references e.g "a"
# 2) fragment "spreads" e.g. "...c"
# 3) inline fragment "spreads" e.g. "...on Type { a }"
Middleware: TypeAlias = Optional[Union[Tuple, List, MiddlewareManager]]
class StreamUsage(NamedTuple):
"""Stream directive usage information"""
label: str | None
initial_count: int
field_group: FieldGroup
class ExecutionContext:
"""Data that must be available at all points during query execution.
Namely, schema of the type system that is currently executing, and the fragments
defined in the query document.
"""
schema: GraphQLSchema
fragments: dict[str, FragmentDefinitionNode]
root_value: Any
context_value: Any
operation: OperationDefinitionNode
variable_values: dict[str, Any]
field_resolver: GraphQLFieldResolver
type_resolver: GraphQLTypeResolver
subscribe_field_resolver: GraphQLFieldResolver
incremental_publisher: IncrementalPublisher
middleware_manager: MiddlewareManager | None
is_awaitable: Callable[[Any], bool] = staticmethod(default_is_awaitable)
def __init__(
self,
schema: GraphQLSchema,
fragments: dict[str, FragmentDefinitionNode],
root_value: Any,
context_value: Any,
operation: OperationDefinitionNode,
variable_values: dict[str, Any],
field_resolver: GraphQLFieldResolver,
type_resolver: GraphQLTypeResolver,
subscribe_field_resolver: GraphQLFieldResolver,
incremental_publisher: IncrementalPublisher,
middleware_manager: MiddlewareManager | None,
is_awaitable: Callable[[Any], bool] | None,
) -> None:
self.schema = schema
self.fragments = fragments
self.root_value = root_value
self.context_value = context_value
self.operation = operation
self.variable_values = variable_values
self.field_resolver = field_resolver
self.type_resolver = type_resolver
self.subscribe_field_resolver = subscribe_field_resolver
self.incremental_publisher = incremental_publisher
self.middleware_manager = middleware_manager
if is_awaitable:
self.is_awaitable = is_awaitable
self._canceled_iterators: set[AsyncIterator] = set()
self._subfields_cache: dict[tuple, CollectFieldsResult] = {}
self._tasks: set[Awaitable] = set()
self._stream_usages: RefMap[FieldGroup, StreamUsage] = RefMap()
@classmethod
def build(
cls,
schema: GraphQLSchema,
document: DocumentNode,
root_value: Any = None,
context_value: Any = None,
raw_variable_values: dict[str, Any] | None = None,
operation_name: str | None = None,
field_resolver: GraphQLFieldResolver | None = None,
type_resolver: GraphQLTypeResolver | None = None,
subscribe_field_resolver: GraphQLFieldResolver | None = None,
middleware: Middleware | None = None,
is_awaitable: Callable[[Any], bool] | None = None,
**custom_args: Any,
) -> list[GraphQLError] | ExecutionContext:
"""Build an execution context
Constructs a ExecutionContext object from the arguments passed to execute, which
we will pass throughout the other execution methods.
Throws a GraphQLError if a valid execution context cannot be created.
For internal use only.
"""
# If the schema used for execution is invalid, raise an error.
assert_valid_schema(schema)
operation: OperationDefinitionNode | None = None
fragments: dict[str, FragmentDefinitionNode] = {}
middleware_manager: MiddlewareManager | None = None
if middleware is not None:
if isinstance(middleware, (list, tuple)):
middleware_manager = MiddlewareManager(*middleware)
elif isinstance(middleware, MiddlewareManager):
middleware_manager = middleware
else:
msg = (
"Middleware must be passed as a list or tuple of functions"
" or objects, or as a single MiddlewareManager object."
f" Got {inspect(middleware)} instead."
)
raise TypeError(msg)
for definition in document.definitions:
if isinstance(definition, OperationDefinitionNode):
if operation_name is None:
if operation:
return [
GraphQLError(
"Must provide operation name"
" if query contains multiple operations."
)
]
operation = definition
elif definition.name and definition.name.value == operation_name:
operation = definition
elif isinstance(definition, FragmentDefinitionNode):
fragments[definition.name.value] = definition
if not operation:
if operation_name is not None:
return [GraphQLError(f"Unknown operation named '{operation_name}'.")]
return [GraphQLError("Must provide an operation.")]
coerced_variable_values = get_variable_values(
schema,
operation.variable_definitions or (),
raw_variable_values or {},
max_errors=50,
)
if isinstance(coerced_variable_values, list):
return coerced_variable_values # errors
return cls(
schema,
fragments,
root_value,
context_value,
operation,
coerced_variable_values, # coerced values
field_resolver or default_field_resolver,
type_resolver or default_type_resolver,
subscribe_field_resolver or default_field_resolver,
IncrementalPublisher(),
middleware_manager,
is_awaitable,
**custom_args,
)
def build_per_event_execution_context(self, payload: Any) -> ExecutionContext:
"""Create a copy of the execution context for usage with subscribe events."""
context = copy(self)
context.root_value = payload
return context
def execute_operation(
self, initial_result_record: InitialResultRecord
) -> AwaitableOrValue[dict[str, Any]]:
"""Execute an operation.
Implements the "Executing operations" section of the spec.
"""
operation = self.operation
schema = self.schema
root_type = schema.get_root_type(operation.operation)
if root_type is None:
msg = (
"Schema is not configured to execute"
f" {operation.operation.value} operation."
)
raise GraphQLError(msg, operation)
grouped_field_set, new_grouped_field_set_details, new_defer_usages = (
collect_fields(
schema, self.fragments, self.variable_values, root_type, operation
)
)
incremental_publisher = self.incremental_publisher
new_defer_map = add_new_deferred_fragments(
incremental_publisher, new_defer_usages, initial_result_record
)
path: Path | None = None
new_deferred_grouped_field_set_records = add_new_deferred_grouped_field_sets(
incremental_publisher,
new_grouped_field_set_details,
new_defer_map,
path,
)
root_value = self.root_value
# noinspection PyTypeChecker
result = (
self.execute_fields_serially
if operation.operation == OperationType.MUTATION
else self.execute_fields
)(
root_type,
root_value,
path,
grouped_field_set,
initial_result_record,
new_defer_map,
)
self.execute_deferred_grouped_field_sets(
root_type,
root_value,
path,
new_deferred_grouped_field_set_records,
new_defer_map,
)
return result
def execute_fields_serially(
self,
parent_type: GraphQLObjectType,
source_value: Any,
path: Path | None,
grouped_field_set: GroupedFieldSet,
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> AwaitableOrValue[dict[str, Any]]:
"""Execute the given fields serially.
Implements the "Executing selection sets" section of the spec
for fields that must be executed serially.
"""
is_awaitable = self.is_awaitable
def reducer(
results: dict[str, Any], field_item: tuple[str, FieldGroup]
) -> AwaitableOrValue[dict[str, Any]]:
response_name, field_group = field_item
field_path = Path(path, response_name, parent_type.name)
result = self.execute_field(
parent_type,
source_value,
field_group,
field_path,
incremental_data_record,
defer_map,
)
if result is Undefined:
return results
if is_awaitable(result):
# noinspection PyShadowingNames
async def set_result(
response_name: str,
awaitable_result: Awaitable,
) -> dict[str, Any]:
results[response_name] = await awaitable_result
return results
return set_result(response_name, result)
results[response_name] = result
return results
# noinspection PyTypeChecker
return async_reduce(reducer, grouped_field_set.items(), {})
def execute_fields(
self,
parent_type: GraphQLObjectType,
source_value: Any,
path: Path | None,
grouped_field_set: GroupedFieldSet,
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> AwaitableOrValue[dict[str, Any]]:
"""Execute the given fields concurrently.
Implements the "Executing selection sets" section of the spec
for fields that may be executed in parallel.
"""
results = {}
is_awaitable = self.is_awaitable
awaitable_fields: list[str] = []
append_awaitable = awaitable_fields.append
for response_name, field_group in grouped_field_set.items():
field_path = Path(path, response_name, parent_type.name)
result = self.execute_field(
parent_type,
source_value,
field_group,
field_path,
incremental_data_record,
defer_map,
)
if result is not Undefined:
results[response_name] = result
if is_awaitable(result):
append_awaitable(response_name)
# If there are no coroutines, we can just return the object.
if not awaitable_fields:
return results
# Otherwise, results is a map from field name to the result of resolving that
# field, which is possibly a coroutine object. Return a coroutine object that
# will yield this same map, but with any coroutines awaited in parallel and
# replaced with the values they yielded.
async def get_results() -> dict[str, Any]:
if len(awaitable_fields) == 1:
# If there is only one field, avoid the overhead of parallelization.
field = awaitable_fields[0]
results[field] = await results[field]
else:
results.update(
zip(
awaitable_fields,
await gather(*(results[field] for field in awaitable_fields)),
)
)
return results
return get_results()
def execute_field(
self,
parent_type: GraphQLObjectType,
source: Any,
field_group: FieldGroup,
path: Path,
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> AwaitableOrValue[Any]:
"""Resolve the field on the given source object.
Implements the "Executing fields" section of the spec.
In particular, this method figures out the value that the field returns by
calling its resolve function, then calls complete_value to await coroutine
objects, serialize scalars, or execute the sub-selection-set for objects.
"""
field_name = field_group.fields[0].node.name.value
field_def = self.schema.get_field(parent_type, field_name)
if not field_def:
return Undefined
return_type = field_def.type
resolve_fn = field_def.resolve or self.field_resolver
if self.middleware_manager:
resolve_fn = self.middleware_manager.get_field_resolver(resolve_fn)
info = self.build_resolve_info(field_def, field_group, parent_type, path)
# Get the resolve function, regardless of if its result is normal or abrupt
# (error).
try:
# Build a dictionary of arguments from the field.arguments AST, using the
# variables scope to fulfill any variable references.
args = get_argument_values(
field_def, field_group.fields[0].node, self.variable_values
)
# Note that contrary to the JavaScript implementation, we pass the context
# value as part of the resolve info.
result = resolve_fn(source, info, **args)
if self.is_awaitable(result):
return self.complete_awaitable_value(
return_type,
field_group,
info,
path,
result,
incremental_data_record,
defer_map,
)
completed = self.complete_value(
return_type,
field_group,
info,
path,
result,
incremental_data_record,
defer_map,
)
if self.is_awaitable(completed):
# noinspection PyShadowingNames
async def await_completed() -> Any:
try:
return await completed
except Exception as raw_error:
self.handle_field_error(
raw_error,
return_type,
field_group,
path,
incremental_data_record,
)
self.incremental_publisher.filter(path, incremental_data_record)
return None
return await_completed()
except Exception as raw_error:
self.handle_field_error(
raw_error,
return_type,
field_group,
path,
incremental_data_record,
)
self.incremental_publisher.filter(path, incremental_data_record)
return None
return completed
def build_resolve_info(
self,
field_def: GraphQLField,
field_group: FieldGroup,
parent_type: GraphQLObjectType,
path: Path,
) -> GraphQLResolveInfo:
"""Build the GraphQLResolveInfo object.
For internal use only.
"""
# The resolve function's first argument is a collection of information about
# the current execution state.
return GraphQLResolveInfo(
field_group.fields[0].node.name.value,
field_group.to_nodes(),
field_def.type,
parent_type,
path,
self.schema,
self.fragments,
self.root_value,
self.operation,
self.variable_values,
self.context_value,
self.is_awaitable,
)
def handle_field_error(
self,
raw_error: Exception,
return_type: GraphQLOutputType,
field_group: FieldGroup,
path: Path,
incremental_data_record: IncrementalDataRecord,
) -> None:
"""Handle error properly according to the field type."""
error = located_error(raw_error, field_group.to_nodes(), path.as_list())
# If the field type is non-nullable, then it is resolved without any protection
# from errors, however it still properly locates the error.
if is_non_null_type(return_type):
raise error
# Otherwise, error protection is applied, logging the error and resolving a
# null value for this field if one is encountered.
self.incremental_publisher.add_field_error(incremental_data_record, error)
def complete_value(
self,
return_type: GraphQLOutputType,
field_group: FieldGroup,
info: GraphQLResolveInfo,
path: Path,
result: Any,
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> AwaitableOrValue[Any]:
"""Complete a value.
Implements the instructions for completeValue as defined in the
"Value completion" section of the spec.
If the field type is Non-Null, then this recursively completes the value
for the inner type. It throws a field error if that completion returns null,
as per the "Nullability" section of the spec.
If the field type is a List, then this recursively completes the value
for the inner type on each item in the list.
If the field type is a Scalar or Enum, ensures the completed value is a legal
value of the type by calling the ``serialize`` method of GraphQL type
definition.
If the field is an abstract type, determine the runtime type of the value and
then complete based on that type.
Otherwise, the field type expects a sub-selection set, and will complete the
value by evaluating all sub-selections.
"""
# If result is an Exception, throw a located error.
if isinstance(result, Exception):
raise result
# If field type is NonNull, complete for inner type, and throw field error if
# result is null.
if is_non_null_type(return_type):
completed = self.complete_value(
return_type.of_type,
field_group,
info,
path,
result,
incremental_data_record,
defer_map,
)
if completed is None:
msg = (
"Cannot return null for non-nullable field"
f" {info.parent_type.name}.{info.field_name}."
)
raise TypeError(msg)
return completed
# If result value is null or undefined then return null.
if result is None or result is Undefined:
return None
# If field type is List, complete each item in the list with inner type
if is_list_type(return_type):
return self.complete_list_value(
return_type,
field_group,
info,
path,
result,
incremental_data_record,
defer_map,
)
# If field type is a leaf type, Scalar or Enum, serialize to a valid value,
# returning null if serialization is not possible.
if is_leaf_type(return_type):
return self.complete_leaf_value(return_type, result)
# If field type is an abstract type, Interface or Union, determine the runtime
# Object type and complete for that type.
if is_abstract_type(return_type):
return self.complete_abstract_value(
return_type,
field_group,
info,
path,
result,
incremental_data_record,
defer_map,
)
# If field type is Object, execute and complete all sub-selections.
if is_object_type(return_type):
return self.complete_object_value(
return_type,
field_group,
info,
path,
result,
incremental_data_record,
defer_map,
)
# Not reachable. All possible output types have been considered.
msg = (
"Cannot complete value of unexpected output type:"
f" '{inspect(return_type)}'."
) # pragma: no cover
raise TypeError(msg) # pragma: no cover
async def complete_awaitable_value(
self,
return_type: GraphQLOutputType,
field_group: FieldGroup,
info: GraphQLResolveInfo,
path: Path,
result: Any,
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> Any:
"""Complete an awaitable value."""
try:
resolved = await result
completed = self.complete_value(
return_type,
field_group,
info,
path,
resolved,
incremental_data_record,
defer_map,
)
if self.is_awaitable(completed):
completed = await completed
except Exception as raw_error:
self.handle_field_error(
raw_error, return_type, field_group, path, incremental_data_record
)
self.incremental_publisher.filter(path, incremental_data_record)
completed = None
return completed
def get_stream_usage(
self, field_group: FieldGroup, path: Path
) -> StreamUsage | None:
"""Get stream usage.
Returns an object containing info for streaming if a field should be
streamed based on the experimental flag, stream directive present and
not disabled by the "if" argument.
"""
# do not stream inner lists of multidimensional lists
if isinstance(path.key, int):
return None
stream_usage = self._stream_usages.get(field_group)
if stream_usage is not None:
return stream_usage # pragma: no cover
# validation only allows equivalent streams on multiple fields, so it is
# safe to only check the first field_node for the stream directive
stream = get_directive_values(
GraphQLStreamDirective, field_group.fields[0].node, self.variable_values
)
if not stream or stream.get("if") is False:
return None
initial_count = stream.get("initialCount")
if initial_count is None or initial_count < 0:
msg = "initialCount must be a positive integer"
raise ValueError(msg)
if self.operation.operation == OperationType.SUBSCRIPTION:
msg = (
"`@stream` directive not supported on subscription operations."
" Disable `@stream` by setting the `if` argument to `false`."
)
raise TypeError(msg)
streamed_field_group = FieldGroup(
[
FieldDetails(field_details.node, None)
for field_details in field_group.fields
],
NON_DEFERRED_TARGET_SET,
)
stream_usage = StreamUsage(
stream.get("label"), stream["initialCount"], streamed_field_group
)
self._stream_usages[field_group] = stream_usage
return stream_usage
async def complete_async_iterator_value(
self,
item_type: GraphQLOutputType,
field_group: FieldGroup,
info: GraphQLResolveInfo,
path: Path,
async_iterator: AsyncIterator[Any],
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> list[Any]:
"""Complete an async iterator.
Complete an async iterator value by completing the result and calling
recursively until all the results are completed.
"""
stream_usage = self.get_stream_usage(field_group, path)
complete_list_item_value = self.complete_list_item_value
awaitable_indices: list[int] = []
append_awaitable = awaitable_indices.append
completed_results: list[Any] = []
index = 0
while True:
if stream_usage and index >= stream_usage.initial_count:
try:
early_return = async_iterator.aclose # type: ignore
except AttributeError:
early_return = None
stream_record = StreamRecord(path, stream_usage.label, early_return)
with suppress_timeout_error:
await wait_for(
shield(
self.execute_stream_async_iterator(
index,
async_iterator,
stream_usage.field_group,
info,
item_type,
path,
incremental_data_record,
stream_record,
)
),
timeout=ASYNC_DELAY,
)
break
item_path = path.add_key(index, None)
try:
try:
value = await anext(async_iterator)
except StopAsyncIteration:
break
except Exception as raw_error:
raise located_error(
raw_error, field_group.to_nodes(), path.as_list()
) from raw_error
if complete_list_item_value(
value,
completed_results,
item_type,
field_group,
info,
item_path,
incremental_data_record,
defer_map,
):
append_awaitable(index)
index += 1
if not awaitable_indices:
return completed_results
if len(awaitable_indices) == 1:
# If there is only one index, avoid the overhead of parallelization.
index = awaitable_indices[0]
completed_results[index] = await completed_results[index]
else:
for index, result in zip(
awaitable_indices,
await gather(
*(completed_results[index] for index in awaitable_indices)
),
):
completed_results[index] = result
return completed_results
def complete_list_value(
self,
return_type: GraphQLList[GraphQLOutputType],
field_group: FieldGroup,
info: GraphQLResolveInfo,
path: Path,
result: AsyncIterable[Any] | Iterable[Any],
incremental_data_record: IncrementalDataRecord,
defer_map: RefMap[DeferUsage, DeferredFragmentRecord],
) -> AwaitableOrValue[list[Any]]:
"""Complete a list value.
Complete a list value by completing each item in the list with the inner type.
"""
item_type = return_type.of_type
if isinstance(result, AsyncIterable):
async_iterator = result.__aiter__()
return self.complete_async_iterator_value(
item_type,
field_group,
info,
path,
async_iterator,
incremental_data_record,
defer_map,
)
if not is_iterable(result):
msg = (
"Expected Iterable, but did not find one for field"
f" '{info.parent_type.name}.{info.field_name}'."
)
raise GraphQLError(msg)
stream_usage = self.get_stream_usage(field_group, path)
# This is specified as a simple map, however we're optimizing the path where
# the list contains no coroutine objects by avoiding creating another coroutine
# object.
complete_list_item_value = self.complete_list_item_value
current_parents = incremental_data_record
awaitable_indices: list[int] = []
append_awaitable = awaitable_indices.append
completed_results: list[Any] = []
stream_record: StreamRecord | None = None
for index, item in enumerate(result):
# No need to modify the info object containing the path, since from here on
# it is not ever accessed by resolver functions.
item_path = path.add_key(index, None)
if stream_usage and index >= stream_usage.initial_count:
if stream_record is None:
stream_record = StreamRecord(path, stream_usage.label)
current_parents = self.execute_stream_field(
path,
item_path,
item,
stream_usage.field_group,
info,
item_type,
current_parents,
stream_record,
)
continue
if complete_list_item_value(
item,
completed_results,
item_type,
field_group,
info,
item_path,
incremental_data_record,
defer_map,
):
append_awaitable(index)
if stream_record is not None:
self.incremental_publisher.set_is_final_record(
cast(StreamItemsRecord, current_parents)
)
if not awaitable_indices:
return completed_results
# noinspection PyShadowingNames
async def get_completed_results() -> list[Any]:
if len(awaitable_indices) == 1:
# If there is only one index, avoid the overhead of parallelization.
index = awaitable_indices[0]
completed_results[index] = await completed_results[index]
else:
for index, sub_result in zip(
awaitable_indices,
await gather(
*(completed_results[index] for index in awaitable_indices)
),
):
completed_results[index] = sub_result
return completed_results
return get_completed_results()