Skip to content

Commit 82e5afc

Browse files
author
Rakshith Bhyravabhotla
authored
Remove System Events (Azure#16358)
1 parent e354a95 commit 82e5afc

File tree

9 files changed

+130
-488
lines changed

9 files changed

+130
-488
lines changed

sdk/eventgrid/azure-eventgrid/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- `EventGridConsumer` is now renamed to `EventGridDeserializer`.
88
- `decode_cloud_event` is renamed to `deserialize_cloud_events`.
99
- `decode_eventgrid_event` is renamed to `deserialize_eventgrid_events`.
10-
- The system events now exist in the `azure.eventgrid.systemevents` namespace instead of `azure.eventgrid.models` namespace.
10+
- `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.
1111
- `topic_hostname` is renamed to `endpoint` in the `EventGridPublisherClient`.
1212
- `data` is now a required param for `CloudEvent`.
1313
- `azure.eventgrid.generate_shared_access_signature` method is now renamed to `generate_sas`.

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@
66

77
from ._publisher_client import EventGridPublisherClient
88
from ._consumer import EventGridDeserializer
9+
from ._event_mappings import SystemEventMappings
910
from ._helpers import generate_sas
1011
from ._models import CloudEvent, CustomEvent, EventGridEvent
1112
from ._version import VERSION
1213

1314
__all__ = ['EventGridPublisherClient', 'EventGridDeserializer',
14-
'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_sas'
15+
'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_sas',
16+
'SystemEventMappings'
1517
]
1618
__version__ = VERSION

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ class EventGridDeserializer(object):
2424
def deserialize_cloud_events(self, cloud_event, **kwargs): # pylint: disable=no-self-use
2525
# type: (Union[str, dict, bytes], Any) -> CloudEvent
2626
"""Single event following CloudEvent schema will be parsed and returned as Deserialized Event.
27+
Use `.data` to get the data in the raw format. To check the list of recognizable system topics,
28+
visit https://docs.microsoft.com/azure/event-grid/system-topics.
29+
2730
:param cloud_event: The event to be deserialized.
2831
:type cloud_event: Union[str, dict, bytes]
2932
:rtype: CloudEvent
@@ -34,11 +37,8 @@ def deserialize_cloud_events(self, cloud_event, **kwargs): # pylint: disable=no-
3437
try:
3538
cloud_event = CloudEvent._from_json(cloud_event, encode) # pylint: disable=protected-access
3639
deserialized_event = CloudEvent._from_generated(cloud_event) # pylint: disable=protected-access
37-
CloudEvent._deserialize_data(deserialized_event, deserialized_event.type) # pylint: disable=protected-access
3840
return deserialized_event
3941
except Exception as err:
40-
_LOGGER.error('Error: cannot deserialize event. Event does not have a valid format. \
41-
Event must be a string, dict, or bytes following the CloudEvent schema.')
4242
_LOGGER.error('Your event: %s', cloud_event)
4343
_LOGGER.error(err)
4444
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-
4747
def deserialize_eventgrid_events(self, eventgrid_event, **kwargs): # pylint: disable=no-self-use
4848
# type: (Union[str, dict, bytes], Any) -> EventGridEvent
4949
"""Single event following EventGridEvent schema will be parsed and returned as Deserialized Event.
50+
Use `.data` to get the data in the raw format. To check the list of recognizable system topics,
51+
visit https://docs.microsoft.com/azure/event-grid/system-topics.
52+
5053
:param eventgrid_event: The event to be deserialized.
5154
:type eventgrid_event: Union[str, dict, bytes]
5255
:rtype: EventGridEvent
@@ -57,11 +60,8 @@ def deserialize_eventgrid_events(self, eventgrid_event, **kwargs): # pylint: dis
5760
try:
5861
eventgrid_event = EventGridEvent._from_json(eventgrid_event, encode) # pylint: disable=protected-access
5962
deserialized_event = EventGridEvent.deserialize(eventgrid_event)
60-
EventGridEvent._deserialize_data(deserialized_event, deserialized_event.event_type) # pylint: disable=protected-access
6163
return cast(EventGridEvent, deserialized_event)
6264
except Exception as err:
63-
_LOGGER.error('Error: cannot deserialize event. Event does not have a valid format. \
64-
Event must be a string, dict, or bytes following the CloudEvent schema.')
6565
_LOGGER.error('Your event: %s', eventgrid_event)
6666
_LOGGER.error(err)
6767
raise ValueError('Error: cannot deserialize event. Event does not have a valid format. \

0 commit comments

Comments
 (0)