From 57dfa8da30ffe163931d33f0f652de0fe5117f8c Mon Sep 17 00:00:00 2001 From: Adam Luong Date: Wed, 13 Nov 2024 20:34:14 -0500 Subject: [PATCH 1/2] fix: log error message when exception is caught --- managedkafka/snippets/clusters/create_cluster.py | 3 ++- managedkafka/snippets/clusters/delete_cluster.py | 2 +- managedkafka/snippets/clusters/get_cluster.py | 14 ++++++++++---- managedkafka/snippets/clusters/update_cluster.py | 2 +- .../consumergroups/delete_consumer_group.py | 6 +++--- .../snippets/consumergroups/get_consumer_group.py | 14 ++++++++++---- .../consumergroups/update_consumer_group.py | 6 +++--- managedkafka/snippets/topics/create_topic.py | 6 +++--- managedkafka/snippets/topics/delete_topic.py | 6 +++--- managedkafka/snippets/topics/get_topic.py | 14 ++++++++++---- managedkafka/snippets/topics/update_topic.py | 6 +++--- 11 files changed, 49 insertions(+), 30 deletions(-) diff --git a/managedkafka/snippets/clusters/create_cluster.py b/managedkafka/snippets/clusters/create_cluster.py index a40a5543fc5..da3abc8dcbe 100644 --- a/managedkafka/snippets/clusters/create_cluster.py +++ b/managedkafka/snippets/clusters/create_cluster.py @@ -33,7 +33,7 @@ def create_cluster( memory_bytes: The memory to provision for the cluster in bytes. Raises: - This method will raise the exception if the operation errors or + This method will raise the GoogleAPICallError exception if the operation errors or the timeout before the operation completes is reached. """ # [START managedkafka_create_cluster] @@ -71,6 +71,7 @@ def create_cluster( # The duration of this operation can vary considerably, typically taking 10-40 minutes. # We can set a timeout of 3000s (50 minutes). operation = client.create_cluster(request=request, timeout=3000) + print("Waiting for operation to finish...") response = operation.result() print("Created cluster:", response) except GoogleAPICallError: diff --git a/managedkafka/snippets/clusters/delete_cluster.py b/managedkafka/snippets/clusters/delete_cluster.py index 8ea15afa2f5..52de575730d 100644 --- a/managedkafka/snippets/clusters/delete_cluster.py +++ b/managedkafka/snippets/clusters/delete_cluster.py @@ -27,7 +27,7 @@ def delete_cluster( cluster_id: ID of the Kafka cluster. Raises: - This method will raise the exception if the operation errors or + This method will raise the GoogleAPICallError exception if the operation errors or the timeout before the operation completes is reached. """ # [START managedkafka_delete_cluster] diff --git a/managedkafka/snippets/clusters/get_cluster.py b/managedkafka/snippets/clusters/get_cluster.py index 42cfc43a8a5..edafc3e7dca 100644 --- a/managedkafka/snippets/clusters/get_cluster.py +++ b/managedkafka/snippets/clusters/get_cluster.py @@ -25,8 +25,12 @@ def get_cluster( project_id: Google Cloud project ID. region: Cloud region. cluster_id: ID of the Kafka cluster. + + Raises: + This method will raise the NotFound exception if the cluster is not found. """ # [START managedkafka_get_cluster] + from google.api_core.exceptions import NotFound from google.cloud import managedkafka_v1 # TODO(developer) @@ -41,9 +45,11 @@ def get_cluster( name=cluster_path, ) - cluster = client.get_cluster(request=request) - print("Got cluster:", cluster) - - return cluster + try: + cluster = client.get_cluster(request=request) + print("Got cluster:", cluster) + return cluster + except NotFound as e: + print(f"Failed to get cluster {cluster_id} with error: {e.message}") # [END managedkafka_get_cluster] diff --git a/managedkafka/snippets/clusters/update_cluster.py b/managedkafka/snippets/clusters/update_cluster.py index b9439756839..8bc946dd106 100644 --- a/managedkafka/snippets/clusters/update_cluster.py +++ b/managedkafka/snippets/clusters/update_cluster.py @@ -26,7 +26,7 @@ def update_cluster( memory_bytes: The memory to provision for the cluster in bytes. Raises: - This method will raise the exception if the operation errors or + This method will raise the GoogleAPICallError exception if the operation errors or the timeout before the operation completes is reached. """ # [START managedkafka_update_cluster] diff --git a/managedkafka/snippets/consumergroups/delete_consumer_group.py b/managedkafka/snippets/consumergroups/delete_consumer_group.py index a9c59b44f8e..caf08628eab 100644 --- a/managedkafka/snippets/consumergroups/delete_consumer_group.py +++ b/managedkafka/snippets/consumergroups/delete_consumer_group.py @@ -29,7 +29,7 @@ def delete_consumer_group( consumer_group_id: ID of the Kafka consumer group. Raises: - This method will raise the exception if the consumer group is not found. + This method will raise the NotFound exception if the consumer group or the parent resource is not found. """ # [START managedkafka_delete_consumergroup] from google.api_core.exceptions import NotFound @@ -53,7 +53,7 @@ def delete_consumer_group( try: client.delete_consumer_group(request=request) print("Deleted consumer group") - except NotFound: - print(f"Consumer group {consumer_group_path} not found") + except NotFound as e: + print(f"Failed to delete consumer group {consumer_group_id} with error: {e.message}") # [END managedkafka_delete_consumergroup] diff --git a/managedkafka/snippets/consumergroups/get_consumer_group.py b/managedkafka/snippets/consumergroups/get_consumer_group.py index ea82970092d..4edfbb480e1 100644 --- a/managedkafka/snippets/consumergroups/get_consumer_group.py +++ b/managedkafka/snippets/consumergroups/get_consumer_group.py @@ -27,8 +27,12 @@ def get_consumer_group( region: Cloud region. cluster_id: ID of the Kafka cluster. consumer_group_id: ID of the Kafka consumer group. + + Raises: + This method will raise the NotFound exception if the consumer group or the parent resource is not found. """ # [START managedkafka_get_consumergroup] + from google.api_core.exceptions import NotFound from google.cloud import managedkafka_v1 # TODO(developer) @@ -46,9 +50,11 @@ def get_consumer_group( name=consumer_group_path, ) - consumer_group = client.get_consumer_group(request=request) - print("Got consumer group:", consumer_group) - - return consumer_group + try: + consumer_group = client.get_consumer_group(request=request) + print("Got consumer group:", consumer_group) + return consumer_group + except NotFound as e: + print(f"Failed to get consumer group {consumer_group_id} with error: {e.message}") # [END managedkafka_get_consumergroup] diff --git a/managedkafka/snippets/consumergroups/update_consumer_group.py b/managedkafka/snippets/consumergroups/update_consumer_group.py index 00fc6cec295..e2cb847a8ad 100644 --- a/managedkafka/snippets/consumergroups/update_consumer_group.py +++ b/managedkafka/snippets/consumergroups/update_consumer_group.py @@ -33,7 +33,7 @@ def update_consumer_group( partition_offsets: Configuration of the topic, represented as a map of partition indexes to their offset value. Raises: - This method will raise the exception if the consumer group is not found. + This method will raise the NotFound exception if the consumer group or the parent resource is not found. """ # [START managedkafka_update_consumergroup] from google.api_core.exceptions import NotFound @@ -74,7 +74,7 @@ def update_consumer_group( try: response = client.update_consumer_group(request=request) print("Updated consumer group:", response) - except NotFound: - print(f"Consumer group {consumer_group.name} not found") + except NotFound as e: + print(f"Failed to update consumer group {consumer_group_id} with error: {e.message}") # [END managedkafka_update_consumergroup] diff --git a/managedkafka/snippets/topics/create_topic.py b/managedkafka/snippets/topics/create_topic.py index c29b2b7ec80..37fc53e01f1 100644 --- a/managedkafka/snippets/topics/create_topic.py +++ b/managedkafka/snippets/topics/create_topic.py @@ -35,7 +35,7 @@ def create_topic( configs: Configuration of the topic. Raises: - This method will raise the exception if the topic already exists. + This method will raise the AlreadyExists exception if the topic already exists. """ # [START managedkafka_create_topic] from google.api_core.exceptions import AlreadyExists @@ -68,7 +68,7 @@ def create_topic( try: response = client.create_topic(request=request) print("Created topic:", response.name) - except AlreadyExists: - print(f"{topic.name} already exists") + except AlreadyExists as e: + print(f"Failed to create topic {topic.name} with error: {e.message}") # [END managedkafka_create_topic] diff --git a/managedkafka/snippets/topics/delete_topic.py b/managedkafka/snippets/topics/delete_topic.py index 3bc80faa571..1af752feee1 100644 --- a/managedkafka/snippets/topics/delete_topic.py +++ b/managedkafka/snippets/topics/delete_topic.py @@ -29,7 +29,7 @@ def delete_topic( topic_id: ID of the Kafka topic. Raises: - This method will raise the exception if the topic is not found. + This method will raise the NotFound exception if the topic or the parent resource is not found. """ # [START managedkafka_delete_topic] from google.api_core.exceptions import NotFound @@ -49,7 +49,7 @@ def delete_topic( try: client.delete_topic(request=request) print("Deleted topic") - except NotFound: - print(f"Topic {topic_path} not found") + except NotFound as e: + print(f"Failed to delete topic {topic_id} with error: {e.message}") # [END managedkafka_delete_topic] diff --git a/managedkafka/snippets/topics/get_topic.py b/managedkafka/snippets/topics/get_topic.py index 0944b4ba8f3..eb0ecb6af6d 100644 --- a/managedkafka/snippets/topics/get_topic.py +++ b/managedkafka/snippets/topics/get_topic.py @@ -27,8 +27,12 @@ def get_topic( region: Cloud region. cluster_id: ID of the Kafka cluster. topic_id: ID of the Kafka topic. + + Raises: + This method will raise the NotFound exception if the topic or the parent resource is not found. """ # [START managedkafka_get_topic] + from google.api_core.exceptions import NotFound from google.cloud import managedkafka_v1 # TODO(developer) @@ -44,9 +48,11 @@ def get_topic( name=topic_path, ) - topic = client.get_topic(request=request) - print("Got topic:", topic) - - return topic + try: + topic = client.get_topic(request=request) + print("Got topic:", topic) + return topic + except NotFound as e: + print(f"Failed to get topic {topic_id} with error: {e.message}") # [END managedkafka_get_topic] diff --git a/managedkafka/snippets/topics/update_topic.py b/managedkafka/snippets/topics/update_topic.py index 5ca65cc87dc..35687bd1477 100644 --- a/managedkafka/snippets/topics/update_topic.py +++ b/managedkafka/snippets/topics/update_topic.py @@ -33,7 +33,7 @@ def update_topic( configs: Configuration of the topic. Raises: - This method will raise the exception if the topic is not found. + This method will raise the NotFound exception if the topic or the parent resource is not found. """ # [START managedkafka_update_topic] from google.api_core.exceptions import NotFound @@ -66,7 +66,7 @@ def update_topic( try: response = client.update_topic(request=request) print("Updated topic:", response) - except NotFound: - print(f"Topic {topic.name} not found") + except NotFound as e: + print(f"Failed to update topic {topic_id} with error: {e.message}") # [END managedkafka_update_topic] From f8d8312778c86ae98e472a9366df9bd3fcd88ee9 Mon Sep 17 00:00:00 2001 From: Adam Luong Date: Fri, 15 Nov 2024 15:18:17 -0500 Subject: [PATCH 2/2] remove return since devrel tags are now moved inside the method to make the samples self runnable --- managedkafka/snippets/clusters/get_cluster.py | 1 - managedkafka/snippets/clusters/list_clusters.py | 2 -- managedkafka/snippets/consumergroups/get_consumer_group.py | 1 - managedkafka/snippets/consumergroups/list_consumer_groups.py | 2 -- managedkafka/snippets/topics/get_topic.py | 1 - managedkafka/snippets/topics/list_topics.py | 2 -- 6 files changed, 9 deletions(-) diff --git a/managedkafka/snippets/clusters/get_cluster.py b/managedkafka/snippets/clusters/get_cluster.py index edafc3e7dca..e371f42390b 100644 --- a/managedkafka/snippets/clusters/get_cluster.py +++ b/managedkafka/snippets/clusters/get_cluster.py @@ -48,7 +48,6 @@ def get_cluster( try: cluster = client.get_cluster(request=request) print("Got cluster:", cluster) - return cluster except NotFound as e: print(f"Failed to get cluster {cluster_id} with error: {e.message}") diff --git a/managedkafka/snippets/clusters/list_clusters.py b/managedkafka/snippets/clusters/list_clusters.py index 987741b44dc..ad34d20a4e4 100644 --- a/managedkafka/snippets/clusters/list_clusters.py +++ b/managedkafka/snippets/clusters/list_clusters.py @@ -41,6 +41,4 @@ def list_clusters( for cluster in response: print("Got cluster:", cluster) - return [cluster.name for cluster in response] - # [END managedkafka_list_clusters] diff --git a/managedkafka/snippets/consumergroups/get_consumer_group.py b/managedkafka/snippets/consumergroups/get_consumer_group.py index 4edfbb480e1..3c4be00866b 100644 --- a/managedkafka/snippets/consumergroups/get_consumer_group.py +++ b/managedkafka/snippets/consumergroups/get_consumer_group.py @@ -53,7 +53,6 @@ def get_consumer_group( try: consumer_group = client.get_consumer_group(request=request) print("Got consumer group:", consumer_group) - return consumer_group except NotFound as e: print(f"Failed to get consumer group {consumer_group_id} with error: {e.message}") diff --git a/managedkafka/snippets/consumergroups/list_consumer_groups.py b/managedkafka/snippets/consumergroups/list_consumer_groups.py index beeb1e0edbd..6686b48f3c6 100644 --- a/managedkafka/snippets/consumergroups/list_consumer_groups.py +++ b/managedkafka/snippets/consumergroups/list_consumer_groups.py @@ -44,6 +44,4 @@ def list_consumer_groups( for consumer_group in response: print("Got consumer group:", consumer_group) - return [consumer_group.name for consumer_group in response] - # [END managedkafka_list_consumergroups] diff --git a/managedkafka/snippets/topics/get_topic.py b/managedkafka/snippets/topics/get_topic.py index eb0ecb6af6d..2e17abfd284 100644 --- a/managedkafka/snippets/topics/get_topic.py +++ b/managedkafka/snippets/topics/get_topic.py @@ -51,7 +51,6 @@ def get_topic( try: topic = client.get_topic(request=request) print("Got topic:", topic) - return topic except NotFound as e: print(f"Failed to get topic {topic_id} with error: {e.message}") diff --git a/managedkafka/snippets/topics/list_topics.py b/managedkafka/snippets/topics/list_topics.py index 9b1c0596942..c4557737d08 100644 --- a/managedkafka/snippets/topics/list_topics.py +++ b/managedkafka/snippets/topics/list_topics.py @@ -44,6 +44,4 @@ def list_topics( for topic in response: print("Got topic:", topic) - return [topic.name for topic in response] - # [END managedkafka_list_topics]