cloudevents
/
sdk-python
mirror of https://github.com/cloudevents/sdk-python.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: type v1.Event chainable Set*() methods 

The v1.Event self-returning Set*() methods like SetData() were returning
BaseEvent, which doesn't declare the same Set* methods. As a result,
chaining more than one Set* method would make the return type unknown.

This was causing type errors in test_event_pipeline.py.

The Set*() methods now return the Self type.

Signed-off-by: Hal Blackburn <hwtb2@cam.ac.uk>
This commit is contained in:
Hal Blackburn 2025-03-17 07:34:05 +00:00
parent e9b6301284
commit eacac4fbbc
No known key found for this signature in database
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
cloudevents/sdk/event/v1.py
View File

@ -11,10 +11,15 @@
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
from __future__ import annotations
import typing import typing
from cloudevents.sdk.event import base, opt from cloudevents.sdk.event import base, opt
if typing.TYPE_CHECKING:
from typing_extensions import Self
class Event(base.BaseEvent): class Event(base.BaseEvent):
_ce_required_fields = {"id", "source", "type", "specversion"} _ce_required_fields = {"id", "source", "type", "specversion"}
@ -79,39 +84,39 @@ class Event(base.BaseEvent):
return {} return {}
return dict(result) return dict(result)
def SetEventType(self, eventType: str) -> base.BaseEvent: def SetEventType(self, eventType: str) -> Self:
self.Set("type", eventType) self.Set("type", eventType)
return self return self
def SetSource(self, source: str) -> base.BaseEvent: def SetSource(self, source: str) -> Self:
self.Set("source", source) self.Set("source", source)
return self return self
def SetEventID(self, eventID: str) -> base.BaseEvent: def SetEventID(self, eventID: str) -> Self:
self.Set("id", eventID) self.Set("id", eventID)
return self return self
def SetEventTime(self, eventTime: typing.Optional[str]) -> base.BaseEvent: def SetEventTime(self, eventTime: typing.Optional[str]) -> Self:
self.Set("time", eventTime) self.Set("time", eventTime)
return self return self
def SetSubject(self, subject: typing.Optional[str]) -> base.BaseEvent: def SetSubject(self, subject: typing.Optional[str]) -> Self:
self.Set("subject", subject) self.Set("subject", subject)
return self return self
def SetSchema(self, schema: typing.Optional[str]) -> base.BaseEvent: def SetSchema(self, schema: typing.Optional[str]) -> Self:
self.Set("dataschema", schema) self.Set("dataschema", schema)
return self return self
def SetContentType(self, contentType: typing.Optional[str]) -> base.BaseEvent: def SetContentType(self, contentType: typing.Optional[str]) -> Self:
self.Set("datacontenttype", contentType) self.Set("datacontenttype", contentType)
return self return self
def SetData(self, data: typing.Optional[object]) -> base.BaseEvent: def SetData(self, data: typing.Optional[object]) -> Self:
self.Set("data", data) self.Set("data", data)
return self return self
def SetExtensions(self, extensions: typing.Optional[dict]) -> base.BaseEvent: def SetExtensions(self, extensions: typing.Optional[dict]) -> Self:
self.Set("extensions", extensions) self.Set("extensions", extensions)
return self return self