Remove System Events

sdk/eventgrid/azure-eventgrid/CHANGELOG.md

@@ -7,7 +7,7 @@
   - `EventGridConsumer` is now renamed to `EventGridDeserializer`.
   - `decode_cloud_event` is renamed to `deserialize_cloud_events`.
   - `decode_eventgrid_event` is renamed to `deserialize_eventgrid_events`.
-  - The system events now exist in the `azure.eventgrid.systemevents` namespace instead of `azure.eventgrid.models` namespace.
+  - `azure.eventgrid.models` namespace along with all the models in it are now removed. `azure.eventgrid.SystemEventMappings` can be used to get the event model type mapping.
   - `topic_hostname` is renamed to `endpoint` in the `EventGridPublisherClient`.
   - `data` is now a required param for `CloudEvent`.
   - `azure.eventgrid.generate_shared_access_signature` method is now renamed to `generate_sas`.

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

@@ -6,11 +6,13 @@
 
 from ._publisher_client import EventGridPublisherClient
 from ._consumer import EventGridDeserializer
+from ._event_mappings import SystemEventMappings
 from ._helpers import generate_sas
 from ._models import CloudEvent, CustomEvent, EventGridEvent
 from ._version import VERSION
 
 __all__ = ['EventGridPublisherClient', 'EventGridDeserializer',
-            'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_sas'
+            'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_sas',
+            'SystemEventMappings'
             ]
 __version__ = VERSION

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

@@ -24,6 +24,9 @@ class EventGridDeserializer(object):
     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.
+        Use `.data` to get the data in the raw format. To check the list of recognizable system topics,
+        visit https://docs.microsoft.com/azure/event-grid/system-topics.
+
         :param cloud_event: The event to be deserialized.
         :type cloud_event: Union[str, dict, bytes]
         :rtype: CloudEvent
@@ -34,11 +37,8 @@ def deserialize_cloud_events(self, cloud_event, **kwargs): # pylint: disable=no-
         try:
             cloud_event = CloudEvent._from_json(cloud_event, encode) # pylint: disable=protected-access
             deserialized_event = CloudEvent._from_generated(cloud_event) # pylint: disable=protected-access
-            CloudEvent._deserialize_data(deserialized_event, deserialized_event.type) # pylint: disable=protected-access
             return deserialized_event
         except Exception as err:
-            _LOGGER.error('Error: cannot deserialize event. Event does not have a valid format. \
-                Event must be a string, dict, or bytes following the CloudEvent schema.')
             _LOGGER.error('Your event: %s', cloud_event)
             _LOGGER.error(err)
             raise ValueError('Error: cannot deserialize event. Event does not have a valid format. \
@@ -47,6 +47,9 @@ def deserialize_cloud_events(self, cloud_event, **kwargs): # pylint: disable=no-
     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.
+        Use `.data` to get the data in the raw format. To check the list of recognizable system topics,
+        visit https://docs.microsoft.com/azure/event-grid/system-topics.
+
         :param eventgrid_event: The event to be deserialized.
         :type eventgrid_event: Union[str, dict, bytes]
         :rtype: EventGridEvent
@@ -57,11 +60,8 @@ def deserialize_eventgrid_events(self, eventgrid_event, **kwargs): # pylint: dis
         try:
             eventgrid_event = EventGridEvent._from_json(eventgrid_event, encode) # pylint: disable=protected-access
             deserialized_event = EventGridEvent.deserialize(eventgrid_event)
-            EventGridEvent._deserialize_data(deserialized_event, deserialized_event.event_type) # pylint: disable=protected-access
             return cast(EventGridEvent, deserialized_event)
         except Exception as err:
-            _LOGGER.error('Error: cannot deserialize event. Event does not have a valid format. \
-                Event must be a string, dict, or bytes following the CloudEvent schema.')
             _LOGGER.error('Your event: %s', eventgrid_event)
             _LOGGER.error(err)
             raise ValueError('Error: cannot deserialize event. Event does not have a valid format. \