Content-Length: 693103 | pFad | https://github.com/googleapis/google-cloud-python/commit/e59bf11be4950c32d9552cdb943a01d238cfc02c

4C Use short-form imports in pubsub usage doc. · googleapis/google-cloud-python@e59bf11 · GitHub
Skip to content

Commit e59bf11

Browse files
committed
Use short-form imports in pubsub usage doc.
Fixes #827.
1 parent f238602 commit e59bf11

File tree

1 file changed

+40
-31
lines changed

1 file changed

+40
-31
lines changed

docs/pubsub-usage.rst

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ Create a new topic for the default project:
2020

2121
.. doctest::
2222

23-
>>> from gcloud.pubsub.topic import Topic
23+
>>> from gcloud.pubsub import Topic
2424
>>> topic = Topic('topic_name')
2525
>>> topic.create() # API request
2626

2727
Create a new topic for an explicit project:
2828

2929
.. doctest::
3030

31-
>>> from gcloud.pubsub.topic import Topic
31+
>>> from gcloud.pubsub import Topic
3232
>>> topic = Topic('topic_name', project_id='my.project')
3333
>>> topic.create() # API request
3434

3535
Check for the existance of a topic:
3636

3737
.. doctest::
3838

39-
>>> from gcloud.pubsub.topic import Topic
39+
>>> from gcloud.pubsub import Topic
4040
>>> topic = Topic('topic_name')
4141
>>> topic.exists() # API request
4242
True
@@ -45,24 +45,24 @@ List topics for the default project:
4545

4646
.. doctest::
4747

48-
>>> from gcloud import pubsub
49-
>>> [topic.name for topic in pubsub.list_topics()] # API request
48+
>>> from gcloud.pubsub import list_topics
49+
>>> [topic.name for topic in list_topics()] # API request
5050
['topic_name']
5151

5252
List topics for an explicit project:
5353

5454
.. doctest::
5555

56-
>>> from gcloud import pubsub
57-
>>> topics = pubsub.list_topics(project_id='my.project') # API request
56+
>>> from gcloud.pubsub import list_topics
57+
>>> topics = list_topics(project_id='my.project') # API request
5858
>>> [topic.name for topic in topics]
5959
['topic_name']
6060

6161
Delete a topic:
6262

6363
.. doctest::
6464

65-
>>> from gcloud.pubsub.topic import Topic
65+
>>> from gcloud.pubsub import Topic
6666
>>> topic = Topic('topic_name')
6767
>>> topic.delete() # API request
6868

@@ -74,7 +74,7 @@ Publish a single message to a topic, without attributes:
7474

7575
.. doctest::
7676

77-
>>> from gcloud.pubsub.topic import Topic
77+
>>> from gcloud.pubsub import Topic
7878
>>> topic = Topic('topic_name')
7979
>>> topic.publish('this is the message_payload') # API request
8080
<message_id>
@@ -83,7 +83,7 @@ Publish a single message to a topic, with attributes:
8383

8484
.. doctest::
8585

86-
>>> from gcloud.pubsub.topic import Topic
86+
>>> from gcloud.pubsub import Topic
8787
>>> topic = Topic('topic_name')
8888
>>> topic.publish('this is another message_payload',
8989
... attr1='value1', attr2='value2') # API request
@@ -93,7 +93,7 @@ Publish a set of messages to a topic (as a single request):
9393

9494
.. doctest::
9595

96-
>>> from gcloud.pubsub.topic import Topic
96+
>>> from gcloud.pubsub import Topic
9797
>>> topic = Topic('topic_name')
9898
>>> with topic.batch() as batch:
9999
... batch.publish('this is the first message_payload')
@@ -115,8 +115,8 @@ Create a new pull subscription for a topic:
115115

116116
.. doctest::
117117

118-
>>> from gcloud.pubsub.topic import Topic
119-
>>> from gcloud.pubsub.subscription import Subscription
118+
>>> from gcloud.pubsub import Topic
119+
>>> from gcloud.pubsub import Subscription
120120
>>> topic = Topic('topic_name')
121121
>>> subscription = Subscription('subscription_name', topic)
122122
>>> subscription.create() # API request
@@ -125,8 +125,8 @@ Create a new pull subscription for a topic with a non-default ACK deadline:
125125

126126
.. doctest::
127127

128-
>>> from gcloud.pubsub.topic import Topic
129-
>>> from gcloud.pubsub.subscription import Subscription
128+
>>> from gcloud.pubsub import Topic
129+
>>> from gcloud.pubsub import Subscription
130130
>>> topic = Topic('topic_name')
131131
>>> subscription = Subscription('subscription_name', ack_deadline=90)
132132
>>> subscription.create() # API request
@@ -136,8 +136,8 @@ Create a new push subscription for a topic:
136136
.. doctest::
137137

