Skip to content

Make note of num_results property on iterators #2944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daspecster merged 2 commits into from
Jan 18, 2017
Merged

Make note of num_results property on iterators #2944

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79d342a
Make note of num_results property on iterators
Jan 18, 2017
8968bf5
Proper REPL prompt
Jan 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions core/google/cloud/iterator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@
... if not my_item.is_valid:
... break

At any point, you may check the number of items consumed by referencing the
``num_results`` property of the iterator::

>>> my_iterator = Iterator(...)
>>> for my_item in my_iterator:
... if my_iterator.num_results >= 10:
... break

When iterating, not every new item will send a request to the server.
To iterate based on each page of items (where a page corresponds to
a request)::
Expand Down