Naming feedback - part 1 (Azure#16208)

* EventGridConsumer

* decodes

Author: Rakshith Bhyravabhotla

sdk/eventgrid/azure-eventgrid/CHANGELOG.md

@@ -4,6 +4,9 @@
 
   **Breaking Changes**
   - `EventGridSharedAccessSignatureCredential` is deprecated in favor of `AzureSasCredential`.
+  - `EventGridConsumer` is now renamed to `EventGridDeserializer`.
+  - `decode_cloud_event` is renamed to `deserialize_cloud_events`.
+  - `decode_eventgrid_event` is renamed to `deserialize_eventgrid_events`.
 
   **Bug Fixes**
   - `EventGridEvent` has two additional required positional parameters namely, `data` and `data_version`.

sdk/eventgrid/azure-eventgrid/README.md

@@ -62,8 +62,8 @@ Information about the key concepts on Event Grid, see [Concepts in Azure Event G
 `EventGridPublisherClient` provides operations to send event data to topic hostname specified during client initialization.
 Either a list or a single instance of CloudEvent/EventGridEvent/CustomEvent can be sent.
 
-### EventGridConsumer
-`EventGridConsumer` is used to desrialize an event received.
+### EventGridDeserializer
+`EventGridDeserializer` is used to desrialize an event received.
 
 ## Examples
 
@@ -129,9 +129,9 @@ This example demonstrates consuming and deserializing an eventgrid event.
 
 ```Python
 import os
-from azure.eventgrid import EventGridConsumer
+from azure.eventgrid import EventGridDeserializer
 
-consumer = EventGridConsumer()
+consumer = EventGridDeserializer()
 
 eg_storage_dict = {
     "id":"bbab625-dc56-4b22-abeb-afcc72e5290c",
@@ -146,7 +146,7 @@ eg_storage_dict = {
     "topic":"/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventGrid/topics/eventgridegsub"
 }
 
-deserialized_event = consumer.decode_eventgrid_event(eg_storage_dict)
+deserialized_event = consumer.deserialize_eventgrid_events(eg_storage_dict)
 
 # both allow access to raw properties as strings
 time_string = deserialized_event.event_time
@@ -158,9 +158,9 @@ This example demonstrates consuming and deserializing a cloud event.
 
 ```Python
 import os
-from azure.eventgrid import EventGridConsumer
+from azure.eventgrid import EventGridDeserializer
 
-consumer = EventGridConsumer()
+consumer = EventGridDeserializer()
 
 cloud_storage_dict = {
     "id":"a0517898-9fa4-4e70-b4a3-afda1dd68672",
@@ -173,7 +173,7 @@ cloud_storage_dict = {
     "specversion":"1.0"
 }
 
-deserialized_event = consumer.decode_cloud_event(cloud_storage_dict)
+deserialized_event = consumer.deserialize_cloud_events(cloud_storage_dict)
 
 # both allow access to raw properties as strings
 time_string = deserialized_event.time

sdk/eventgrid/azure-eventgrid/azure/eventgrid/__init__.py

@@ -5,12 +5,12 @@
 # --------------------------------------------------------------------------
 
 from ._publisher_client import EventGridPublisherClient
-from ._consumer import EventGridConsumer
+from ._consumer import EventGridDeserializer
 from ._helpers import generate_shared_access_signature
 from ._models import CloudEvent, CustomEvent, EventGridEvent
 from ._version import VERSION
 
-__all__ = ['EventGridPublisherClient', 'EventGridConsumer',
+__all__ = ['EventGridPublisherClient', 'EventGridDeserializer',
             'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_shared_access_signature'
             ]
 __version__ = VERSION

sdk/eventgrid/azure-eventgrid/azure/eventgrid/_consumer.py

@@ -16,12 +16,12 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-class EventGridConsumer(object):
+class EventGridDeserializer(object):
     """
     A consumer responsible for deserializing event handler messages, to allow for
     access to strongly typed Event objects.
     """
-    def decode_cloud_event(self, cloud_event, **kwargs): # pylint: disable=no-self-use
+    def deserialize_cloud_events(self, cloud_event, **kwargs): # pylint: disable=no-self-use
         # type: (Union[str, dict, bytes], Any) -> CloudEvent
         """Single event following CloudEvent schema will be parsed and returned as Deserialized Event.
         :param cloud_event: The event to be deserialized.
@@ -44,7 +44,7 @@ def decode_cloud_event(self, cloud_event, **kwargs): # pylint: disable=no-self-u
             raise ValueError('Error: cannot deserialize event. Event does not have a valid format. \
                 Event must be a string, dict, or bytes following the CloudEvent schema.')
 
-    def decode_eventgrid_event(self, eventgrid_event, **kwargs): # pylint: disable=no-self-use
+    def deserialize_eventgrid_events(self, eventgrid_event, **kwargs): # pylint: disable=no-self-use
         # type: (Union[str, dict, bytes], Any) -> EventGridEvent
         """Single event following EventGridEvent schema will be parsed and returned as Deserialized Event.
         :param eventgrid_event: The event to be deserialized.

sdk/eventgrid/azure-eventgrid/migration_guide.md

@@ -65,12 +65,12 @@ cloud_event = {
 |---|---|---|
 |`EventGridClient(credentials)`|`EventGridPublisherClient(topic_hostname, credential)`|[Sample for client construction](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py)|
 
-* Additionally, we now have an `EventGridConsumer` that should be used to deserialize the events. This class is used only to decode data into a `CloudEvent` or an `EventGridEvent`. Hence, there are no credentials required to construct this as shown below.
+* Additionally, we now have an `EventGridDeserializer` that should be used to deserialize the events. This class is used only to decode data into a `CloudEvent` or an `EventGridEvent`. Hence, there are no credentials required to construct this as shown below.
 
 ```Python
-from azure.eventgrid import EventGridConsumer
+from azure.eventgrid import EventGridDeserializer
 
-eg_consumer = EventGridConsumer()
+eg_consumer = EventGridDeserializer()
 ```
 
 ### Publishing Events
@@ -83,12 +83,12 @@ The `publish_events` API is replaced with `send` in v2.0. Additionally, `send` A
 
 ### Consuming Events
 
-In v2.0, `EventGridConsumer` can be used to decode both Cloud Events and EventGrid Events. Please find the samples [here](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventgrid/azure-eventgrid/samples/consume_samples) to see detailed examples of the consumer.
+In v2.0, `EventGridDeserializer` can be used to decode both Cloud Events and EventGrid Events. Please find the samples [here](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventgrid/azure-eventgrid/samples/consume_samples) to see detailed examples of the consumer.
 
 ```Python
-EventGridConsumer().decode_cloud_event(cloud_event_dict)
+EventGridDeserializer().deserialize_cloud_events(cloud_event_dict)
 
-EventGridConsumer().decode_eventgrid_event(eventgrid_event_dict)
+EventGridDeserializer().deserialize_eventgrid_events(eventgrid_event_dict)
 ```
 
 ## Additional samples

sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs3_consume_system_events.py

@@ -12,15 +12,15 @@
 """
 import os
 import json
-from azure.eventgrid import EventGridConsumer
+from azure.eventgrid import EventGridDeserializer
 
-consumer = EventGridConsumer()
+consumer = EventGridDeserializer()
 path = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "./cs3_system_event.json"))
 
 with open(path, 'r') as f:
     eg_event_received_message = json.loads(f.read())
 # returns List[DeserializedEvent]
-event = consumer.decode_eventgrid_event(eg_event_received_message)
+event = consumer.deserialize_eventgrid_events(eg_event_received_message)
 
 datetime_object = event.event_time
 print(datetime_object)

sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs4_consume_custom_events.py

@@ -12,16 +12,16 @@
 """
 import os
 import json
-from azure.eventgrid import EventGridConsumer
+from azure.eventgrid import EventGridDeserializer
 
-consumer = EventGridConsumer()
+consumer = EventGridDeserializer()
 path = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "./cs4_event_grid_event_custom_event.json"))
 
 with open(path, 'r') as f:
     eg_event_received_message = json.loads(f.read())
 
 # returns List[DeserializedEvent]
-event = consumer.decode_eventgrid_event(eg_event_received_message)
+event = consumer.deserialize_eventgrid_events(eg_event_received_message)
 
 # returns { "itemSku": "Contoso Item SKU #1" }
 data_dict = event.data

sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs6_consume_events_using_cloud_events_1.0_schema.py

@@ -12,16 +12,16 @@
 """
 import os
 import json
-from azure.eventgrid import EventGridConsumer
+from azure.eventgrid import EventGridDeserializer
 
-consumer = EventGridConsumer()
+consumer = EventGridDeserializer()
 path = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "./cs6_cloud_event_system_event.json"))
 
 with open(path, 'r') as f:
     cloud_event_received_message = json.loads(f.read())
 
 # returns List[DeserializedEvent]
-event = consumer.decode_cloud_event(cloud_event_received_message)
+event = consumer.deserialize_cloud_events(cloud_event_received_message)
 
 datetime_object = event.time
 print(datetime_object)

sdk/eventgrid/azure-eventgrid/samples/consume_samples/consume_cloud_custom_data_sample.py

@@ -12,7 +12,7 @@
     Set the environment variables with your own values before running the sample:
 """
 import json
-from azure.eventgrid import EventGridConsumer, CloudEvent
+from azure.eventgrid import EventGridDeserializer, CloudEvent
 
 # all types of CloudEvents below produce same DeserializedEvent
 cloud_custom_dict = {
@@ -26,12 +26,12 @@
 cloud_custom_string = json.dumps(cloud_custom_dict)
 cloud_custom_bytes = str(cloud_custom_string).encode("utf-8")
 
-client = EventGridConsumer()
-deserialized_dict_event = client.decode_cloud_event(cloud_custom_dict)
+client = EventGridDeserializer()
+deserialized_dict_event = client.deserialize_cloud_events(cloud_custom_dict)
 print(deserialized_dict_event)
 
-deserialized_str_event = client.decode_cloud_event(cloud_custom_string)
+deserialized_str_event = client.deserialize_cloud_events(cloud_custom_string)
 print(deserialized_str_event)
 
-deserialized_bytes_event = client.decode_cloud_event(cloud_custom_bytes)
+deserialized_bytes_event = client.deserialize_cloud_events(cloud_custom_bytes)
 print(deserialized_bytes_event)

sdk/eventgrid/azure-eventgrid/samples/consume_samples/consume_eg_storage_blob_created_data_sample.py

@@ -12,7 +12,7 @@
     Set the environment variables with your own values before running the sample:
 """
 import json
-from azure.eventgrid import EventGridConsumer, EventGridEvent
+from azure.eventgrid import EventGridDeserializer, EventGridEvent
 from azure.eventgrid.models import StorageBlobCreatedEventData
 
 # all types of EventGridEvents below produce same DeserializedEvent
@@ -41,12 +41,12 @@
 eg_storage_string = json.dumps(eg_storage_dict)
 eg_storage_bytes = str(eg_storage_string).encode("utf-8")
 
-client = EventGridConsumer()
-deserialized_dict_event = client.decode_eventgrid_event(eg_storage_dict)
+client = EventGridDeserializer()
+deserialized_dict_event = client.deserialize_eventgrid_events(eg_storage_dict)
 print(deserialized_dict_event)
 
-deserialized_str_event = client.decode_eventgrid_event(eg_storage_string)
+deserialized_str_event = client.deserialize_eventgrid_events(eg_storage_string)
 print(deserialized_str_event)
 
-deserialized_bytes_event = client.decode_eventgrid_event(eg_storage_bytes)
+deserialized_bytes_event = client.deserialize_eventgrid_events(eg_storage_bytes)
 print(deserialized_bytes_event)