Improved error message in the from_dict
#19416
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
xiangyan99
reviewed
Jun 23, 2021
| @@ -122,6 +122,16 @@ def from_dict(cls, event): | |||
| :type event: dict | |||
| :rtype: CloudEvent | |||
| """ | |||
| if not all([_ in event for _ in ("source", "type")]): | |||
There was a problem hiding this comment.
Can you add the description of the doc or a link?
There was a problem hiding this comment.
xiangyan99
reviewed
Jun 23, 2021
| raise ValueError( | ||
| "The event does not conform to the cloud event spec. source and type are required." | ||
| ) | ||
|
|
||
| kwargs = {} # type: Dict[Any, Any] | ||
| reserved_attr = [ |
There was a problem hiding this comment.
Are these keys case-sensitive?
There was a problem hiding this comment.
yes - making it non case sensitive would be breaking
lmazuel
reviewed
Jun 24, 2021
| if all([_ in event for _ in ("subject", "eventType", "data", "dataVersion", "id", "eventTime")]): | ||
| raise ValueError( | ||
| "The event does not conform to the cloud event spec https://github.com/cloudevents/spec." + | ||
| " Try using the EventGridEvent from azure-eventgrid library" |
There was a problem hiding this comment.
I would be more explicit:
It looks like your event is an EventGrid schema. You can parse EventGrid events using EventGridEvent.from_dict of the azure-eventgrid library
lmazuel
reviewed
Jun 24, 2021
| "The event does not conform to the cloud event spec https://github.com/cloudevents/spec." + | ||
| " Try using the EventGridEvent from azure-eventgrid library" | ||
| ) | ||
| raise ValueError( |
There was a problem hiding this comment.
I would do this whole block into a try/except around the cls at the end, pure EAFP
xiangyan99
approved these changes
Jun 28, 2021
iscai-msft
added a commit
that referenced
this pull request
Jun 28, 2021
…into rest_layer * 'main' of https://github.com/Azure/azure-sdk-for-python: modify _on to _time (#19546) Improved error message in the `from_dict` (#19416) Regenerate code with latest commit (#19512) [auto-release-pipeline] update auto-calculation rule for version number (#19488) fix dependencies (#19513)
rakshith91
pushed a commit
to rakshith91/azure-sdk-for-python
that referenced
this pull request
Jul 16, 2021
* Improved error message in the `from_dict` * lint * spec lin * tests * Add AAD support * eafp * Revert "Add AAD support" This reverts commit 1cc83d9. * language * lint
azure-sdk
pushed a commit
to azure-sdk/azure-sdk-for-python
that referenced
this pull request
Jul 1, 2022
[OperationalInsights] workspace and component purge (Azure#19416) * Add blockchain to latest profile * Add additional types * Purge update * bad syntax fix for workspacePurge examples * pretty Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
azure-sdk
pushed a commit
to azure-sdk/azure-sdk-for-python
that referenced
this pull request
Jul 1, 2022
[OperationalInsights] workspace and component purge (Azure#19416) * Add blockchain to latest profile * Add additional types * Purge update * bad syntax fix for workspacePurge examples * pretty Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #19410
Background:
@jongio's code tried sending EG event schema to cloud event's from_dict method which won't work. Need to imrpove the error message here.