Accept Collections instead of Lists in EventCreationHandler.create_event

Signed-off-by: Sean Quah <[email protected]>

Author: Sean Quah

synapse/events/builder.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import logging
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Any, Collection, Dict, List, Optional, Tuple, Union
 
 import attr
 from signedjson.types import SigningKey
@@ -101,8 +101,8 @@ def is_state(self) -> bool:
 
     async def build(
         self,
-        prev_event_ids: List[str],
-        auth_event_ids: Optional[List[str]],
+        prev_event_ids: Collection[str],
+        auth_event_ids: Optional[Collection[str]],
         depth: Optional[int] = None,
     ) -> EventBase:
         """Transform into a fully signed and hashed event
@@ -135,8 +135,8 @@ async def build(
             auth_events = await self._store.add_event_hashes(auth_event_ids)
             prev_events = await self._store.add_event_hashes(prev_event_ids)
         else:
-            auth_events = auth_event_ids
-            prev_events = prev_event_ids
+            auth_events = list(auth_event_ids)
+            prev_events = list(prev_event_ids)
 
         # Otherwise, progress the depth as normal
         if depth is None:

synapse/handlers/message.py

@@ -17,7 +17,7 @@
 import logging
 import random
 from http import HTTPStatus
-from typing import TYPE_CHECKING, Any, Dict, List, Mapping, Optional, Tuple
+from typing import TYPE_CHECKING, Any, Collection, Dict, List, Mapping, Optional, Tuple
 
 from canonicaljson import encode_canonical_json
 
@@ -487,9 +487,9 @@ async def create_event(
         event_dict: dict,
         txn_id: Optional[str] = None,
         allow_no_prev_events: bool = False,
-        prev_event_ids: Optional[List[str]] = None,
-        auth_event_ids: Optional[List[str]] = None,
-        state_event_ids: Optional[List[str]] = None,
+        prev_event_ids: Optional[Collection[str]] = None,
+        auth_event_ids: Optional[Collection[str]] = None,
+        state_event_ids: Optional[Collection[str]] = None,
         require_consent: bool = True,
         outlier: bool = False,
         historical: bool = False,
@@ -901,9 +901,9 @@ async def create_new_client_event(
         builder: EventBuilder,
         requester: Optional[Requester] = None,
         allow_no_prev_events: bool = False,
-        prev_event_ids: Optional[List[str]] = None,
-        auth_event_ids: Optional[List[str]] = None,
-        state_event_ids: Optional[List[str]] = None,
+        prev_event_ids: Optional[Collection[str]] = None,
+        auth_event_ids: Optional[Collection[str]] = None,
+        state_event_ids: Optional[Collection[str]] = None,
         depth: Optional[int] = None,
     ) -> Tuple[EventBase, EventContext]:
         """Create a new event for a local client

synapse/storage/databases/main/event_federation.py

@@ -788,7 +788,7 @@ def get_insertion_event_backward_extremities_in_room_txn(txn, room_id):
             room_id,
         )
 
-    async def get_max_depth_of(self, event_ids: List[str]) -> Tuple[str, int]:
+    async def get_max_depth_of(self, event_ids: Iterable[str]) -> Tuple[str, int]:
         """Returns the event ID and depth for the event that has the max depth from a set of event IDs
 
         Args:
@@ -817,7 +817,7 @@ async def get_max_depth_of(self, event_ids: List[str]) -> Tuple[str, int]:
 
             return max_depth_event_id, current_max_depth
 
-    async def get_min_depth_of(self, event_ids: List[str]) -> Tuple[str, int]:
+    async def get_min_depth_of(self, event_ids: Iterable[str]) -> Tuple[str, int]:
         """Returns the event ID and depth for the event that has the min depth from a set of event IDs
 
         Args: