Class PrivateChat

ehforwarderbot/chat.py:635–678

A private chat, where usually only the User Themself and the other participant are in the chat. Chat bots SHOULD also be categorized under this type. There SHOULD only be at most one non-system member of the chat apart from the User Themself, otherwise it might lead to unintended be

class PrivateChat(Chat):
    """A private chat, where usually only the User Themself and the other
    participant are in the chat. Chat bots SHOULD also be categorized under this
    type.

    There SHOULD only be at most one non-system member of the chat apart from
    the User Themself, otherwise it might lead to unintended behavior.

    This object is by default initialized with the other participant as its
    member.

    If the ``with_self`` argument is ``True`` (which is the default setting),
    the User Themself would also be initialized as a member of the chat.

    Args:
        other: the other participant of the chat as a member

    Note:
        ``PrivateChat`` objects are picklable, thus it is RECOMMENDED
        to keep any object of its subclass also picklable.
    """
    other: ChatMember

    def __init__(self, *, channel: Optional[SlaveChannel] = None, middleware: Optional[Middleware] = None,
                 module_name: str = "", channel_emoji: str = "", module_id: ModuleID = ModuleID(""), name: str = "",
                 alias: Optional[str] = None, id: ChatID = ChatID(""), uid: ChatID = ChatID(""),
                 vendor_specific: Dict[str, Any] = None,
                 description: str = "", notification: ChatNotificationState = ChatNotificationState.ALL,
                 with_self: bool = True, other_is_self: bool = False):
        super().__init__(channel=channel, middleware=middleware, module_name=module_name, channel_emoji=channel_emoji,
                         module_id=module_id, name=name, alias=alias, id=id, uid=uid, vendor_specific=vendor_specific,
                         description=description, notification=notification, with_self=with_self)
        if other_is_self and with_self:
            assert self.self is not None
            self.other = self.self
        else:
            self.other = self.add_member(name=name, alias=alias, uid=uid, vendor_specific=vendor_specific,
                                         description=description)
        self.verify()

    def verify(self):
        super().verify()
        assert all(isinstance(member, ChatMember) for member in self.members), \
            f"Some members of this chat is not a valid one: {self.members!r}"


class SystemChat(Chat):