mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-08-01 13:26:07 -04:00
Convert room member storage tuples to attrs. (#10629)
Instead of using namedtuples. This helps with asserting type hints and code completion.
This commit is contained in:
parent
6e613a10d0
commit
bec01c0758
7 changed files with 55 additions and 30 deletions
|
@ -14,25 +14,40 @@
|
|||
# limitations under the License.
|
||||
|
||||
import logging
|
||||
from collections import namedtuple
|
||||
from typing import List, Optional, Tuple
|
||||
|
||||
import attr
|
||||
|
||||
from synapse.types import PersistedEventPosition
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
RoomsForUser = namedtuple(
|
||||
"RoomsForUser", ("room_id", "sender", "membership", "event_id", "stream_ordering")
|
||||
)
|
||||
|
||||
GetRoomsForUserWithStreamOrdering = namedtuple(
|
||||
"GetRoomsForUserWithStreamOrdering", ("room_id", "event_pos")
|
||||
)
|
||||
@attr.s(slots=True, frozen=True, weakref_slot=True, auto_attribs=True)
|
||||
class RoomsForUser:
|
||||
room_id: str
|
||||
sender: str
|
||||
membership: str
|
||||
event_id: str
|
||||
stream_ordering: int
|
||||
|
||||
|
||||
# We store this using a namedtuple so that we save about 3x space over using a
|
||||
# dict.
|
||||
ProfileInfo = namedtuple("ProfileInfo", ("avatar_url", "display_name"))
|
||||
@attr.s(slots=True, frozen=True, weakref_slot=True, auto_attribs=True)
|
||||
class GetRoomsForUserWithStreamOrdering:
|
||||
room_id: str
|
||||
event_pos: PersistedEventPosition
|
||||
|
||||
# "members" points to a truncated list of (user_id, event_id) tuples for users of
|
||||
# a given membership type, suitable for use in calculating heroes for a room.
|
||||
# "count" points to the total numberr of users of a given membership type.
|
||||
MemberSummary = namedtuple("MemberSummary", ("members", "count"))
|
||||
|
||||
@attr.s(slots=True, frozen=True, weakref_slot=True, auto_attribs=True)
|
||||
class ProfileInfo:
|
||||
avatar_url: Optional[str]
|
||||
display_name: Optional[str]
|
||||
|
||||
|
||||
@attr.s(slots=True, frozen=True, weakref_slot=True, auto_attribs=True)
|
||||
class MemberSummary:
|
||||
# A truncated list of (user_id, event_id) tuples for users of a given
|
||||
# membership type, suitable for use in calculating heroes for a room.
|
||||
members: List[Tuple[str, str]]
|
||||
# The total number of users of a given membership type.
|
||||
count: int
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue