Skip to content

Commit 17a8fc3

Browse files
dhermesdhermes
committed
Renaming Iterator to HTTPIterator.
1 parent 0e4a660 commit 17a8fc3

File tree

16 files changed

+80
-61
lines changed

16 files changed

+80
-61
lines changed

‎bigquery/google/cloud/bigquery/client.py‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
from google.cloud.bigquery.job import LoadTableFromStorageJob
2424
from google.cloud.bigquery.job import QueryJob
2525
from google.cloud.bigquery.query import QueryResults
26-
from google.cloud.iterator import Iterator
26+
from google.cloud.iterator import HTTPIterator
2727

2828

2929
class Project(object):
@@ -92,9 +92,10 @@ def list_projects(self, max_results=None, page_token=None):
9292
:returns: Iterator of :class:`~google.cloud.bigquery.client.Project`
9393
accessible to the current client.
9494
"""
95-
return Iterator(client=self, path='/projects',
96-
items_key='projects', item_to_value=_item_to_project,
97-
page_token=page_token, max_results=max_results)
95+
return HTTPIterator(
96+
client=self, path='/projects', item_to_value=_item_to_project,
97+
items_key='projects', page_token=page_token,
98+
max_results=max_results)
9899

99100
def list_datasets(self, include_all=False, max_results=None,
100101
page_token=None):
@@ -123,9 +124,9 @@ def list_datasets(self, include_all=False, max_results=None,
123124
if include_all:
124125
extra_params['all'] = True
125126
path = '/projects/%s/datasets' % (self.project,)
126-
return Iterator(
127-
client=self, path=path, items_key='datasets',
128-
item_to_value=_item_to_dataset, page_token=page_token,
127+
return HTTPIterator(
128+
client=self, path=path, item_to_value=_item_to_dataset,
129+
items_key='datasets', page_token=page_token,
129130
max_results=max_results, extra_params=extra_params)
130131

131132
def dataset(self, dataset_name):
@@ -204,9 +205,9 @@ def list_jobs(self, max_results=None, page_token=None, all_users=None,
204205
extra_params['stateFilter'] = state_filter
205206

206207
path = '/projects/%s/jobs' % (self.project,)
207-
return Iterator(
208-
client=self, path=path, items_key='jobs',
209-
item_to_value=_item_to_job, page_token=page_token,
208+
return HTTPIterator(
209+
client=self, path=path, item_to_value=_item_to_job,
210+
items_key='jobs', page_token=page_token,
210211
max_results=max_results, extra_params=extra_params)
211212

212213
def load_table_from_storage(self, job_name, destination, *source_uris):

‎core/google/cloud/iterator.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ def next(self):
166166
__next__ = next
167167

168168

169-
class Iterator(object):
169+
class HTTPIterator(object):
170170
"""A generic class for iterating through Cloud JSON APIs list responses.
171171
172172
:type client: :class:`~google.cloud.client.Client`

‎core/unit_tests/test_iterator.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ def item_to_value(self, item):
9191
self.assertEqual(page.remaining, 97)
9292

9393

94-
class TestIterator(unittest.TestCase):
94+
class TestHTTPIterator(unittest.TestCase):
9595

9696
def _getTargetClass(self):
97-
from google.cloud.iterator import Iterator
98-
return Iterator
97+
from google.cloud.iterator import HTTPIterator
98+
return HTTPIterator
9999

100100
def _makeOne(self, *args, **kw):
101101
return self._getTargetClass()(*args, **kw)

‎dns/google/cloud/dns/client.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
from google.cloud.client import JSONClient
1919
from google.cloud.dns.connection import Connection
2020
from google.cloud.dns.zone import ManagedZone
21-
from google.cloud.iterator import Iterator
21+
from google.cloud.iterator import HTTPIterator
2222

2323

2424
class Client(JSONClient):
@@ -81,9 +81,10 @@ def list_zones(self, max_results=None, page_token=None):
8181
belonging to this project.
8282
"""
8383
path = '/projects/%s/managedZones' % (self.project,)
84-
return Iterator(client=self, path=path, items_key='managedZones',
85-
item_to_value=_item_to_zone, page_token=page_token,
86-
max_results=max_results)
84+
return HTTPIterator(
85+
client=self, path=path, item_to_value=_item_to_zone,
86+
items_key='managedZones', page_token=page_token,
87+
max_results=max_results)
8788

8889
def zone(self, name, dns_name=None, description=None):
8990
"""Construct a zone bound to this client.

‎dns/google/cloud/dns/zone.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from google.cloud.exceptions import NotFound
2121
from google.cloud.dns.changes import Changes
2222
from google.cloud.dns.resource_record_set import ResourceRecordSet
23-
from google.cloud.iterator import Iterator
23+
from google.cloud.iterator import HTTPIterator
2424

2525

