From 4571111ebdfc10bb627ac332b4dc3f37cdcfea96 Mon Sep 17 00:00:00 2001 From: Tianzi Cai Date: Wed, 26 Feb 2020 10:13:03 -0800 Subject: [PATCH] Pub/Sub: remove unreferenced samples [(#2986)](https://github.com/GoogleCloudPlatform/python-docs-samples/issues/2986) * remove qs samples * update README --- samples/snippets/README.rst | 16 ---- samples/snippets/quickstart.py | 111 ---------------------------- samples/snippets/quickstart_test.py | 78 ------------------- 3 files changed, 205 deletions(-) delete mode 100644 samples/snippets/quickstart.py delete mode 100644 samples/snippets/quickstart_test.py diff --git a/samples/snippets/README.rst b/samples/snippets/README.rst index 21a4b231f..c30fd190a 100644 --- a/samples/snippets/README.rst +++ b/samples/snippets/README.rst @@ -61,22 +61,6 @@ Install Dependencies Samples ------------------------------------------------------------------------------- -Quickstart -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -.. image:: https://gstatic.com/cloudssh/images/open-btn.png - :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=pubsub/cloud-client/quickstart.py,pubsub/cloud-client/README.rst - - - - -To run this sample: - -.. code-block:: bash - - $ python quickstart.py - - Publisher +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ diff --git a/samples/snippets/quickstart.py b/samples/snippets/quickstart.py deleted file mode 100644 index d01105885..000000000 --- a/samples/snippets/quickstart.py +++ /dev/null @@ -1,111 +0,0 @@ -#!/usr/bin/env python - -# Copyright 2016 Google Inc. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -import argparse - - -def end_to_end(project_id, topic_name, subscription_name, num_messages): - # [START pubsub_end_to_end] - import time - - from google.cloud import pubsub_v1 - - # TODO project_id = "Your Google Cloud Project ID" - # TODO topic_name = "Your Pub/Sub topic name" - # TODO num_messages = number of messages to test end-to-end - - # Instantiates a publisher and subscriber client - publisher = pubsub_v1.PublisherClient() - subscriber = pubsub_v1.SubscriberClient() - - # The `topic_path` method creates a fully qualified identifier - # in the form `projects/{project_id}/topics/{topic_name}` - topic_path = subscriber.topic_path(project_id, topic_name) - - # The `subscription_path` method creates a fully qualified identifier - # in the form `projects/{project_id}/subscriptions/{subscription_name}` - subscription_path = subscriber.subscription_path( - project_id, subscription_name - ) - - # Create the topic. - topic = publisher.create_topic(topic_path) - print("\nTopic created: {}".format(topic.name)) - - # Create a subscription. - subscription = subscriber.create_subscription( - subscription_path, topic_path - ) - print("\nSubscription created: {}\n".format(subscription.name)) - - publish_begin = time.time() - - # Publish messages. - for n in range(num_messages): - data = u"Message number {}".format(n) - # Data must be a bytestring - data = data.encode("utf-8") - # When you publish a message, the client returns a future. - future = publisher.publish(topic_path, data=data) - print("Published {} of message ID {}.".format(data, future.result())) - - publish_time = time.time() - publish_begin - - messages = set() - - def callback(message): - print("Received message: {}".format(message)) - # Unacknowledged messages will be sent again. - message.ack() - messages.add(message) - - subscribe_begin = time.time() - - # Receive messages. The subscriber is nonblocking. - subscriber.subscribe(subscription_path, callback=callback) - - print("\nListening for messages on {}...\n".format(subscription_path)) - - while True: - if len(messages) == num_messages: - subscribe_time = time.time() - subscribe_begin - print("\nReceived all messages.") - print("Publish time lapsed: {:.2f}s.".format(publish_time)) - print("Subscribe time lapsed: {:.2f}s.".format(subscribe_time)) - break - else: - # Sleeps the thread at 50Hz to save on resources. - time.sleep(1.0 / 50) - # [END pubsub_end_to_end] - - -if __name__ == "__main__": - - parser = argparse.ArgumentParser( - description=__doc__, - formatter_class=argparse.RawDescriptionHelpFormatter, - ) - parser.add_argument("project_id", help="Your Google Cloud project ID") - parser.add_argument("topic_name", help="Your topic name") - parser.add_argument("subscription_name", help="Your subscription name") - parser.add_argument("num_msgs", type=int, help="Number of test messages") - - args = parser.parse_args() - - end_to_end( - args.project_id, args.topic_name, args.subscription_name, args.num_msgs - ) diff --git a/samples/snippets/quickstart_test.py b/samples/snippets/quickstart_test.py deleted file mode 100644 index 6a1d4aae1..000000000 --- a/samples/snippets/quickstart_test.py +++ /dev/null @@ -1,78 +0,0 @@ -#!/usr/bin/env python - -# Copyright 2016 Google Inc. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import os -import uuid - -from google.cloud import pubsub_v1 -import pytest -import quickstart - -UUID = uuid.uuid4().hex -PROJECT = os.environ["GCLOUD_PROJECT"] -TOPIC = "end-to-end-test-topic-" + UUID -SUBSCRIPTION = "end-to-end-test-topic-sub-" + UUID -N = 10 - - -@pytest.fixture(scope="module") -def publisher_client(): - yield pubsub_v1.PublisherClient() - - -@pytest.fixture(scope="module") -def topic(publisher_client): - topic_path = publisher_client.topic_path(PROJECT, TOPIC) - - try: - publisher_client.delete_topic(topic_path) - except Exception: - pass - - yield TOPIC - - publisher_client.delete_topic(topic_path) - - -@pytest.fixture(scope="module") -def subscriber_client(): - yield pubsub_v1.SubscriberClient() - - -@pytest.fixture(scope="module") -def subscription(subscriber_client, topic): - subscription_path = subscriber_client.subscription_path( - PROJECT, SUBSCRIPTION - ) - - try: - subscriber_client.delete_subscription(subscription_path) - except Exception: - pass - - yield SUBSCRIPTION - - subscriber_client.delete_subscription(subscription_path) - - -def test_end_to_end(topic, subscription, capsys): - - quickstart.end_to_end(PROJECT, topic, subscription, N) - out, _ = capsys.readouterr() - - assert "Received all messages" in out - assert "Publish time lapsed" in out - assert "Subscribe time lapsed" in out