-
Notifications
You must be signed in to change notification settings - Fork 177
/
client.py
1856 lines (1597 loc) · 65 KB
/
client.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
import asyncio
import logging
import sys
import time
import warnings
from concurrent.futures import Future
from queue import Queue
from threading import Event, Thread
from typing import (
Any,
AsyncGenerator,
Callable,
Dict,
Generator,
List,
Optional,
Tuple,
TypeVar,
Union,
cast,
overload,
)
import backoff
from anyio import fail_after
from graphql import (
DocumentNode,
ExecutionResult,
GraphQLSchema,
IntrospectionQuery,
build_ast_schema,
get_introspection_query,
parse,
validate,
)
from .graphql_request import GraphQLRequest
from .transport.async_transport import AsyncTransport
from .transport.exceptions import TransportClosed, TransportQueryError
from .transport.local_schema import LocalSchemaTransport
from .transport.transport import Transport
from .utilities import build_client_schema
from .utilities import parse_result as parse_result_fn
from .utilities import serialize_variable_values
from .utils import str_first_element
"""
Load the appropriate instance of the Literal type
Note: we cannot use try: except ImportError because of the following mypy issue:
https://github.com/python/mypy/issues/8520
"""
if sys.version_info[:2] >= (3, 8):
from typing import Literal
else:
from typing_extensions import Literal # pragma: no cover
log = logging.getLogger(__name__)
class Client:
"""The Client class is the main entrypoint to execute GraphQL requests
on a GQL transport.
It can take sync or async transports as argument and can either execute
and subscribe to requests itself with the
:func:`execute <gql.client.Client.execute>` and
:func:`subscribe <gql.client.Client.subscribe>` methods
OR can be used to get a sync or async session depending on the
transport type.
To connect to an :ref:`async transport <async_transports>` and get an
:class:`async session <gql.client.AsyncClientSession>`,
use :code:`async with client as session:`
To connect to a :ref:`sync transport <sync_transports>` and get a
:class:`sync session <gql.client.SyncClientSession>`,
use :code:`with client as session:`
"""
def __init__(
self,
schema: Optional[Union[str, GraphQLSchema]] = None,
introspection: Optional[IntrospectionQuery] = None,
transport: Optional[Union[Transport, AsyncTransport]] = None,
fetch_schema_from_transport: bool = False,
introspection_args: Optional[Dict] = None,
execute_timeout: Optional[Union[int, float]] = 10,
serialize_variables: bool = False,
parse_results: bool = False,
batch_interval: float = 0,
batch_max: int = 10,
):
"""Initialize the client with the given parameters.
:param schema: an optional GraphQL Schema for local validation
See :ref:`schema_validation`
:param transport: The provided :ref:`transport <Transports>`.
:param fetch_schema_from_transport: Boolean to indicate that if we want to fetch
the schema from the transport using an introspection query.
:param introspection_args: arguments passed to the get_introspection_query
method of graphql-core.
:param execute_timeout: The maximum time in seconds for the execution of a
request before a TimeoutError is raised. Only used for async transports.
Passing None results in waiting forever for a response.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums. Default: False.
:param parse_results: Whether gql will try to parse the serialized output
sent by the backend. Can be used to deserialize custom scalars or enums.
:param batch_interval: Time to wait in seconds for batching requests together.
Batching is disabled (by default) if 0.
:param batch_max: Maximum number of requests in a single batch.
"""
if introspection:
assert (
not schema
), "Cannot provide introspection and schema at the same time."
schema = build_client_schema(introspection)
if isinstance(schema, str):
type_def_ast = parse(schema)
schema = build_ast_schema(type_def_ast)
if transport and fetch_schema_from_transport:
assert (
not schema
), "Cannot fetch the schema from transport if is already provided."
assert not type(transport).__name__ == "AppSyncWebsocketsTransport", (
"fetch_schema_from_transport=True is not allowed "
"for AppSyncWebsocketsTransport "
"because only subscriptions are allowed on the realtime endpoint."
)
if schema and not transport:
transport = LocalSchemaTransport(schema)
# GraphQL schema
self.schema: Optional[GraphQLSchema] = schema
# Answer of the introspection query
self.introspection: Optional[IntrospectionQuery] = introspection
# GraphQL transport chosen
self.transport: Optional[Union[Transport, AsyncTransport]] = transport
# Flag to indicate that we need to fetch the schema from the transport
# On async transports, we fetch the schema before executing the first query
self.fetch_schema_from_transport: bool = fetch_schema_from_transport
self.introspection_args = (
{} if introspection_args is None else introspection_args
)
# Enforced timeout of the execute function (only for async transports)
self.execute_timeout = execute_timeout
self.serialize_variables = serialize_variables
self.parse_results = parse_results
self.batch_interval = batch_interval
self.batch_max = batch_max
@property
def batching_enabled(self):
return self.batch_interval != 0
def validate(self, document: DocumentNode):
""":meta private:"""
assert (
self.schema
), "Cannot validate the document locally, you need to pass a schema."
validation_errors = validate(self.schema, document)
if validation_errors:
raise validation_errors[0]
def _build_schema_from_introspection(self, execution_result: ExecutionResult):
if execution_result.errors:
raise TransportQueryError(
(
"Error while fetching schema: "
f"{str_first_element(execution_result.errors)}\n"
"If you don't need the schema, you can try with: "
'"fetch_schema_from_transport=False"'
),
errors=execution_result.errors,
data=execution_result.data,
extensions=execution_result.extensions,
)
self.introspection = cast(IntrospectionQuery, execution_result.data)
self.schema = build_client_schema(self.introspection)
@overload
def execute_sync(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*, # https://github.com/python/mypy/issues/7333#issuecomment-788255229
get_execution_result: Literal[False] = ...,
**kwargs,
) -> Dict[str, Any]:
... # pragma: no cover
@overload
def execute_sync(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[True],
**kwargs,
) -> ExecutionResult:
... # pragma: no cover
@overload
def execute_sync(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: bool,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
... # pragma: no cover
def execute_sync(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
""":meta private:"""
with self as session:
return session.execute(
document,
variable_values=variable_values,
operation_name=operation_name,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False],
**kwargs,
) -> List[Dict[str, Any]]:
... # pragma: no cover
@overload
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs,
) -> List[ExecutionResult]:
... # pragma: no cover
@overload
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
... # pragma: no cover
def execute_batch_sync(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
""":meta private:"""
with self as session:
return session.execute_batch(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
async def execute_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*, # https://github.com/python/mypy/issues/7333#issuecomment-788255229
get_execution_result: Literal[False] = ...,
**kwargs,
) -> Dict[str, Any]:
... # pragma: no cover
@overload
async def execute_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[True],
**kwargs,
) -> ExecutionResult:
... # pragma: no cover
@overload
async def execute_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: bool,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
... # pragma: no cover
async def execute_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
""":meta private:"""
async with self as session:
return await session.execute(
document,
variable_values=variable_values,
operation_name=operation_name,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*, # https://github.com/python/mypy/issues/7333#issuecomment-788255229
get_execution_result: Literal[False] = ...,
**kwargs,
) -> Dict[str, Any]:
... # pragma: no cover
@overload
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[True],
**kwargs,
) -> ExecutionResult:
... # pragma: no cover
@overload
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: bool,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
... # pragma: no cover
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
"""Execute the provided document AST against the remote server using
the transport provided during init.
This function **WILL BLOCK** until the result is received from the server.
Either the transport is sync and we execute the query synchronously directly
OR the transport is async and we execute the query in the asyncio loop
(blocking here until answer).
This method will:
- connect using the transport to get a session
- execute the GraphQL request on the transport session
- close the session and close the connection to the server
If you have multiple requests to send, it is better to get your own session
and execute the requests in your session.
The extra arguments passed in the method will be passed to the transport
execute method.
"""
if isinstance(self.transport, AsyncTransport):
# Get the current asyncio event loop
# Or create a new event loop if there isn't one (in a new Thread)
try:
with warnings.catch_warnings():
warnings.filterwarnings(
"ignore", message="There is no current event loop"
)
loop = asyncio.get_event_loop()
except RuntimeError:
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
assert not loop.is_running(), (
"Cannot run client.execute(query) if an asyncio loop is running."
" Use 'await client.execute_async(query)' instead."
)
data = loop.run_until_complete(
self.execute_async(
document,
variable_values=variable_values,
operation_name=operation_name,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
)
return data
else: # Sync transports
return self.execute_sync(
document,
variable_values=variable_values,
operation_name=operation_name,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[False],
**kwargs,
) -> List[Dict[str, Any]]:
... # pragma: no cover
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: Literal[True],
**kwargs,
) -> List[ExecutionResult]:
... # pragma: no cover
@overload
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool,
**kwargs,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
... # pragma: no cover
def execute_batch(
self,
requests: List[GraphQLRequest],
*,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[List[Dict[str, Any]], List[ExecutionResult]]:
"""Execute multiple GraphQL requests in a batch against the remote server using
the transport provided during init.
This function **WILL BLOCK** until the result is received from the server.
Either the transport is sync and we execute the query synchronously directly
OR the transport is async and we execute the query in the asyncio loop
(blocking here until answer).
This method will:
- connect using the transport to get a session
- execute the GraphQL requests on the transport session
- close the session and close the connection to the server
If you want to perform multiple executions, it is better to use
the context manager to keep a session active.
The extra arguments passed in the method will be passed to the transport
execute method.
"""
if isinstance(self.transport, AsyncTransport):
raise NotImplementedError("Batching is not implemented for async yet.")
else: # Sync transports
return self.execute_batch_sync(
requests,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
@overload
def subscribe_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[False] = ...,
**kwargs,
) -> AsyncGenerator[Dict[str, Any], None]:
... # pragma: no cover
@overload
def subscribe_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[True],
**kwargs,
) -> AsyncGenerator[ExecutionResult, None]:
... # pragma: no cover
@overload
def subscribe_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: bool,
**kwargs,
) -> Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
]:
... # pragma: no cover
async def subscribe_async(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
]:
""":meta private:"""
async with self as session:
generator = session.subscribe(
document,
variable_values=variable_values,
operation_name=operation_name,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
async for result in generator:
yield result
@overload
def subscribe(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[False] = ...,
**kwargs,
) -> Generator[Dict[str, Any], None, None]:
... # pragma: no cover
@overload
def subscribe(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[True],
**kwargs,
) -> Generator[ExecutionResult, None, None]:
... # pragma: no cover
@overload
def subscribe(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: bool,
**kwargs,
) -> Union[
Generator[Dict[str, Any], None, None], Generator[ExecutionResult, None, None]
]:
... # pragma: no cover
def subscribe(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
*,
get_execution_result: bool = False,
**kwargs,
) -> Union[
Generator[Dict[str, Any], None, None], Generator[ExecutionResult, None, None]
]:
"""Execute a GraphQL subscription with a python generator.
We need an async transport for this functionality.
"""
# Get the current asyncio event loop
# Or create a new event loop if there isn't one (in a new Thread)
try:
with warnings.catch_warnings():
warnings.filterwarnings(
"ignore", message="There is no current event loop"
)
loop = asyncio.get_event_loop()
except RuntimeError:
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
async_generator: Union[
AsyncGenerator[Dict[str, Any], None], AsyncGenerator[ExecutionResult, None]
] = self.subscribe_async(
document,
variable_values=variable_values,
operation_name=operation_name,
serialize_variables=serialize_variables,
parse_result=parse_result,
get_execution_result=get_execution_result,
**kwargs,
)
assert not loop.is_running(), (
"Cannot run client.subscribe(query) if an asyncio loop is running."
" Use 'await client.subscribe_async(query)' instead."
)
try:
while True:
# Note: we need to create a task here in order to be able to close
# the async generator properly on python 3.8
# See https://bugs.python.org/issue38559
generator_task = asyncio.ensure_future(
async_generator.__anext__(), loop=loop
)
result: Union[
Dict[str, Any], ExecutionResult
] = loop.run_until_complete(
generator_task
) # type: ignore
yield result
except StopAsyncIteration:
pass
except (KeyboardInterrupt, Exception, GeneratorExit):
# Graceful shutdown
asyncio.ensure_future(async_generator.aclose(), loop=loop)
generator_task.cancel()
loop.run_until_complete(loop.shutdown_asyncgens())
# Then reraise the exception
raise
async def connect_async(self, reconnecting=False, **kwargs):
r"""Connect asynchronously with the underlying async transport to
produce a session.
That session will be a permanent auto-reconnecting session
if :code:`reconnecting=True`.
If you call this method, you should call the
:meth:`close_async <gql.client.Client.close_async>` method
for cleanup.
:param reconnecting: if True, create a permanent reconnecting session
:param \**kwargs: additional arguments for the
:meth:`ReconnectingAsyncClientSession init method
<gql.client.ReconnectingAsyncClientSession.__init__>`.
"""
assert isinstance(
self.transport, AsyncTransport
), "Only a transport of type AsyncTransport can be used asynchronously"
if reconnecting:
self.session = ReconnectingAsyncClientSession(client=self, **kwargs)
await self.session.start_connecting_task()
else:
await self.transport.connect()
self.session = AsyncClientSession(client=self)
# Get schema from transport if needed
try:
if self.fetch_schema_from_transport and not self.schema:
await self.session.fetch_schema()
except Exception:
# we don't know what type of exception is thrown here because it
# depends on the underlying transport; we just make sure that the
# transport is closed and re-raise the exception
await self.transport.close()
raise
return self.session
async def close_async(self):
"""Close the async transport and stop the optional reconnecting task."""
if isinstance(self.session, ReconnectingAsyncClientSession):
await self.session.stop_connecting_task()
await self.transport.close()
async def __aenter__(self):
return await self.connect_async()
async def __aexit__(self, exc_type, exc, tb):
await self.close_async()
def connect_sync(self):
r"""Connect synchronously with the underlying sync transport to
produce a session.
If you call this method, you should call the
:meth:`close_sync <gql.client.Client.close_sync>` method
for cleanup.
"""
assert not isinstance(self.transport, AsyncTransport), (
"Only a sync transport can be used."
" Use 'async with Client(...) as session:' instead"
)
if not hasattr(self, "session"):
self.session = SyncClientSession(client=self)
self.session.connect()
# Get schema from transport if needed
try:
if self.fetch_schema_from_transport and not self.schema:
self.session.fetch_schema()
except Exception:
# we don't know what type of exception is thrown here because it
# depends on the underlying transport; we just make sure that the
# transport is closed and re-raise the exception
self.session.close()
raise
return self.session
def close_sync(self):
"""Close the sync session and the sync transport.
If batching is enabled, this will block until the remaining queries in the
batching queue have been processed.
"""
self.session.close()
def __enter__(self):
return self.connect_sync()
def __exit__(self, *args):
self.close_sync()
class SyncClientSession:
"""An instance of this class is created when using :code:`with` on the client.
It contains the sync method execute to send queries
on a sync transport using the same session.
"""
def __init__(self, client: Client):
""":param client: the :class:`client <gql.client.Client>` used"""
self.client = client
def _execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
**kwargs,
) -> ExecutionResult:
"""Execute the provided document AST synchronously using
the sync transport, returning an ExecutionResult object.
:param document: GraphQL query as AST Node object.
:param variable_values: Dictionary of input parameters.
:param operation_name: Name of the operation that shall be executed.
:param serialize_variables: whether the variable values should be
serialized. Used for custom scalars and/or enums.
By default use the serialize_variables argument of the client.
:param parse_result: Whether gql will deserialize the result.
By default use the parse_results argument of the client.
The extra arguments are passed to the transport execute method."""
# Validate document
if self.client.schema:
self.client.validate(document)
# Parse variable values for custom scalars if requested
if variable_values is not None:
if serialize_variables or (
serialize_variables is None and self.client.serialize_variables
):
variable_values = serialize_variable_values(
self.client.schema,
document,
variable_values,
operation_name=operation_name,
)
if self.client.batching_enabled:
request = GraphQLRequest(
document,
variable_values=variable_values,
operation_name=operation_name,
)
future_result = self._execute_future(request)
result = future_result.result()
else:
result = self.transport.execute(
document,
variable_values=variable_values,
operation_name=operation_name,
**kwargs,
)
# Unserialize the result if requested
if self.client.schema:
if parse_result or (parse_result is None and self.client.parse_results):
result.data = parse_result_fn(
self.client.schema,
document,
result.data,
operation_name=operation_name,
)
return result
@overload
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[False] = ...,
**kwargs,
) -> Dict[str, Any]:
... # pragma: no cover
@overload
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: Literal[True],
**kwargs,
) -> ExecutionResult:
... # pragma: no cover
@overload
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = ...,
operation_name: Optional[str] = ...,
serialize_variables: Optional[bool] = ...,
parse_result: Optional[bool] = ...,
*,
get_execution_result: bool,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
... # pragma: no cover
def execute(
self,
document: DocumentNode,
variable_values: Optional[Dict[str, Any]] = None,
operation_name: Optional[str] = None,
serialize_variables: Optional[bool] = None,
parse_result: Optional[bool] = None,
get_execution_result: bool = False,
**kwargs,
) -> Union[Dict[str, Any], ExecutionResult]:
"""Execute the provided document AST synchronously using
the sync transport.
Raises a TransportQueryError if an error has been returned in