118 lines
2.4 KiB
Python
118 lines
2.4 KiB
Python
# Slixmpp: The Slick XMPP Library
|
|
# Copyright © 2021 Mathieu Pasquet <mathieui@mathieui.net>
|
|
# This file is part of Slixmpp.
|
|
# See the file LICENSE for copying permission.
|
|
|
|
"""
|
|
This file contains boilerplate to define types relevant to slixmpp.
|
|
"""
|
|
|
|
from typing import (
|
|
Optional,
|
|
Union,
|
|
)
|
|
|
|
try:
|
|
from typing import (
|
|
Literal,
|
|
TypedDict,
|
|
Protocol,
|
|
)
|
|
except ImportError:
|
|
from typing_extensions import (
|
|
Literal,
|
|
TypedDict,
|
|
Protocol,
|
|
)
|
|
|
|
from slixmpp.jid import JID
|
|
|
|
PresenceTypes = Literal[
|
|
'error', 'probe', 'subscribe', 'subscribed',
|
|
'unavailable', 'unsubscribe', 'unsubscribed',
|
|
]
|
|
|
|
PresenceShows = Literal[
|
|
'away', 'chat', 'dnd', 'xa',
|
|
]
|
|
|
|
MessageTypes = Literal[
|
|
'chat', 'error', 'groupchat',
|
|
'headline', 'normal',
|
|
]
|
|
|
|
IqTypes = Literal[
|
|
"error", "get", "set", "result",
|
|
]
|
|
|
|
MucRole = Literal[
|
|
'moderator', 'participant', 'visitor', 'none'
|
|
]
|
|
|
|
MucAffiliation = Literal[
|
|
'outcast', 'member', 'admin', 'owner', 'none'
|
|
]
|
|
|
|
|
|
class PresenceArgs(TypedDict, total=False):
|
|
pfrom: JID
|
|
pto: JID
|
|
pshow: PresenceShows
|
|
ptype: PresenceTypes
|
|
pstatus: str
|
|
|
|
|
|
class MucRoomItem(TypedDict, total=False):
|
|
jid: JID
|
|
role: MucRole
|
|
affiliation: MucAffiliation
|
|
show: Optional[PresenceShows]
|
|
status: str
|
|
alt_nick: str
|
|
|
|
|
|
MucRoomItemKeys = Literal[
|
|
'jid', 'role', 'affiliation', 'show', 'status', 'alt_nick',
|
|
]
|
|
|
|
OptJid = Optional[JID]
|
|
JidStr = Union[str, JID]
|
|
OptJidStr = Optional[Union[str, JID]]
|
|
|
|
MAMDefault = Literal['always', 'never', 'roster']
|
|
|
|
FilterString = Literal['in', 'out', 'out_sync']
|
|
|
|
ErrorTypes = Literal["modify", "cancel", "auth", "wait", "cancel"]
|
|
|
|
ErrorConditions = Literal[
|
|
"bad-request",
|
|
"conflict",
|
|
"feature-not-implemented",
|
|
"forbidden",
|
|
"gone",
|
|
"internal-server-error",
|
|
"item-not-found",
|
|
"jid-malformed",
|
|
"not-acceptable",
|
|
"not-allowed",
|
|
"not-authorized",
|
|
"payment-required",
|
|
"recipient-unavailable",
|
|
"redirect",
|
|
"registration-required",
|
|
"remote-server-not-found",
|
|
"remote-server-timeout",
|
|
"resource-constraint",
|
|
"service-unavailable",
|
|
"subscription-required",
|
|
"undefined-condition",
|
|
"unexpected-request",
|
|
]
|
|
|
|
__all__ = [
|
|
'Protocol', 'TypedDict', 'Literal', 'OptJid', 'OptJidStr', 'JidStr', 'MAMDefault',
|
|
'PresenceTypes', 'PresenceShows', 'MessageTypes', 'IqTypes', 'MucRole',
|
|
'MucAffiliation', 'FilterString', 'ErrorConditions', 'ErrorTypes'
|
|
]
|