Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add remaining type hints to synapse.events. #11098

Merged
merged 20 commits into from
Nov 2, 2021
Merged

Add remaining type hints to synapse.events. #11098

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
f181e54
Add types to synapse.events.
clokep Sep 22, 2021
a90954e
Add type for redacts.
clokep Oct 8, 2021
29bfdc8
Add type hint for content.
clokep Oct 8, 2021
90251d6
Remove DictProperties which vary based on sub-class.
clokep Oct 8, 2021
93c91b1
Add remaining types for DictProperty & DefaultDictProperty.
clokep Oct 15, 2021
0a01691
Newsfragment
clokep Oct 15, 2021
029953a
Proper types for __delete__.
clokep Oct 19, 2021
c980b85
Use Generics for DictProperty descriptors.
clokep Oct 19, 2021
baa90e1
Abstract the valid types to a separate variable.
clokep Oct 19, 2021
4ac4696
Use __setattr__ instead of __set__.
clokep Oct 19, 2021
67ee1fd
Fix type errors from union of EventBase/EventBuilder.
clokep Oct 21, 2021
e40eff8
Review comment: after freeze we return tuples, not lists.
clokep Oct 22, 2021
5d88acd
Merge remote-tracking branch 'origin/develop' into clokep/event-types-2
clokep Oct 27, 2021
0d0b707
Lint.
clokep Oct 27, 2021
39696d7
Fix typo.
clokep Oct 28, 2021
f58609e
Literal from typing extensions.
clokep Oct 28, 2021
d3dd88f
Add note about state_key.
clokep Oct 28, 2021
9ad0659
Properly check for fields during validation.
clokep Oct 28, 2021
2fdcc68
Remove broken __setattr__.
clokep Oct 28, 2021
ac760c7
Lint
clokep Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions synapse/events/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ class DictProperty:
def __init__(self, key: str):
self.key = key

def __get__(self, instance, owner=None):
def __get__(
self,
instance: Optional[Union["_EventInternalMetadata", "EventBase"]],
owner: Optional[Type[Union["_EventInternalMetadata", "EventBase"]]] = None,
clokep marked this conversation as resolved.
Show resolved Hide resolved
) -> Any:
# if the property is accessed as a class property rather than an instance
# property, return the property itself rather than the value
if instance is None:
Expand All @@ -65,10 +69,12 @@ def __get__(self, instance, owner=None):
"'%s' has no '%s' property" % (type(instance), self.key)
) from e1.__context__

def __set__(self, instance, v):
def __set__(
self, instance: Union["_EventInternalMetadata", "EventBase"], v: Any
) -> None:
instance._dict[self.key] = v

def __delete__(self, instance):
def __delete__(self, instance: Any) -> None:
clokep marked this conversation as resolved.
Show resolved Hide resolved
try:
del instance._dict[self.key]
except KeyError as e1:
Expand All @@ -90,7 +96,11 @@ def __init__(self, key: str, default: Any):
super().__init__(key)
self.default = default

def __get__(self, instance, owner=None):
def __get__(
self,
instance: Optional[Union["_EventInternalMetadata", "EventBase"]],
owner: Optional[Type[Union["_EventInternalMetadata", "EventBase"]]] = None,
) -> Any:
if instance is None:
return self
return instance._dict.get(self.key, self.default)
Expand Down Expand Up @@ -243,7 +253,7 @@ def __init__(
redacts: Optional[str] = DefaultDictProperty("redacts", None) # type: ignore[assignment]
room_id: str = DictProperty("room_id") # type: ignore[assignment]
sender: str = DictProperty("sender") # type: ignore[assignment]
state_key = DictProperty("state_key") # type: ignore[assignment]
state_key: str = DictProperty("state_key") # type: ignore[assignment]
clokep marked this conversation as resolved.
Show resolved Hide resolved
type: str = DictProperty("type") # type: ignore[assignment]
user_id: str = DictProperty("sender") # type: ignore[assignment]

Expand Down