138138
>>> ENDPOINT = 'https://example.com/hook'
139-
>>> from gcloud.pubsub.topic import Topic
140-
>>> from gcloud.pubsub.subscription import Subscription
139+
>>> from gcloud.pubsub import Topic
140+
>>> from gcloud.pubsub import Subscription
141141
>>> topic = Topic('topic_name')
142142
>>> subscription = Subscription('subscription_name', push_endpoint=ENDPOINT)
143143
>>> subscription.create() # API request
@@ -146,8 +146,8 @@ Check for the existence of a subscription:
146146

147147
.. doctest::
148148

149-
>>> from gcloud.pubsub.topic import Topic
150-
>>> from gcloud.pubsub.subscription import Subscription
149+
>>> from gcloud.pubsub import Topic
150+
>>> from gcloud.pubsub import Subscription
151151
>>> topic = Topic('topic_name')
152152
>>> subscription = Subscription('subscription_name', topic)
153153
>>> subscription.exists() # API request
@@ -158,8 +158,8 @@ Convert a pull subscription to push:
158158
.. doctest::
159159

160160
>>> ENDPOINT = 'https://example.com/hook'
161-
>>> from gcloud.pubsub.topic import Topic
162-
>>> from gcloud.pubsub.subscription import Subscription
161+
>>> from gcloud.pubsub import Topic
162+
>>> from gcloud.pubsub import Subscription
163163
>>> topic = Topic('topic_name')
164164
>>> subscription = Subscription('subscription_name', topic)
165165
>>> subscription.modify_push_configuration(push_endpoint=ENDPOINT) # API request
@@ -169,7 +169,7 @@ Convert a push subscription to pull:
169169
.. doctest::
170170

171171
>>> ENDPOINT = 'https://example.com/hook'
172-
>>> from gcloud.pubsub.topic import Topic
172+
>>> from gcloud.pubsub import Topic
173173
>>> topic = Topic('topic_name')
174174
>>> subscription = Subscription('subscription_name', topic,
175175
... push_endpoint=ENDPOINT)
@@ -179,18 +179,27 @@ List subscriptions for a topic:
179179

180180
.. doctest::
181181

182-
>>> from gcloud.pubsub.topic import Topic
182+
>>> from gcloud.pubsub import Topic
183183
>>> topic = Topic('topic_name')
184184
>>> subscriptions = topic.list_subscriptions() # API request
185185
>>> [subscription.name for subscription in subscriptions]
186186
['subscription_name']
187187

188+
List all subscriptions for the default project:
189+
190+
.. doctest::
191+
192+
>>> from gcloud.pubsub import list_subscriptions
193+
>>> subscriptions = list_subscriptions() # API request
194+
>>> [subscription.name for subscription in subscriptions]
195+
['subscription_name']
196+
188197
Delete a subscription:
189198

190199
.. doctest::
191200

192-
>>> from gcloud.pubsub.topic import Topic
193-
>>> from gcloud.pubsub.subscription import Subscription
201+
>>> from gcloud.pubsub import Topic
202+
>>> from gcloud.pubsub import Subscription
194203
>>> topic = Topic('topic_name')
195204
>>> subscription = Subscription('subscription_name', topic)
196205
>>> subscription.delete() # API request
@@ -203,8 +212,8 @@ Fetch pending messages for a pull subscription:
203212

204213
.. doctest::
205214

206-
>>> from gcloud.pubsub.topic import Topic
207-
>>> from gcloud.pubsub.subscription import Subscription
215+
>>> from gcloud.pubsub import Topic
216+
>>> from gcloud.pubsub import Subscription
208217
>>> topic = Topic('topic_name')
209218
>>> subscription = Subscription('subscription_name', topic)
210219
>>> with topic:
@@ -232,8 +241,8 @@ Fetch a limited number of pending messages for a pull subscription:
232241

233242
.. doctest::
234243

235-
>>> from gcloud.pubsub.topic import Topic
236-
>>> from gcloud.pubsub.subscription import Subscription
244+
>>> from gcloud.pubsub import Topic
245+
>>> from gcloud.pubsub import Subscription
237246
>>> topic = Topic('topic_name')
238247
>>> subscription = Subscription('subscription_name', topic)
239248
>>> with topic:
@@ -248,8 +257,8 @@ Fetch messages for a pull subscription without blocking (none pending):
248257

249258
.. doctest::
250259

251-
>>> from gcloud.pubsub.topic import Topic
252-
>>> from gcloud.pubsub.subscription import Subscription
260+
>>> from gcloud.pubsub import Topic
261+
>>> from gcloud.pubsub import Subscription
253262
>>> topic = Topic('topic_name')
254263
>>> subscription = Subscription('subscription_name', topic)
255264
>>> received = subscription.pull(max_messages=1) # API request

0 commit comments

Comments
 (0)








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/googleapis/google-cloud-python/commit/e59bf11be4950c32d9552cdb943a01d238cfc02c

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy