move cloud events to azure core #16661

rakshith91 · 2021-02-10T07:39:37Z

Adding CloudEvent to azure-core as follows:

from azure.core.messaging import CloudEvent

lmazuel · 2021-02-11T17:17:10Z

sdk/core/azure-core/azure/core/messaging.py

+
+def _decode(content):
+    try:
+        return base64.b64decode(content.encode('utf-8'))


ascii is enough, per base64 spec.

I'm not even sure we need to encode, could you describe the scenario where we do?

Yeah, this method is confusing to me. Is the only reason for it to exist to normalize the exception type?

yes - thinking about it, i think we dont need this method at all - removing it

lmazuel · 2021-02-11T17:20:20Z

sdk/core/azure-core/azure/core/messaging.py

+        self.type = type
+        self.specversion = kwargs.pop("specversion", "1.0")
+        self.id = kwargs.pop("id", str(uuid.uuid4()))
+        self.time = kwargs.pop("time", dt.datetime.utcnow().isoformat())


https://docs.python.org/3/library/datetime.html#datetime.datetime.utcnow
Warning Because naive datetime objects are treated by many datetime methods as local times, it is preferred to use aware datetimes to represent times in UTC. As such, the recommended way to create an object representing the current time in UTC is by calling datetime.now(timezone.utc).

Problem is, Python 2 doesn't have timezone.utc. @johanste usually I tell people to use msrest.serialization.utc since they use msrest as a dependency anyway, but here it won't work. Though?

lmazuel · 2021-02-11T17:22:47Z

sdk/core/azure-core/azure/core/messaging.py

+        source=event.pop("source", None),
+        type=event.pop("type", None),
+        specversion=event.pop("specversion", None),
+        data=event.pop("data", None) or _decode(event.pop("data_base64", None)),


I would expect an error if both data and data_base64 are present for clarity

I agree with it, but if we ever decide to add data_base64 in the future, this error would cause a breaking change - thoughts?

lmazuel · 2021-02-11T17:23:10Z

sdk/core/azure-core/tests/test_messaging_from_dict.py

+import json
+
+from azure.core.messaging import CloudEvent
+from devtools_testutils import AzureMgmtTestCase


bad copying ;) - removed it

lmazuel · 2021-02-11T17:24:06Z

sdk/core/azure-core/tests/test_messaging_from_dict.py

+
+
+def test_cloud_custom_dict_with_extensions():
+    event = CloudEvent.from_dict(cloud_custom_dict_with_extensions)


I actually find it confusing to have the body in another file here. Could we get rid of the _mock.py file and insert the dict here?

xiangyan99 · 2021-02-16T17:28:38Z

sdk/core/azure-core/CHANGELOG.md

@@ -2,6 +2,9 @@

 ## 1.11.1 (Unreleased)


xiangyan99

Please separate core changes and event hub changes into different PRs.

xiangyan99 · 2021-02-16T17:32:15Z

sdk/core/azure-core/azure/core/messaging.py

+    :type subject: str
+    :keyword specversion: Optional. The version of the CloudEvent spec. Defaults to "1.0"
+    :type specversion: str
+    :keyword id: Optional. An identifier for the event. The combination of id and source must be


We don't need explicit "Optional." for keyword arguments. Right? :)

hmm, not sure if it's a good practice - but there can certainly be "required" keyword only params (hopefully not in our libraries, but still possible) - thought no harm in mentioning it's optional :)

xiangyan99 · 2021-02-16T17:33:52Z

sdk/core/azure-core/azure/core/messaging.py

