Refactor iterator to separate into HTTP/GAX iterators - #2617
Merged
dhermes merged 14 commits intoOct 27, 2016
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
For this commit, moving some features of HTTPIterator constructor onto base class.
This was HTTP/JSON specific and belongs in the HTTP subclass.
Also updating the _GAXPageIterator mock to allow multiple pages.
Instead, using the page token directly from the page iterator passed in (this may occasionally be strange to a user, e.g. if the token is INITIAL_PAGE).
This somewhat of a cart-before-the-horse change, but is done this way to make the commit easier to understand, before unifying the two approaches via _next_page().
Also moving the token setting behavior from HTTPIterator._get_next_page_response() into _next_page().
Also a lint fix for an unimorted member and a unit test fix adding a page token to allow more paging.
Copy link
Copy Markdown
Contributor
|
This conceptually LGTM, I'll defer @tseaver for implementation review. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
@tseaver Can I get an amen?
|
Sorry, something went wrong.
tseaver
approved these changes
Oct 26, 2016
tseaver
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Ouch! Commit-by-comit was a hard row to hoe, especially on the last commit, which blew away so much of what had been done before
Sorry, something went wrong.
Comment thread
core/google/cloud/iterator.py
|
|
||
| class Iterator(object): | ||
| class HTTPIterator(object): | ||
| """A generic class for iterating through Cloud JSON APIs list responses. |
This comment was marked as spam.
Comment thread
core/unit_tests/test_iterator.py
Outdated
| self.assertIs(iterator.client, client) | ||
| self.assertEqual(iterator.max_results, max_results) | ||
| self.assertEqual(list(iterator._page_iter), []) | ||
| self.assertFalse(iterator._page_increment) |
This comment was marked as spam.
Comment thread
pubsub/google/cloud/pubsub/_gax.py
| page = Page(iterator, items, _item_to_topic) | ||
| iterator.next_page_token = page_iter.page_token or None | ||
| iterator.num_results += page.num_items | ||
| yield page |
This comment was marked as spam.
Comment thread
core/google/cloud/iterator.py
Outdated
| except StopIteration: | ||
| return None | ||
|
|
||
| def _wrap_gax(self, page_iter): |
This comment was marked as spam.
Comment thread
core/unit_tests/test_iterator.py
| response = iterator._get_next_page_response() | ||
| self.assertEqual(response['items'], [{'name': key1}, {'name': key2}]) | ||
| self.assertEqual(iterator.page_number, 1) | ||
| self.assertEqual(iterator.next_page_token, token) |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Copy link
Copy Markdown
Contributor
Author
|
@tseaver Sorry for the bait and switch at the end. It didn't become clear that a _next_page could do all the work until all pieces were moved. I considered rewriting the history but hoped it'd be clear enough, my bad. |
Sorry, something went wrong.
richkadel
pushed a commit
to richkadel/google-cloud-python
that referenced
this pull request
May 6, 2017
…ctor Refactor iterator to separate into HTTP/GAX iterators
parthea
pushed a commit
that referenced
this pull request
Nov 24, 2025
Refactor iterator to separate into HTTP/GAX iterators
parthea
pushed a commit
that referenced
this pull request
Mar 9, 2026
Refactor iterator to separate into HTTP/GAX iterators
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
NOTE: I'm happy to split this PR into tiny PRs if it makes review easy, though the commits are all pretty compact, so it should be reviewable commit-by-commit.