matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add explicit types to variables in Message types

Browse Source
This commit is contained in:
Rapptz 2021-06-29 23:55:19 -04:00
parent ea1d423904
commit 44d1d29708
1 changed files with 47 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
discord/message.py
View File

@ -65,9 +65,12 @@ if TYPE_CHECKING:
from .types.embed import Embed as EmbedPayload from .types.embed import Embed as EmbedPayload
from .abc import Snowflake from .abc import Snowflake
from .abc import GuildChannel from .abc import GuildChannel
from .components import Component
from .state import ConnectionState from .state import ConnectionState
from .channel import TextChannel, GroupChannel, DMChannel from .channel import TextChannel, GroupChannel, DMChannel
from .mentions import AllowedMentions from .mentions import AllowedMentions
from .user import User
from .role import Role
from .ui.view import View from .ui.view import View
EmojiInputType = Union[Emoji, PartialEmoji, str] EmojiInputType = Union[Emoji, PartialEmoji, str]
@ -149,15 +152,15 @@ class Attachment(Hashable):
__slots__ = ('id', 'size', 'height', 'width', 'filename', 'url', 'proxy_url', '_http', 'content_type') __slots__ = ('id', 'size', 'height', 'width', 'filename', 'url', 'proxy_url', '_http', 'content_type')
def __init__(self, *, data: AttachmentPayload, state: ConnectionState): def __init__(self, *, data: AttachmentPayload, state: ConnectionState):
self.id = int(data['id']) self.id: int = int(data['id'])
self.size = data['size'] self.size: int = data['size']
self.height = data.get('height') self.height: Optional[int] = data.get('height')
self.width = data.get('width') self.width: Optional[int] = data.get('width')
self.filename = data['filename'] self.filename: str = data['filename']
self.url = data.get('url') self.url: str = data.get('url')
self.proxy_url = data.get('proxy_url') self.proxy_url: str = data.get('proxy_url')
self._http = state.http self._http = state.http
self.content_type = data.get('content_type') self.content_type: Optional[str] = data.get('content_type')
def is_spoiler(self) -> bool: def is_spoiler(self) -> bool:
""":class:`bool`: Whether this attachment contains a spoiler.""" """:class:`bool`: Whether this attachment contains a spoiler."""
@ -327,7 +330,7 @@ class DeletedReferencedMessage:
__slots__ = ('_parent',) __slots__ = ('_parent',)
def __init__(self, parent: MessageReference): def __init__(self, parent: MessageReference):
self._parent = parent self._parent: MessageReference = parent
def __repr__(self) -> str: def __repr__(self) -> str:
return f"<DeletedReferencedMessage id={self.id} channel_id={self.channel_id} guild_id={self.guild_id!r}>" return f"<DeletedReferencedMessage id={self.id} channel_id={self.channel_id} guild_id={self.guild_id!r}>"
@ -387,10 +390,10 @@ class MessageReference:
def __init__(self, *, message_id: int, channel_id: int, guild_id: Optional[int] = None, fail_if_not_exists: bool = True): def __init__(self, *, message_id: int, channel_id: int, guild_id: Optional[int] = None, fail_if_not_exists: bool = True):
self._state: Optional[ConnectionState] = None self._state: Optional[ConnectionState] = None
self.resolved: Optional[Union[Message, DeletedReferencedMessage]] = None self.resolved: Optional[Union[Message, DeletedReferencedMessage]] = None
self.message_id = message_id self.message_id: int = message_id
self.channel_id = channel_id self.channel_id: int = channel_id
self.guild_id = guild_id self.guild_id: Optional[int] = guild_id
self.fail_if_not_exists = fail_if_not_exists self.fail_if_not_exists: bool = fail_if_not_exists
@classmethod @classmethod
def with_state(cls, state: ConnectionState, data: MessageReferencePayload) -> MessageReference: def with_state(cls, state: ConnectionState, data: MessageReferencePayload) -> MessageReference:
@ -509,7 +512,7 @@ class Message(Hashable):
private channel or the user has the left the guild, then it is a :class:`User` instead. private channel or the user has the left the guild, then it is a :class:`User` instead.
content: :class:`str` content: :class:`str`
The actual contents of the message. The actual contents of the message.
nonce: Union[:class:`str`, :class:`int`] nonce: Optional[Union[:class:`str`, :class:`int`]]
The value used by the discord guild and the client to verify that the message is successfully sent. The value used by the discord guild and the client to verify that the message is successfully sent.
This is not stored long term within Discord's servers and is only used ephemerally. This is not stored long term within Discord's servers and is only used ephemerally.
embeds: List[:class:`Embed`] embeds: List[:class:`Embed`]
@ -630,6 +633,11 @@ class Message(Hashable):
if TYPE_CHECKING: if TYPE_CHECKING:
_HANDLERS: ClassVar[List[Tuple[str, Callable[..., None]]]] _HANDLERS: ClassVar[List[Tuple[str, Callable[..., None]]]]
_CACHED_SLOTS: ClassVar[List[str]] _CACHED_SLOTS: ClassVar[List[str]]
guild: Optional[Guild]
ref: Optional[MessageReference]
mentions: List[Union[User, Member]]
author: Union[User, Member]
role_mentions: List[Role]
def __init__( def __init__(
self, self,
@ -638,28 +646,28 @@ class Message(Hashable):
channel: Union[TextChannel, Thread, DMChannel, GroupChannel], channel: Union[TextChannel, Thread, DMChannel, GroupChannel],
data: MessagePayload, data: MessagePayload,
): ):
self._state = state self._state: ConnectionState = state
self.id = int(data['id']) self.id: int = int(data['id'])
self.webhook_id = utils._get_as_snowflake(data, 'webhook_id') self.webhook_id: Optional[int] = utils._get_as_snowflake(data, 'webhook_id')
self.reactions = [Reaction(message=self, data=d) for d in data.get('reactions', [])] self.reactions: List[Reaction] = [Reaction(message=self, data=d) for d in data.get('reactions', [])]
self.attachments = [Attachment(data=a, state=self._state) for a in data['attachments']] self.attachments: List[Attachment] = [Attachment(data=a, state=self._state) for a in data['attachments']]
self.embeds = [Embed.from_dict(a) for a in data['embeds']] self.embeds: List[Embed] = [Embed.from_dict(a) for a in data['embeds']]
self.application = data.get('application') self.application: Optional[MessageApplicationPayload] = data.get('application')
self.activity = data.get('activity') self.activity: Optional[MessageActivityPayload] = data.get('activity')
self.channel = channel self.channel: Union[TextChannel, Thread, DMChannel, GroupChannel] = channel
self._edited_timestamp = utils.parse_time(data['edited_timestamp']) self._edited_timestamp: Optional[datetime.datetime] = utils.parse_time(data['edited_timestamp'])
self.type = try_enum(MessageType, data['type']) self.type: MessageType = try_enum(MessageType, data['type'])
self.pinned = data['pinned'] self.pinned: bool = data['pinned']
self.flags = MessageFlags._from_value(data.get('flags', 0)) self.flags: MessageFlags = MessageFlags._from_value(data.get('flags', 0))
self.mention_everyone = data['mention_everyone'] self.mention_everyone: bool = data['mention_everyone']
self.tts = data['tts'] self.tts: bool = data['tts']
self.content = data['content'] self.content: str = data['content']
self.nonce = data.get('nonce') self.nonce: Optional[Union[int, str]] = data.get('nonce')
self.stickers = [Sticker(data=d, state=state) for d in data.get('stickers', [])] self.stickers: List[Sticker] = [Sticker(data=d, state=state) for d in data.get('stickers', [])]
self.components = [_component_factory(d) for d in data.get('components', [])] self.components: List[Component] = [_component_factory(d) for d in data.get('components', [])]
try: try:
self.guild = channel.guild self.guild = channel.guild # type: ignore
except AttributeError: except AttributeError:
self.guild = state._get_guild(utils._get_as_snowflake(data, 'guild_id')) self.guild = state._get_guild(utils._get_as_snowflake(data, 'guild_id'))
@ -685,7 +693,7 @@ class Message(Hashable):
ref.resolved = self.__class__(channel=chan, data=resolved, state=state) ref.resolved = self.__class__(channel=chan, data=resolved, state=state)
for handler in ('author', 'member', 'mentions', 'mention_roles', 'flags'): for handler in ('author', 'member', 'mentions', 'mention_roles'):
try: try:
getattr(self, f'_handle_{handler}')(data[handler]) getattr(self, f'_handle_{handler}')(data[handler])
except KeyError: except KeyError:
@ -775,7 +783,7 @@ class Message(Hashable):
def _handle_edited_timestamp(self, value: str) -> None: def _handle_edited_timestamp(self, value: str) -> None:
self._edited_timestamp = utils.parse_time(value) self._edited_timestamp = utils.parse_time(value)
def _handle_pinned(self, value: int) -> None: def _handle_pinned(self, value: bool) -> None:
self.pinned = value self.pinned = value
def _handle_flags(self, value: int) -> None: def _handle_flags(self, value: int) -> None:
@ -1589,9 +1597,9 @@ class PartialMessage(Hashable):
if channel.type not in (ChannelType.text, ChannelType.news, ChannelType.private): if channel.type not in (ChannelType.text, ChannelType.news, ChannelType.private):
raise TypeError(f'Expected TextChannel or DMChannel not {type(channel)!r}') raise TypeError(f'Expected TextChannel or DMChannel not {type(channel)!r}')
self.channel = channel self.channel: Union[TextChannel, DMChannel] = channel
self._state = channel._state self._state: ConnectionState = channel._state
self.id = id self.id: int = id
def _update(self, data) -> None: def _update(self, data) -> None:
# This is used for duck typing purposes. # This is used for duck typing purposes.