Skip to content

Commit e06ec83

Browse files
authored
Merge pull request #2944 from bendemaree/document-num-results
Make note of num_results property on iterators
2 parents e9b503a + 8968bf5 commit e06ec83

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

core/google/cloud/iterator.py

+8
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@
4242
... if not my_item.is_valid:
4343
... break
4444
45+
At any point, you may check the number of items consumed by referencing the
46+
``num_results`` property of the iterator::
47+
48+
>>> my_iterator = Iterator(...)
49+
>>> for my_item in my_iterator:
50+
... if my_iterator.num_results >= 10:
51+
... break
52+
4553
When iterating, not every new item will send a request to the server.
4654
To iterate based on each page of items (where a page corresponds to
4755
a request)::

0 commit comments

Comments
 (0)