2626
class ManagedZone(object):
@@ -347,9 +347,9 @@ def list_resource_record_sets(self, max_results=None, page_token=None,
347347
client = self._require_client(client)
348348
path = '/projects/%s/managedZones/%s/rrsets' % (
349349
self.project, self.name)
350-
iterator = Iterator(
351-
client=client, path=path, items_key='rrsets',
352-
item_to_value=_item_to_resource_record_set,
350+
iterator = HTTPIterator(
351+
client=client, path=path,
352+
item_to_value=_item_to_resource_record_set, items_key='rrsets',
353353
page_token=page_token, max_results=max_results)
354354
iterator.zone = self
355355
return iterator
@@ -381,10 +381,10 @@ def list_changes(self, max_results=None, page_token=None, client=None):
381381
client = self._require_client(client)
382382
path = '/projects/%s/managedZones/%s/changes' % (
383383
self.project, self.name)
384-
iterator = Iterator(
385-
client=client, path=path, items_key='changes',
386-
item_to_value=_item_to_changes,
387-
page_token=page_token, max_results=max_results)
384+
iterator = HTTPIterator(
385+
client=client, path=path, item_to_value=_item_to_changes,
386+
items_key='changes', page_token=page_token,
387+
max_results=max_results)
388388
iterator.zone = self
389389
return iterator
390390

‎pubsub/google/cloud/pubsub/_gax.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
from google.cloud._helpers import _pb_timestamp_to_rfc3339
3232
from google.cloud.exceptions import Conflict
3333
from google.cloud.exceptions import NotFound
34-
from google.cloud.iterator import Iterator
34+
from google.cloud.iterator import HTTPIterator
3535
from google.cloud.iterator import Page
3636
from google.cloud.pubsub.topic import Topic
3737

@@ -83,9 +83,9 @@ def list_topics(self, project, page_size=0, page_token=None):
8383
path, page_size=page_size, options=options)
8484
page_iter = functools.partial(_recast_page_iterator, page_iter)
8585

86-
return Iterator(client=self._client, path=path,
87-
item_to_value=_item_to_topic,
88-
page_iter=page_iter)
86+
return HTTPIterator(
87+
client=self._client, path=path, item_to_value=_item_to_topic,
88+
page_iter=page_iter)
8989

9090
def topic_create(self, topic_path):
9191
"""API call: create a topic

‎pubsub/google/cloud/pubsub/connection.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
from google.cloud import connection as base_connection
2121
from google.cloud.environment_vars import PUBSUB_EMULATOR
22-
from google.cloud.iterator import Iterator
22+
from google.cloud.iterator import HTTPIterator
2323
from google.cloud.pubsub.topic import Topic
2424

2525

@@ -134,9 +134,10 @@ def list_topics(self, project, page_size=None, page_token=None):
134134
extra_params['pageSize'] = page_size
135135
path = '/projects/%s/topics' % (project,)
136136

137-
return Iterator(client=self._client, path=path,
138-
items_key='topics', item_to_value=_item_to_topic,
139-
page_token=page_token, extra_params=extra_params)
137+
return HTTPIterator(
138+
client=self._client, path=path, item_to_value=_item_to_topic,
139+
items_key='topics', page_token=page_token,
140+
extra_params=extra_params)
140141

141142
def topic_create(self, topic_path):
142143
"""API call: create a topic

‎pubsub/unit_tests/test_client.py‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,11 @@ def __init__(self, _wrapped, client):
7979
self._client = client
8080

8181
creds = _Credentials()
82-
client = self._makeOne(project=self.PROJECT, credentials=creds)
8382

84-
with _Monkey(MUT,
85-
_USE_GAX=True,
83+
with _Monkey(MUT, _USE_GAX=True,
8684
make_gax_publisher_api=_generated_api,
8785
GAXPublisherAPI=_GaxPublisherAPI):
86+
client = self._makeOne(project=self.PROJECT, credentials=creds)
8887
api = client.publisher_api
8988

9089
self.assertIsInstance(api, _GaxPublisherAPI)
@@ -131,12 +130,11 @@ def __init__(self, _wrapped):
131130
self._wrapped = _wrapped
132131

133132
creds = _Credentials()
134-
client = self._makeOne(project=self.PROJECT, credentials=creds)
135133

136-
with _Monkey(MUT,
137-
_USE_GAX=True,
134+
with _Monkey(MUT, _USE_GAX=True,
138135
make_gax_subscriber_api=_generated_api,
139136
GAXSubscriberAPI=_GaxSubscriberAPI):
137+
client = self._makeOne(project=self.PROJECT, credentials=creds)
140138
api = client.subscriber_api
141139

142140
self.assertIsInstance(api, _GaxSubscriberAPI)

‎resource_manager/google/cloud/resource_manager/client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717

1818
from google.cloud.client import Client as BaseClient
19-
from google.cloud.iterator import Iterator
19+
from google.cloud.iterator import HTTPIterator
2020
from google.cloud.resource_manager.connection import Connection
2121
from google.cloud.resource_manager.project import Project
2222

@@ -154,7 +154,7 @@ def list_projects(self, filter_params=None, page_size=None):
154154
if filter_params is not None:
155155
extra_params['filter'] = filter_params
156156

157-
return Iterator(
157+
return HTTPIterator(
158158
client=self, path='/projects', item_to_value=_item_to_project,
159159
items_key='projects', extra_params=extra_params)
160160

‎resource_manager/unit_tests/test_client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ def test_fetch_project(self):
7878
self.assertEqual(project.labels, labels)
7979

8080
def test_list_projects_return_type(self):
81-
from google.cloud.iterator import Iterator
81+
from google.cloud.iterator import HTTPIterator
8282

8383
credentials = _Credentials()
8484
client = self._makeOne(credentials=credentials)
8585
# Patch the connection with one we can easily control.
8686
client.connection = _Connection({})
8787

8888
results = client.list_projects()
89-
self.assertIsInstance(results, Iterator)
89+
self.assertIsInstance(results, HTTPIterator)
9090

9191
def test_list_projects_no_paging(self):
9292
credentials = _Credentials()

0 commit comments

Comments
 (0)