+        :rtype: CloudEvent
+        """
+        return cls(
+        id=event.pop("id", None),


Given we already pass **kwargs into cls, why we need id=event.pop("id", None), etc.?

hmm, intentionally popping them since we want to have the remainder of the dict as "extensions"

xiangyan99 · 2021-02-16T17:34:41Z

sdk/core/azure-core/tests/_mocks.py

@@ -0,0 +1,42 @@
+# storage cloud event


Please give the file a more specific name.

xiangyan99 · 2021-02-17T16:32:32Z

And you also need to bump the core dependency version to 1.12.0 for event grid. :)

rakshith91 · 2021-02-18T19:06:28Z

Please review core related chages here
Add cloud event to core by rakshith91 · Pull Request #16800 · Azure/azure-sdk-for-python (github.com)

iscai-msft · 2021-02-19T15:38:57Z

/azp run python - autorest - pr

azure-pipelines · 2021-02-19T15:39:07Z

Azure Pipelines successfully started running 1 pipeline(s).

ghost added Azure.Core Event Grid labels Feb 10, 2021

rakshith91 force-pushed the cloud_to_core branch from 89b5010 to 54f5f3b Compare February 11, 2021 00:42

rakshith91 marked this pull request as ready for review February 11, 2021 07:01

rakshith91 requested review from lmazuel, swathipil, xiangyan99 and yunhaoling as code owners February 11, 2021 07:02

rakshith91 requested a review from johanste February 11, 2021 07:02

lmazuel reviewed Feb 11, 2021

View reviewed changes

rakshith91 mentioned this pull request Feb 11, 2021

Implement from_dict #16509

Closed

xiangyan99 reviewed Feb 16, 2021

View reviewed changes

sdk/core/azure-core/CHANGELOG.md Outdated

@@ -2,6 +2,9 @@

## 1.11.1 (Unreleased)

Copy link

Member

xiangyan99 Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.12.0

rakshith91 reacted with thumbs up emoji

xiangyan99 reviewed Feb 16, 2021

View reviewed changes

sdk/core/azure-core/tests/_mocks.py Outdated

@@ -0,0 +1,42 @@

# storage cloud event

Copy link

Member

xiangyan99 Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please give the file a more specific name.

rakshith91 added 9 commits February 17, 2021 22:36

Add cloud event to core

abe2389

extensions

9ed935d

raise on both

d11e02f

minor

ec3474c

move cloud events to azure core

d892f78

move policy

6ccef56

move policy-2

55fbbb0

fix

9b11e25

lint

bc170cd

rakshith91 added 12 commits February 18, 2021 10:28

lint

de95e70

move back policy

149de57

unexpose

51fd23d

update samples

3cb82bd

changelog

1428a4d

tests fix

543c05c

comments - 1

dde659c

comments - 2

9a0c397

update setup.py

bfc15d1

revert

c418f17

lint

161487f

duplicate

4505a22

rakshith91 force-pushed the cloud_to_core branch from 8f08e33 to 4505a22 Compare February 18, 2021 18:31

rakshith91 closed this Mar 3, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

move cloud events to azure core #16661

move cloud events to azure core #16661

rakshith91 commented Feb 10, 2021 •

edited

Loading

lmazuel Feb 11, 2021

johanste Feb 12, 2021

rakshith91 Feb 17, 2021

lmazuel Feb 11, 2021

rakshith91 Feb 17, 2021

lmazuel Feb 11, 2021

rakshith91 Feb 17, 2021

lmazuel Feb 11, 2021

rakshith91 Feb 17, 2021

lmazuel Feb 11, 2021

xiangyan99 Feb 16, 2021

xiangyan99 left a comment

xiangyan99 Feb 16, 2021

rakshith91 Feb 17, 2021

xiangyan99 Feb 16, 2021

rakshith91 Feb 17, 2021

xiangyan99 Feb 16, 2021

xiangyan99 commented Feb 17, 2021

rakshith91 commented Feb 18, 2021

iscai-msft commented Feb 19, 2021

azure-pipelines bot commented Feb 19, 2021



		def test_cloud_custom_dict_with_extensions():
		event = CloudEvent.from_dict(cloud_custom_dict_with_extensions)

move cloud events to azure core #16661

move cloud events to azure core #16661

Conversation

rakshith91 commented Feb 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xiangyan99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xiangyan99 commented Feb 17, 2021

rakshith91 commented Feb 18, 2021

iscai-msft commented Feb 19, 2021

azure-pipelines bot commented Feb 19, 2021

rakshith91 commented Feb 10, 2021 •

edited

Loading