Skip to content

Commit bb50a3f

Browse files
committed
Add missing docstrings
1 parent fd9edfb commit bb50a3f

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

src/graphql/execution/execute.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1758,7 +1758,7 @@ async def await_completed_item(
17581758
index += 1
17591759

17601760
def add_task(self, awaitable: Awaitable[Any]) -> None:
1761-
"""Add task."""
1761+
"""Add the given task to the tasks set for later execution."""
17621762
tasks = self._tasks
17631763
task = ensure_future(awaitable)
17641764
tasks.add(task)

src/graphql/execution/incremental_publisher.py

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,6 @@
2020
from typing import TypedDict
2121
except ImportError: # Python < 3.8
2222
from typing_extensions import TypedDict
23-
try:
24-
from typing import TypeGuard
25-
except ImportError: # Python < 3.10
26-
pass
2723

2824

2925
if TYPE_CHECKING:
@@ -377,11 +373,13 @@ def __init__(self) -> None:
377373
self._tasks: set[Awaitable] = set()
378374

379375
def has_next(self) -> bool:
376+
"""Check whether there is a next incremental result."""
380377
return bool(self._pending)
381378

382379
async def subscribe(
383380
self,
384381
) -> AsyncGenerator[SubsequentIncrementalExecutionResult, None]:
382+
"""Subscribe to the incremental results."""
385383
is_done = False
386384
pending = self._pending
387385

@@ -422,6 +420,7 @@ def prepare_new_deferred_fragment_record(
422420
path: Path | None,
423421
parent_context: IncrementalDataRecord | None,
424422
) -> DeferredFragmentRecord:
423+
"""Prepare a new deferred fragment record."""
425424
deferred_fragment_record = DeferredFragmentRecord(label, path, parent_context)
426425

427426
context = parent_context or self._initial_result
@@ -435,6 +434,7 @@ def prepare_new_stream_items_record(
435434
parent_context: IncrementalDataRecord | None,
436435
async_iterator: AsyncIterator[Any] | None = None,
437436
) -> StreamItemsRecord:
437+
"""Prepare a new stream items record."""
438438
stream_items_record = StreamItemsRecord(
439439
label, path, parent_context, async_iterator
440440
)
@@ -448,6 +448,7 @@ def complete_deferred_fragment_record(
448448
deferred_fragment_record: DeferredFragmentRecord,
449449
data: dict[str, Any] | None,
450450
) -> None:
451+
"""Complete the given deferred fragment record."""
451452
deferred_fragment_record.data = data
452453
deferred_fragment_record.is_completed = True
453454
self._release(deferred_fragment_record)
@@ -457,21 +458,25 @@ def complete_stream_items_record(
457458
stream_items_record: StreamItemsRecord,
458459
items: list[str] | None,
459460
) -> None:
461+
"""Complete the given stream items record."""
460462
stream_items_record.items = items
461463
stream_items_record.is_completed = True
462464
self._release(stream_items_record)
463465

464466
def set_is_completed_async_iterator(
465467
self, stream_items_record: StreamItemsRecord
466468
) -> None:
469+
"""Mark async iterator for stream items as completed."""
467470
stream_items_record.is_completed_async_iterator = True
468471

469472
def add_field_error(
470473
self, incremental_data_record: IncrementalDataRecord, error: GraphQLError
471474
) -> None:
475+
"""Add a field error to the given incremental data record."""
472476
incremental_data_record.errors.append(error)
473477

474478
def publish_initial(self) -> None:
479+
"""Publish the initial result."""
475480
for child in self._initial_result.children:
476481
self._publish(child)
477482

@@ -480,6 +485,7 @@ def filter(
480485
null_path: Path,
481486
erroring_incremental_data_record: IncrementalDataRecord | None,
482487
) -> None:
488+
"""Filter out the given erroring incremental data record."""
483489
null_path_list = null_path.as_list()
484490

485491
children = (erroring_incremental_data_record or self._initial_result).children
@@ -504,23 +510,28 @@ def filter(
504510
self._add_task(close_async_iterator)
505511

506512
def _trigger(self) -> None:
513+
"""Trigger the resolve event."""
507514
self._resolve.set()
508515
self._resolve = Event()
509516

510517
def _introduce(self, item: IncrementalDataRecord) -> None:
518+
"""Introduce a new IncrementalDataRecord."""
511519
self._pending[item] = None
512520

513521
def _release(self, item: IncrementalDataRecord) -> None:
522+
"""Release the given IncrementalDataRecord."""
514523
if item in self._pending:
515524
self._released[item] = None
516525
self._trigger()
517526

518527
def _push(self, item: IncrementalDataRecord) -> None:
528+
"""Push the given IncrementalDataRecord."""
519529
self._released[item] = None
520530
self._pending[item] = None
521531
self._trigger()
522532

523533
def _delete(self, item: IncrementalDataRecord) -> None:
534+
"""Delete the given IncrementalDataRecord."""
524535
with suppress_key_error:
525536
del self._released[item]
526537
with suppress_key_error:
@@ -530,6 +541,7 @@ def _delete(self, item: IncrementalDataRecord) -> None:
530541
def _get_incremental_result(
531542
self, completed_records: Collection[IncrementalDataRecord]
532543
) -> SubsequentIncrementalExecutionResult | None:
544+
"""Get the incremental result with the completed records."""
533545
incremental_results: list[IncrementalResult] = []
534546
encountered_completed_async_iterator = False
535547
append_result = incremental_results.append
@@ -572,6 +584,7 @@ def _get_incremental_result(
572584
return None
573585

574586
def _publish(self, incremental_data_record: IncrementalDataRecord) -> None:
587+
"""Publish the given incremental data record."""
575588
if incremental_data_record.is_completed:
576589
self._push(incremental_data_record)
577590
else:
@@ -582,6 +595,7 @@ def _get_descendants(
582595
children: dict[IncrementalDataRecord, None],
583596
descendants: dict[IncrementalDataRecord, None] | None = None,
584597
) -> dict[IncrementalDataRecord, None]:
598+
"""Get the descendants of the given children."""
585599
if descendants is None:
586600
descendants = {}
587601
for child in children:
@@ -592,9 +606,11 @@ def _get_descendants(
592606
def _matches_path(
593607
self, test_path: list[str | int], base_path: list[str | int]
594608
) -> bool:
609+
"""Get whether the given test path matches the base path."""
595610
return all(item == test_path[i] for i, item in enumerate(base_path))
596611

597612
def _add_task(self, awaitable: Awaitable[Any]) -> None:
613+
"""Add the given task to the tasks set for later execution."""
598614
tasks = self._tasks
599615
task = ensure_future(awaitable)
600616
tasks.add(task)

0 commit comments

Comments
 (0)