Developer Anonymous
11 months ago
92 changed files with 7371 additions and 3183 deletions
@ -0,0 +1,207 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
from __future__ import annotations |
|||
from typing import TYPE_CHECKING, ClassVar, List, Optional, Sequence |
|||
|
|||
__all__ = ( |
|||
'AppInstallationType', |
|||
'AppCommandContext', |
|||
) |
|||
|
|||
if TYPE_CHECKING: |
|||
from typing_extensions import Self |
|||
from ..types.interactions import InteractionContextType, InteractionInstallationType |
|||
|
|||
|
|||
class AppInstallationType: |
|||
r"""Represents the installation location of an application command. |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Parameters |
|||
----------- |
|||
guild: Optional[:class:`bool`] |
|||
Whether the integration is a guild install. |
|||
user: Optional[:class:`bool`] |
|||
Whether the integration is a user install. |
|||
""" |
|||
|
|||
__slots__ = ('_guild', '_user') |
|||
|
|||
GUILD: ClassVar[int] = 0 |
|||
USER: ClassVar[int] = 1 |
|||
|
|||
def __init__(self, *, guild: Optional[bool] = None, user: Optional[bool] = None): |
|||
self._guild: Optional[bool] = guild |
|||
self._user: Optional[bool] = user |
|||
|
|||
@property |
|||
def guild(self) -> bool: |
|||
""":class:`bool`: Whether the integration is a guild install.""" |
|||
return bool(self._guild) |
|||
|
|||
@guild.setter |
|||
def guild(self, value: bool) -> None: |
|||
self._guild = bool(value) |
|||
|
|||
@property |
|||
def user(self) -> bool: |
|||
""":class:`bool`: Whether the integration is a user install.""" |
|||
return bool(self._user) |
|||
|
|||
@user.setter |
|||
def user(self, value: bool) -> None: |
|||
self._user = bool(value) |
|||
|
|||
def merge(self, other: AppInstallationType) -> AppInstallationType: |
|||
# Merging is similar to AllowedMentions where `self` is the base |
|||
# and the `other` is the override preference |
|||
guild = self._guild if other._guild is None else other._guild |
|||
user = self._user if other._user is None else other._user |
|||
return AppInstallationType(guild=guild, user=user) |
|||
|
|||
def _is_unset(self) -> bool: |
|||
return all(x is None for x in (self._guild, self._user)) |
|||
|
|||
def _merge_to_array(self, other: Optional[AppInstallationType]) -> Optional[List[InteractionInstallationType]]: |
|||
result = self.merge(other) if other is not None else self |
|||
if result._is_unset(): |
|||
return None |
|||
return result.to_array() |
|||
|
|||
@classmethod |
|||
def _from_value(cls, value: Sequence[InteractionInstallationType]) -> Self: |
|||
self = cls() |
|||
for x in value: |
|||
if x == cls.GUILD: |
|||
self._guild = True |
|||
elif x == cls.USER: |
|||
self._user = True |
|||
return self |
|||
|
|||
def to_array(self) -> List[InteractionInstallationType]: |
|||
values = [] |
|||
if self._guild: |
|||
values.append(self.GUILD) |
|||
if self._user: |
|||
values.append(self.USER) |
|||
return values |
|||
|
|||
|
|||
class AppCommandContext: |
|||
r"""Wraps up the Discord :class:`~discord.app_commands.Command` execution context. |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Parameters |
|||
----------- |
|||
guild: Optional[:class:`bool`] |
|||
Whether the context allows usage in a guild. |
|||
dm_channel: Optional[:class:`bool`] |
|||
Whether the context allows usage in a DM channel. |
|||
private_channel: Optional[:class:`bool`] |
|||
Whether the context allows usage in a DM or a GDM channel. |
|||
""" |
|||
|
|||
GUILD: ClassVar[int] = 0 |
|||
DM_CHANNEL: ClassVar[int] = 1 |
|||
PRIVATE_CHANNEL: ClassVar[int] = 2 |
|||
|
|||
__slots__ = ('_guild', '_dm_channel', '_private_channel') |
|||
|
|||
def __init__( |
|||
self, |
|||
*, |
|||
guild: Optional[bool] = None, |
|||
dm_channel: Optional[bool] = None, |
|||
private_channel: Optional[bool] = None, |
|||
): |
|||
self._guild: Optional[bool] = guild |
|||
self._dm_channel: Optional[bool] = dm_channel |
|||
self._private_channel: Optional[bool] = private_channel |
|||
|
|||
@property |
|||
def guild(self) -> bool: |
|||
""":class:`bool`: Whether the context allows usage in a guild.""" |
|||
return bool(self._guild) |
|||
|
|||
@guild.setter |
|||
def guild(self, value: bool) -> None: |
|||
self._guild = bool(value) |
|||
|
|||
@property |
|||
def dm_channel(self) -> bool: |
|||
""":class:`bool`: Whether the context allows usage in a DM channel.""" |
|||
return bool(self._dm_channel) |
|||
|
|||
@dm_channel.setter |
|||
def dm_channel(self, value: bool) -> None: |
|||
self._dm_channel = bool(value) |
|||
|
|||
@property |
|||
def private_channel(self) -> bool: |
|||
""":class:`bool`: Whether the context allows usage in a DM or a GDM channel.""" |
|||
return bool(self._private_channel) |
|||
|
|||
@private_channel.setter |
|||
def private_channel(self, value: bool) -> None: |
|||
self._private_channel = bool(value) |
|||
|
|||
def merge(self, other: AppCommandContext) -> AppCommandContext: |
|||
guild = self._guild if other._guild is None else other._guild |
|||
dm_channel = self._dm_channel if other._dm_channel is None else other._dm_channel |
|||
private_channel = self._private_channel if other._private_channel is None else other._private_channel |
|||
return AppCommandContext(guild=guild, dm_channel=dm_channel, private_channel=private_channel) |
|||
|
|||
def _is_unset(self) -> bool: |
|||
return all(x is None for x in (self._guild, self._dm_channel, self._private_channel)) |
|||
|
|||
def _merge_to_array(self, other: Optional[AppCommandContext]) -> Optional[List[InteractionContextType]]: |
|||
result = self.merge(other) if other is not None else self |
|||
if result._is_unset(): |
|||
return None |
|||
return result.to_array() |
|||
|
|||
@classmethod |
|||
def _from_value(cls, value: Sequence[InteractionContextType]) -> Self: |
|||
self = cls() |
|||
for x in value: |
|||
if x == cls.GUILD: |
|||
self._guild = True |
|||
elif x == cls.DM_CHANNEL: |
|||
self._dm_channel = True |
|||
elif x == cls.PRIVATE_CHANNEL: |
|||
self._private_channel = True |
|||
return self |
|||
|
|||
def to_array(self) -> List[InteractionContextType]: |
|||
values = [] |
|||
if self._guild: |
|||
values.append(self.GUILD) |
|||
if self._dm_channel: |
|||
values.append(self.DM_CHANNEL) |
|||
if self._private_channel: |
|||
values.append(self.PRIVATE_CHANNEL) |
|||
return values |
|||
@ -0,0 +1,576 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
from __future__ import annotations |
|||
|
|||
|
|||
from typing import Optional, List, TYPE_CHECKING, Union, AsyncIterator, Dict |
|||
|
|||
import datetime |
|||
|
|||
from .enums import PollLayoutType, try_enum |
|||
from . import utils |
|||
from .emoji import PartialEmoji, Emoji |
|||
from .user import User |
|||
from .object import Object |
|||
from .errors import ClientException |
|||
|
|||
if TYPE_CHECKING: |
|||
from typing_extensions import Self |
|||
|
|||
from .message import Message |
|||
from .abc import Snowflake |
|||
from .state import ConnectionState |
|||
from .member import Member |
|||
|
|||
from .types.poll import ( |
|||
PollCreate as PollCreatePayload, |
|||
PollMedia as PollMediaPayload, |
|||
PollAnswerCount as PollAnswerCountPayload, |
|||
Poll as PollPayload, |
|||
PollAnswerWithID as PollAnswerWithIDPayload, |
|||
PollResult as PollResultPayload, |
|||
PollAnswer as PollAnswerPayload, |
|||
) |
|||
|
|||
|
|||
__all__ = ( |
|||
'Poll', |
|||
'PollAnswer', |
|||
'PollMedia', |
|||
) |
|||
|
|||
MISSING = utils.MISSING |
|||
PollMediaEmoji = Union[PartialEmoji, Emoji, str] |
|||
|
|||
|
|||
class PollMedia: |
|||
"""Represents the poll media for a poll item. |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Attributes |
|||
---------- |
|||
text: :class:`str` |
|||
The displayed text. |
|||
emoji: Optional[Union[:class:`PartialEmoji`, :class:`Emoji`]] |
|||
The attached emoji for this media. This is only valid for poll answers. |
|||
""" |
|||
|
|||
__slots__ = ('text', 'emoji') |
|||
|
|||
def __init__(self, /, text: str, emoji: Optional[PollMediaEmoji] = None) -> None: |
|||
self.text: str = text |
|||
self.emoji: Optional[Union[PartialEmoji, Emoji]] = PartialEmoji.from_str(emoji) if isinstance(emoji, str) else emoji |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<PollMedia text={self.text!r} emoji={self.emoji!r}>' |
|||
|
|||
def to_dict(self) -> PollMediaPayload: |
|||
payload: PollMediaPayload = {'text': self.text} |
|||
|
|||
if self.emoji is not None: |
|||
payload['emoji'] = self.emoji._to_partial().to_dict() |
|||
|
|||
return payload |
|||
|
|||
@classmethod |
|||
def from_dict(cls, *, data: PollMediaPayload) -> Self: |
|||
emoji = data.get('emoji') |
|||
|
|||
if emoji: |
|||
return cls(text=data['text'], emoji=PartialEmoji.from_dict(emoji)) |
|||
return cls(text=data['text']) |
|||
|
|||
|
|||
class PollAnswer: |
|||
"""Represents a poll's answer. |
|||
|
|||
.. container:: operations |
|||
|
|||
.. describe:: str(x) |
|||
|
|||
Returns this answer's text, if any. |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Attributes |
|||
---------- |
|||
id: :class:`int` |
|||
The ID of this answer. |
|||
media: :class:`PollMedia` |
|||
The display data for this answer. |
|||
self_voted: :class:`bool` |
|||
Whether the current user has voted to this answer or not. |
|||
""" |
|||
|
|||
__slots__ = ('media', 'id', '_state', '_message', '_vote_count', 'self_voted', '_poll') |
|||
|
|||
def __init__( |
|||
self, |
|||
*, |
|||
message: Optional[Message], |
|||
poll: Poll, |
|||
data: PollAnswerWithIDPayload, |
|||
) -> None: |
|||
self.media: PollMedia = PollMedia.from_dict(data=data['poll_media']) |
|||
self.id: int = int(data['answer_id']) |
|||
self._message: Optional[Message] = message |
|||
self._state: Optional[ConnectionState] = message._state if message else None |
|||
self._vote_count: int = 0 |
|||
self.self_voted: bool = False |
|||
self._poll: Poll = poll |
|||
|
|||
def _handle_vote_event(self, added: bool, self_voted: bool) -> None: |
|||
if added: |
|||
self._vote_count += 1 |
|||
else: |
|||
self._vote_count -= 1 |
|||
self.self_voted = self_voted |
|||
|
|||
def _update_with_results(self, payload: PollAnswerCountPayload) -> None: |
|||
self._vote_count = int(payload['count']) |
|||
self.self_voted = payload['me_voted'] |
|||
|
|||
def __str__(self) -> str: |
|||
return self.media.text |
|||
|
|||
def __repr__(self) -> str: |
|||
return f'<PollAnswer id={self.id} media={self.media!r}>' |
|||
|
|||
@classmethod |
|||
def from_params( |
|||
cls, |
|||
id: int, |
|||
text: str, |
|||
emoji: Optional[PollMediaEmoji] = None, |
|||
*, |
|||
poll: Poll, |
|||
message: Optional[Message], |
|||
) -> Self: |
|||
poll_media: PollMediaPayload = {'text': text} |
|||
if emoji is not None: |
|||
emoji = PartialEmoji.from_str(emoji) if isinstance(emoji, str) else emoji._to_partial() |
|||
emoji_data = emoji.to_dict() |
|||
# No need to remove animated key as it will be ignored |
|||
poll_media['emoji'] = emoji_data |
|||
|
|||
payload: PollAnswerWithIDPayload = {'answer_id': id, 'poll_media': poll_media} |
|||
|
|||
return cls(data=payload, message=message, poll=poll) |
|||
|
|||
@property |
|||
def text(self) -> str: |
|||
""":class:`str`: Returns this answer's displayed text.""" |
|||
return self.media.text |
|||
|
|||
@property |
|||
def emoji(self) -> Optional[Union[PartialEmoji, Emoji]]: |
|||
"""Optional[Union[:class:`Emoji`, :class:`PartialEmoji`]]: Returns this answer's displayed |
|||
emoji, if any. |
|||
""" |
|||
return self.media.emoji |
|||
|
|||
@property |
|||
def vote_count(self) -> int: |
|||
""":class:`int`: Returns an approximate count of votes for this answer. |
|||
|
|||
If the poll is finished, the count is exact. |
|||
""" |
|||
return self._vote_count |
|||
|
|||
@property |
|||
def poll(self) -> Poll: |
|||
""":class:`Poll`: Returns the parent poll of this answer.""" |
|||
return self._poll |
|||
|
|||
def _to_dict(self) -> PollAnswerPayload: |
|||
return { |
|||
'poll_media': self.media.to_dict(), |
|||
} |
|||
|
|||
async def voters( |
|||
self, *, limit: Optional[int] = None, after: Optional[Snowflake] = None |
|||
) -> AsyncIterator[Union[User, Member]]: |
|||
"""Returns an :term:`asynchronous iterator` representing the users that have voted on this answer. |
|||
|
|||
The ``after`` parameter must represent a user |
|||
and meet the :class:`abc.Snowflake` abc. |
|||
|
|||
This can only be called when the parent poll was sent to a message. |
|||
|
|||
Examples |
|||
-------- |
|||
|
|||
Usage :: |
|||
|
|||
async for voter in poll_answer.voters(): |
|||
print(f'{voter} has voted for {poll_answer}!') |
|||
|
|||
Flattening into a list: :: |
|||
|
|||
voters = [voter async for voter in poll_answer.voters()] |
|||
# voters is now a list of User |
|||
|
|||
Parameters |
|||
---------- |
|||
limit: Optional[:class:`int`] |
|||
The maximum number of results to return. |
|||
If not provided, returns all the users who |
|||
voted on this poll answer. |
|||
after: Optional[:class:`abc.Snowflake`] |
|||
For pagination, voters are sorted by member. |
|||
|
|||
Raises |
|||
------ |
|||
HTTPException |
|||
Retrieving the users failed. |
|||
|
|||
Yields |
|||
------ |
|||
Union[:class:`User`, :class:`Member`] |
|||
The member (if retrievable) or the user that has voted |
|||
on this poll answer. The case where it can be a :class:`Member` |
|||
is in a guild message context. Sometimes it can be a :class:`User` |
|||
if the member has left the guild or if the member is not cached. |
|||
""" |
|||
|
|||
if not self._message or not self._state: # Make type checker happy |
|||
raise ClientException('You cannot fetch users to a poll not sent with a message') |
|||
|
|||
if limit is None: |
|||
if not self._message.poll: |
|||
limit = 100 |
|||
else: |
|||
limit = self.vote_count or 100 |
|||
|
|||
while limit > 0: |
|||
retrieve = min(limit, 100) |
|||
|
|||
message = self._message |
|||
guild = self._message.guild |
|||
state = self._state |
|||
after_id = after.id if after else None |
|||
|
|||
data = await state.http.get_poll_answer_voters( |
|||
message.channel.id, message.id, self.id, after=after_id, limit=retrieve |
|||
) |
|||
users = data['users'] |
|||
|
|||
if len(users) == 0: |
|||
# No more voters to fetch, terminate loop |
|||
break |
|||
|
|||
limit -= len(users) |
|||
after = Object(id=int(users[-1]['id'])) |
|||
|
|||
if not guild or isinstance(guild, Object): |
|||
for raw_user in reversed(users): |
|||
yield User(state=self._state, data=raw_user) |
|||
continue |
|||
|
|||
for raw_member in reversed(users): |
|||
member_id = int(raw_member['id']) |
|||
member = guild.get_member(member_id) |
|||
|
|||
yield member or User(state=self._state, data=raw_member) |
|||
|
|||
|
|||
class Poll: |
|||
"""Represents a message's Poll. |
|||
|
|||
.. versionadded:: 2.4 |
|||
|
|||
Parameters |
|||
---------- |
|||
question: Union[:class:`PollMedia`, :class:`str`] |
|||
The poll's displayed question. The text can be up to 300 characters. |
|||
duration: :class:`datetime.timedelta` |
|||
The duration of the poll. Duration must be in hours. |
|||
multiple: :class:`bool` |
|||
Whether users are allowed to select more than one answer. |
|||
Defaults to ``False``. |
|||
layout_type: :class:`PollLayoutType` |
|||
The layout type of the poll. Defaults to :attr:`PollLayoutType.default`. |
|||
""" |
|||
|
|||
__slots__ = ( |
|||
'multiple', |
|||
'_answers', |
|||
'duration', |
|||
'layout_type', |
|||
'_question_media', |
|||
'_message', |
|||
'_expiry', |
|||
'_finalized', |
|||
'_state', |
|||
) |
|||
|
|||
def __init__( |
|||
self, |
|||
question: Union[PollMedia, str], |
|||
duration: datetime.timedelta, |
|||
*, |
|||
multiple: bool = False, |
|||
layout_type: PollLayoutType = PollLayoutType.default, |
|||
) -> None: |
|||
self._question_media: PollMedia = PollMedia(text=question, emoji=None) if isinstance(question, str) else question |
|||
self._answers: Dict[int, PollAnswer] = {} |
|||
self.duration: datetime.timedelta = duration |
|||
|
|||
self.multiple: bool = multiple |
|||
self.layout_type: PollLayoutType = layout_type |
|||
|
|||
# NOTE: These attributes are set manually when calling |
|||
# _from_data, so it should be ``None`` now. |
|||
self._message: Optional[Message] = None |
|||
self._state: Optional[ConnectionState] = None |
|||
self._finalized: bool = False |
|||
self._expiry: Optional[datetime.datetime] = None |
|||
|
|||
def _update(self, message: Message) -> None: |
|||
self._state = message._state |
|||
self._message = message |
|||
|
|||
if not message.poll: |
|||
return |
|||
|
|||
# The message's poll contains the more up to date data. |
|||
self._expiry = message.poll.expires_at |
|||
self._finalized = message.poll._finalized |
|||
|
|||
def _update_results(self, data: PollResultPayload) -> None: |
|||
self._finalized = data['is_finalized'] |
|||
|
|||
for count in data['answer_counts']: |
|||
answer = self.get_answer(int(count['id'])) |
|||
if not answer: |
|||
continue |
|||
|
|||
answer._update_with_results(count) |
|||
|
|||
def _handle_vote(self, answer_id: int, added: bool, self_voted: bool = False): |
|||
answer = self.get_answer(answer_id) |
|||
if not answer: |
|||
return |
|||
|
|||
answer._handle_vote_event(added, self_voted) |
|||
|
|||
@classmethod |
|||
def _from_data(cls, *, data: PollPayload, message: Message, state: ConnectionState) -> Self: |
|||
multiselect = data.get('allow_multiselect', False) |
|||
layout_type = try_enum(PollLayoutType, data.get('layout_type', 1)) |
|||
question_data = data.get('question') |
|||
question = question_data.get('text') |
|||
expiry = utils.parse_time(data['expiry']) # If obtained via API, then expiry is set. |
|||
duration = expiry - message.created_at |
|||
# self.created_at = message.created_at |
|||
# duration = self.created_at - expiry |
|||
|
|||
if (duration.total_seconds() / 3600) > 168: # As the duration may exceed little milliseconds then we fix it |
|||
duration = datetime.timedelta(days=7) |
|||
|
|||
self = cls( |
|||
duration=duration, |
|||
multiple=multiselect, |
|||
layout_type=layout_type, |
|||
question=question, |
|||
) |
|||
self._answers = { |
|||
int(answer['answer_id']): PollAnswer(data=answer, message=message, poll=self) for answer in data['answers'] |
|||
} |
|||
self._message = message |
|||
self._state = state |
|||
self._expiry = expiry |
|||
|
|||
try: |
|||
self._update_results(data['results']) |
|||
except KeyError: |
|||
pass |
|||
|
|||
return self |
|||
|
|||
def _to_dict(self) -> PollCreatePayload: |
|||
data: PollCreatePayload = { |
|||
'allow_multiselect': self.multiple, |
|||
'question': self._question_media.to_dict(), |
|||
'duration': self.duration.total_seconds() / 3600, |
|||
'layout_type': self.layout_type.value, |
|||
'answers': [answer._to_dict() for answer in self.answers], |
|||
} |
|||
return data |
|||
|
|||
def __repr__(self) -> str: |
|||
return f"<Poll duration={self.duration} question=\"{self.question}\" answers={self.answers}>" |
|||
|
|||
@property |
|||
def question(self) -> str: |
|||
""":class:`str`: Returns this poll's question string.""" |
|||
return self._question_media.text |
|||
|
|||
@property |
|||
def answers(self) -> List[PollAnswer]: |
|||
"""List[:class:`PollAnswer`]: Returns a read-only copy of the answers.""" |
|||
return list(self._answers.values()) |
|||
|
|||
@property |
|||
def expires_at(self) -> Optional[datetime.datetime]: |
|||
"""Optional[:class:`datetime.datetime`]: A datetime object representing the poll expiry. |
|||
|
|||
.. note:: |
|||
|
|||
This will **always** be ``None`` for stateless polls. |
|||
""" |
|||
return self._expiry |
|||
|
|||
@property |
|||
def created_at(self) -> Optional[datetime.datetime]: |
|||
"""Optional[:class:`datetime.datetime`]: Returns the poll's creation time. |
|||
|
|||
.. note:: |
|||
|
|||
This will **always** be ``None`` for stateless polls. |
|||
""" |
|||
|
|||
if not self._message: |
|||
return |
|||
return self._message.created_at |
|||
|
|||
@property |
|||
def message(self) -> Optional[Message]: |
|||
""":class:`Message`: The message this poll is from.""" |
|||
return self._message |
|||
|
|||
@property |
|||
def total_votes(self) -> int: |
|||
""":class:`int`: Returns the sum of all the answer votes.""" |
|||
return sum([answer.vote_count for answer in self.answers]) |
|||
|
|||
def is_finalised(self) -> bool: |
|||
""":class:`bool`: Returns whether the poll has finalised. |
|||
|
|||
This always returns ``False`` for stateless polls. |
|||
""" |
|||
return self._finalized |
|||
|
|||
is_finalized = is_finalised |
|||
|
|||
def copy(self) -> Self: |
|||
"""Returns a stateless copy of this poll. |
|||
|
|||
This is meant to be used when you want to edit a stateful poll. |
|||
|
|||
Returns |
|||
------- |
|||
:class:`Poll` |
|||
The copy of the poll. |
|||
""" |
|||
|
|||
new = self.__class__(question=self.question, duration=self.duration) |
|||
|
|||
# We want to return a stateless copy of the poll, so we should not |
|||
# override new._answers as our answers may contain a state |
|||
for answer in self.answers: |
|||
new.add_answer(text=answer.text, emoji=answer.emoji) |
|||
|
|||
return new |
|||
|
|||
def add_answer( |
|||
self, |
|||
*, |
|||
text: str, |
|||
emoji: Optional[Union[PartialEmoji, Emoji, str]] = None, |
|||
) -> Self: |
|||
"""Appends a new answer to this poll. |
|||
|
|||
Parameters |
|||
---------- |
|||
text: :class:`str` |
|||
The text label for this poll answer. Can be up to 55 |
|||
characters. |
|||
emoji: Union[:class:`PartialEmoji`, :class:`Emoji`, :class:`str`] |
|||
The emoji to display along the text. |
|||
|
|||
Raises |
|||
------ |
|||
ClientException |
|||
Cannot append answers to a poll that is active. |
|||
|
|||
Returns |
|||
------- |
|||
:class:`Poll` |
|||
This poll with the new answer appended. This allows fluent-style chaining. |
|||
""" |
|||
|
|||
if self._message: |
|||
raise ClientException('Cannot append answers to a poll that is active') |
|||
|
|||
answer = PollAnswer.from_params(id=len(self.answers) + 1, text=text, emoji=emoji, message=self._message, poll=self) |
|||
self._answers[answer.id] = answer |
|||
return self |
|||
|
|||
def get_answer( |
|||
self, |
|||
/, |
|||
id: int, |
|||
) -> Optional[PollAnswer]: |
|||
"""Returns the answer with the provided ID or ``None`` if not found. |
|||
|
|||
Parameters |
|||
---------- |
|||
id: :class:`int` |
|||
The ID of the answer to get. |
|||
|
|||
Returns |
|||
------- |
|||
Optional[:class:`PollAnswer`] |
|||
The answer. |
|||
""" |
|||
|
|||
return self._answers.get(id) |
|||
|
|||
async def end(self) -> Self: |
|||
"""|coro| |
|||
|
|||
Ends the poll. |
|||
|
|||
Raises |
|||
------ |
|||
ClientException |
|||
This poll has no attached message. |
|||
HTTPException |
|||
Ending the poll failed. |
|||
|
|||
Returns |
|||
------- |
|||
:class:`Poll` |
|||
The updated poll. |
|||
""" |
|||
|
|||
if not self._message or not self._state: # Make type checker happy |
|||
raise ClientException('This poll has no attached message.') |
|||
|
|||
self._message = await self._message.end_poll() |
|||
|
|||
return self |
|||
@ -0,0 +1,88 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a |
|||
copy of this software and associated documentation files (the "Software"), |
|||
to deal in the Software without restriction, including without limitation |
|||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|||
and/or sell copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|||
DEALINGS IN THE SOFTWARE. |
|||
""" |
|||
|
|||
from __future__ import annotations |
|||
|
|||
|
|||
from typing import List, TypedDict, Optional, Literal, TYPE_CHECKING |
|||
from typing_extensions import NotRequired |
|||
|
|||
from .snowflake import Snowflake |
|||
|
|||
if TYPE_CHECKING: |
|||
from .user import User |
|||
from .emoji import PartialEmoji |
|||
|
|||
|
|||
LayoutType = Literal[1] # 1 = Default |
|||
|
|||
|
|||
class PollMedia(TypedDict): |
|||
text: str |
|||
emoji: NotRequired[Optional[PartialEmoji]] |
|||
|
|||
|
|||
class PollAnswer(TypedDict): |
|||
poll_media: PollMedia |
|||
|
|||
|
|||
class PollAnswerWithID(PollAnswer): |
|||
answer_id: int |
|||
|
|||
|
|||
class PollAnswerCount(TypedDict): |
|||
id: Snowflake |
|||
count: int |
|||
me_voted: bool |
|||
|
|||
|
|||
class PollAnswerVoters(TypedDict): |
|||
users: List[User] |
|||
|
|||
|
|||
class PollResult(TypedDict): |
|||
is_finalized: bool |
|||
answer_counts: List[PollAnswerCount] |
|||
|
|||
|
|||
class PollCreate(TypedDict): |
|||
allow_multiselect: bool |
|||
answers: List[PollAnswer] |
|||
duration: float |
|||
layout_type: LayoutType |
|||
question: PollMedia |
|||
|
|||
|
|||
# We don't subclass Poll as it will |
|||
# still have the duration field, which |
|||
# is converted into expiry when poll is |
|||
# fetched from a message or returned |
|||
# by a `send` method in a Messageable |
|||
class Poll(TypedDict): |
|||
allow_multiselect: bool |
|||
answers: List[PollAnswerWithID] |
|||
expiry: str |
|||
layout_type: LayoutType |
|||
question: PollMedia |
|||
results: PollResult |
|||
File diff suppressed because it is too large
File diff suppressed because it is too large
File diff suppressed because it is too large
@ -1,105 +1,31 @@ |
|||
from setuptools import setup |
|||
import re |
|||
|
|||
requirements = [] |
|||
with open('requirements.txt') as f: |
|||
requirements = f.read().splitlines() |
|||
|
|||
version = '' |
|||
with open('discord/__init__.py') as f: |
|||
version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1) |
|||
|
|||
if not version: |
|||
raise RuntimeError('version is not set') |
|||
|
|||
if version.endswith(('a', 'b', 'rc')): |
|||
# append version identifier based on commit count |
|||
try: |
|||
import subprocess |
|||
|
|||
p = subprocess.Popen(['git', 'rev-list', '--count', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
|||
out, err = p.communicate() |
|||
if out: |
|||
version += out.decode('utf-8').strip() |
|||
p = subprocess.Popen(['git', 'rev-parse', '--short', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
|||
out, err = p.communicate() |
|||
if out: |
|||
version += '+g' + out.decode('utf-8').strip() |
|||
except Exception: |
|||
pass |
|||
|
|||
readme = '' |
|||
with open('README.rst') as f: |
|||
readme = f.read() |
|||
|
|||
extras_require = { |
|||
'voice': ['PyNaCl>=1.3.0,<1.6'], |
|||
'docs': [ |
|||
'sphinx==4.4.0', |
|||
'sphinxcontrib_trio==1.1.2', |
|||
'sphinxcontrib-websupport', |
|||
'typing-extensions>=4.3,<5', |
|||
'sphinx-inline-tabs', |
|||
], |
|||
'speed': [ |
|||
'orjson>=3.5.4', |
|||
'aiodns>=1.1', |
|||
'Brotli', |
|||
'cchardet==2.1.7; python_version < "3.10"', |
|||
], |
|||
'test': [ |
|||
'coverage[toml]', |
|||
'pytest', |
|||
'pytest-asyncio', |
|||
'pytest-cov', |
|||
'pytest-mock', |
|||
'typing-extensions>=4.3,<5', |
|||
'tzdata; sys_platform == "win32"', |
|||
], |
|||
} |
|||
|
|||
packages = [ |
|||
'discord', |
|||
'discord.types', |
|||
'discord.ui', |
|||
'discord.webhook', |
|||
'discord.app_commands', |
|||
'discord.ext.commands', |
|||
'discord.ext.tasks', |
|||
] |
|||
|
|||
setup( |
|||
name='discord.py', |
|||
author='Rapptz', |
|||
url='https://github.com/Rapptz/discord.py', |
|||
project_urls={ |
|||
'Documentation': 'https://discordpy.readthedocs.io/en/latest/', |
|||
'Issue tracker': 'https://github.com/Rapptz/discord.py/issues', |
|||
}, |
|||
version=version, |
|||
packages=packages, |
|||
license='MIT', |
|||
description='A Python wrapper for the Discord API', |
|||
long_description=readme, |
|||
long_description_content_type='text/x-rst', |
|||
include_package_data=True, |
|||
install_requires=requirements, |
|||
extras_require=extras_require, |
|||
python_requires='>=3.8.0', |
|||
classifiers=[ |
|||
'Development Status :: 5 - Production/Stable', |
|||
'License :: OSI Approved :: MIT License', |
|||
'Intended Audience :: Developers', |
|||
'Natural Language :: English', |
|||
'Operating System :: OS Independent', |
|||
'Programming Language :: Python :: 3.8', |
|||
'Programming Language :: Python :: 3.9', |
|||
'Programming Language :: Python :: 3.10', |
|||
'Programming Language :: Python :: 3.11', |
|||
'Topic :: Internet', |
|||
'Topic :: Software Development :: Libraries', |
|||
'Topic :: Software Development :: Libraries :: Python Modules', |
|||
'Topic :: Utilities', |
|||
'Typing :: Typed', |
|||
], |
|||
) |
|||
def derive_version() -> str: |
|||
version = '' |
|||
with open('discord/__init__.py') as f: |
|||
version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1) |
|||
|
|||
if not version: |
|||
raise RuntimeError('version is not set') |
|||
|
|||
if version.endswith(('a', 'b', 'rc')): |
|||
# append version identifier based on commit count |
|||
try: |
|||
import subprocess |
|||
|
|||
p = subprocess.Popen(['git', 'rev-list', '--count', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
|||
out, err = p.communicate() |
|||
if out: |
|||
version += out.decode('utf-8').strip() |
|||
p = subprocess.Popen(['git', 'rev-parse', '--short', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
|||
out, err = p.communicate() |
|||
if out: |
|||
version += '+g' + out.decode('utf-8').strip() |
|||
except Exception: |
|||
pass |
|||
|
|||
return version |
|||
|
|||
|
|||
setup(version=derive_version()) |
|||
|
|||
Loading…
Reference in new issue