Compare commits
4 Commits
ImAnAgent/
...
ethanolchi
Author | SHA1 | Date | |
---|---|---|---|
339bfa62f5 | |||
9ad65f6b9e | |||
e98c97a4cb | |||
b3aa87582f |
12
README.rst
12
README.rst
@ -17,6 +17,18 @@ The Future of enhanced-discord.py
|
||||
--------------------------
|
||||
|
||||
Enhanced discord.py is a fork of Rapptz's discord.py, that went unmaintained (`gist <https://gist.github.com/Rapptz/4a2f62751b9600a31a0d3c78100287f1>`_)
|
||||
|
||||
It is currently maintained by (in alphabetical order)
|
||||
|
||||
- Chillymosh#8175
|
||||
- Daggy#9889
|
||||
- dank Had0cK#6081
|
||||
- Dutchy#6127
|
||||
- Eyesofcreeper#0001
|
||||
- Gnome!#6669
|
||||
- IAmTomahawkx#1000
|
||||
- Jadon#2494
|
||||
|
||||
An overview of added features is available on the `custom features page <https://enhanced-dpy.readthedocs.io/en/latest/index.html#custom-features>`_.
|
||||
|
||||
Key Features
|
||||
|
@ -28,7 +28,6 @@ from __future__ import annotations
|
||||
import asyncio
|
||||
import collections
|
||||
import collections.abc
|
||||
from functools import cached_property
|
||||
|
||||
import inspect
|
||||
import importlib.util
|
||||
@ -73,9 +72,7 @@ from .cog import Cog
|
||||
if TYPE_CHECKING:
|
||||
import importlib.machinery
|
||||
|
||||
from discord.role import Role
|
||||
from discord.message import Message
|
||||
from discord.abc import PartialMessageableChannel
|
||||
from ._types import (
|
||||
Check,
|
||||
CoroFunc,
|
||||
@ -97,16 +94,9 @@ CXT = TypeVar("CXT", bound="Context")
|
||||
|
||||
class _FakeSlashMessage(discord.PartialMessage):
|
||||
activity = application = edited_at = reference = webhook_id = None
|
||||
attachments = components = reactions = stickers = []
|
||||
tts = False
|
||||
|
||||
raw_mentions = discord.Message.raw_mentions
|
||||
clean_content = discord.Message.clean_content
|
||||
channel_mentions = discord.Message.channel_mentions
|
||||
raw_role_mentions = discord.Message.raw_role_mentions
|
||||
raw_channel_mentions = discord.Message.raw_channel_mentions
|
||||
|
||||
attachments = components = reactions = stickers = mentions = []
|
||||
author: Union[discord.User, discord.Member]
|
||||
tts = False
|
||||
|
||||
@classmethod
|
||||
def from_interaction(
|
||||
@ -118,22 +108,6 @@ class _FakeSlashMessage(discord.PartialMessage):
|
||||
|
||||
return self
|
||||
|
||||
@cached_property
|
||||
def mentions(self) -> List[Union[discord.Member, discord.User]]:
|
||||
client = self._state._get_client()
|
||||
if self.guild:
|
||||
ensure_user = lambda id: self.guild.get_member(id) or client.get_user(id) # type: ignore
|
||||
else:
|
||||
ensure_user = client.get_user
|
||||
|
||||
return discord.utils._unique(filter(None, map(ensure_user, self.raw_mentions)))
|
||||
|
||||
@cached_property
|
||||
def role_mentions(self) -> List[Role]:
|
||||
if self.guild is None:
|
||||
return []
|
||||
return discord.utils._unique(filter(None, map(self.guild.get_role, self.raw_role_mentions)))
|
||||
|
||||
|
||||
def when_mentioned(bot: Union[Bot, AutoShardedBot], msg: Message) -> List[str]:
|
||||
"""A callable that implements a command prefix equivalent to being mentioned.
|
||||
@ -1292,7 +1266,7 @@ class BotBase(GroupMixin):
|
||||
|
||||
# Make our fake message so we can pass it to ext.commands
|
||||
message: discord.Message = _FakeSlashMessage.from_interaction(interaction, channel) # type: ignore
|
||||
message.content = f"/{command_name}"
|
||||
message.content = f"/{command_name} "
|
||||
|
||||
# Add arguments to fake message content, in the right order
|
||||
ignore_params: List[inspect.Parameter] = []
|
||||
@ -1307,7 +1281,7 @@ class BotBase(GroupMixin):
|
||||
else:
|
||||
prefix = param.annotation.__commands_flag_prefix__
|
||||
delimiter = param.annotation.__commands_flag_delimiter__
|
||||
message.content += f" {prefix}{name}{delimiter}{option['value']}" # type: ignore
|
||||
message.content += f"{prefix}{name} {option['value']}{delimiter}" # type: ignore
|
||||
continue
|
||||
|
||||
option = next((o for o in command_options if o["name"] == name), None)
|
||||
@ -1323,9 +1297,9 @@ class BotBase(GroupMixin):
|
||||
):
|
||||
# String with space in without "consume rest"
|
||||
option = cast(_ApplicationCommandInteractionDataOptionString, option)
|
||||
message.content += f" {_quote_string_safe(option['value'])}"
|
||||
message.content += f"{_quote_string_safe(option['value'])} "
|
||||
else:
|
||||
message.content += f' {option.get("value", "")}'
|
||||
message.content += f'{option.get("value", "")} '
|
||||
|
||||
ctx = await self.get_context(message)
|
||||
ctx._ignored_params = ignore_params
|
||||
|
@ -465,7 +465,6 @@ class Context(discord.abc.Messageable, Generic[BotT]):
|
||||
kwargs.pop("nonce", None)
|
||||
kwargs.pop("stickers", None)
|
||||
kwargs.pop("reference", None)
|
||||
kwargs.pop("delete_after", None)
|
||||
kwargs.pop("mention_author", None)
|
||||
|
||||
if not (
|
||||
|
@ -1694,9 +1694,7 @@ class Group(GroupMixin[CogT], Command[CogT, P, T]):
|
||||
"name": self.name,
|
||||
"type": int(not (nested - 1)) + 1,
|
||||
"description": self.short_doc or "no description",
|
||||
"options": [
|
||||
cmd.to_application_command(nested=nested + 1) for cmd in sorted(self.commands, key=lambda x: x.name)
|
||||
],
|
||||
"options": [cmd.to_application_command(nested=nested + 1) for cmd in sorted(self.commands, key=lambda x: x.name)],
|
||||
}
|
||||
|
||||
|
||||
|
@ -455,7 +455,7 @@ class BadInviteArgument(BadArgument):
|
||||
This inherits from :exc:`BadArgument`
|
||||
|
||||
.. versionadded:: 1.5
|
||||
|
||||
|
||||
Attributes
|
||||
-----------
|
||||
argument: :class:`str`
|
||||
|
@ -188,8 +188,8 @@ class HTTPClient:
|
||||
self.proxy_auth: Optional[aiohttp.BasicAuth] = proxy_auth
|
||||
self.use_clock: bool = not unsync_clock
|
||||
|
||||
u_agent = "DiscordBot (https://github.com/iDevision/enhanced-discord.py {0}) Python/{1[0]}.{1[1]} aiohttp/{2}"
|
||||
self.user_agent: str = u_agent.format(__version__, sys.version_info, aiohttp.__version__)
|
||||
user_agent = "DiscordBot (https://github.com/Rapptz/discord.py {0}) Python/{1[0]}.{1[1]} aiohttp/{2}"
|
||||
self.user_agent: str = user_agent.format(__version__, sys.version_info, aiohttp.__version__)
|
||||
|
||||
def recreate(self) -> None:
|
||||
if self.__session.closed:
|
||||
|
@ -337,7 +337,7 @@ class Interaction:
|
||||
self._state.store_view(view, message.id)
|
||||
return message
|
||||
|
||||
async def delete_original_message(self) -> None:
|
||||
async def delete_original_message(self, delay: Optional[float] = None) -> None:
|
||||
"""|coro|
|
||||
|
||||
Deletes the original interaction response message.
|
||||
@ -345,6 +345,14 @@ class Interaction:
|
||||
This is a lower level interface to :meth:`InteractionMessage.delete` in case
|
||||
you do not want to fetch the message and save an HTTP request.
|
||||
|
||||
Parameters
|
||||
------------
|
||||
delay: Optional[:class:`float`]
|
||||
If provided, the number of seconds to wait before deleting the message.
|
||||
The waiting is done in the background and deletion failures are ignored.
|
||||
|
||||
.. versionadded:: 2.0
|
||||
|
||||
Raises
|
||||
-------
|
||||
HTTPException
|
||||
@ -352,6 +360,8 @@ class Interaction:
|
||||
Forbidden
|
||||
Deleted a message that is not yours.
|
||||
"""
|
||||
if delay is not None:
|
||||
await asyncio.sleep(delay)
|
||||
adapter = async_context.get()
|
||||
await adapter.delete_original_interaction_response(
|
||||
self.application_id,
|
||||
@ -460,6 +470,7 @@ class InteractionResponse:
|
||||
view: View = MISSING,
|
||||
tts: bool = False,
|
||||
ephemeral: bool = False,
|
||||
delete_after: Optional[float] = None,
|
||||
) -> None:
|
||||
"""|coro|
|
||||
|
||||
@ -483,6 +494,9 @@ class InteractionResponse:
|
||||
Indicates if the message should only be visible to the user who started the interaction.
|
||||
If a view is sent with an ephemeral message and it has no timeout set then the timeout
|
||||
is set to 15 minutes.
|
||||
delete_after: Optional[:class:`float`]
|
||||
The amount of seconds the bot should wait before deleting the message sent.
|
||||
.. versionadded:: 2.0
|
||||
|
||||
Raises
|
||||
-------
|
||||
@ -539,6 +553,8 @@ class InteractionResponse:
|
||||
self._parent._state.store_view(view)
|
||||
|
||||
self.responded_at = utils.utcnow()
|
||||
if delete_after is not None:
|
||||
self._parent.delete_original_message(delay=delete_after)
|
||||
|
||||
async def edit_message(
|
||||
self,
|
||||
@ -733,7 +749,7 @@ class InteractionMessage(Message):
|
||||
allowed_mentions=allowed_mentions,
|
||||
)
|
||||
|
||||
async def delete(self, *, delay: Optional[float] = None) -> None:
|
||||
async def delete(self, *, delay: Optional[float] = None, silent: bool = False) -> None:
|
||||
"""|coro|
|
||||
|
||||
Deletes the message.
|
||||
@ -743,6 +759,12 @@ class InteractionMessage(Message):
|
||||
delay: Optional[:class:`float`]
|
||||
If provided, the number of seconds to wait before deleting the message.
|
||||
The waiting is done in the background and deletion failures are ignored.
|
||||
|
||||
silent: :class:`bool`
|
||||
If silent is set to ``True``, the error will not be raised, it will be ignored.
|
||||
This defaults to ``False`
|
||||
|
||||
.. versionadded:: 2.0
|
||||
|
||||
Raises
|
||||
------
|
||||
@ -757,12 +779,15 @@ class InteractionMessage(Message):
|
||||
if delay is not None:
|
||||
|
||||
async def inner_call(delay: float = delay):
|
||||
await asyncio.sleep(delay)
|
||||
try:
|
||||
await self._state._interaction.delete_original_message()
|
||||
await self._state._interaction.delete_original_message(delay=delay)
|
||||
except HTTPException:
|
||||
pass
|
||||
|
||||
asyncio.create_task(inner_call())
|
||||
else:
|
||||
await self._state._interaction.delete_original_message()
|
||||
try:
|
||||
await self._state._interaction.delete_original_message(delay=delay)
|
||||
except Exception:
|
||||
if not silent:
|
||||
raise
|
||||
|
@ -717,7 +717,7 @@ class WebhookMessage(Message):
|
||||
allowed_mentions=allowed_mentions,
|
||||
)
|
||||
|
||||
async def delete(self, *, delay: Optional[float] = None) -> None:
|
||||
async def delete(self, *, delay: Optional[float] = None, silent: bool = False) -> None:
|
||||
"""|coro|
|
||||
|
||||
Deletes the message.
|
||||
@ -727,6 +727,12 @@ class WebhookMessage(Message):
|
||||
delay: Optional[:class:`float`]
|
||||
If provided, the number of seconds to wait before deleting the message.
|
||||
The waiting is done in the background and deletion failures are ignored.
|
||||
|
||||
silent: :class:`bool`
|
||||
If silent is set to ``True``, the error will not be raised, it will be ignored.
|
||||
This defaults to ``False`
|
||||
|
||||
.. versionadded:: 2.0
|
||||
|
||||
Raises
|
||||
------
|
||||
@ -741,15 +747,18 @@ class WebhookMessage(Message):
|
||||
if delay is not None:
|
||||
|
||||
async def inner_call(delay: float = delay):
|
||||
await asyncio.sleep(delay)
|
||||
try:
|
||||
await self._state._webhook.delete_message(self.id)
|
||||
await self._state._webhook.delete_message(self.id, delay)
|
||||
except HTTPException:
|
||||
pass
|
||||
|
||||
asyncio.create_task(inner_call())
|
||||
else:
|
||||
await self._state._webhook.delete_message(self.id)
|
||||
try:
|
||||
await self._state._webhook.delete_message(self.id, delay)
|
||||
except Exception:
|
||||
if not silent:
|
||||
raise
|
||||
|
||||
|
||||
class BaseWebhook(Hashable):
|
||||
@ -1270,6 +1279,7 @@ class Webhook(BaseWebhook):
|
||||
view: View = MISSING,
|
||||
thread: Snowflake = MISSING,
|
||||
wait: bool = False,
|
||||
delete_after: Optional[float] = None,
|
||||
) -> Optional[WebhookMessage]:
|
||||
"""|coro|
|
||||
|
||||
@ -1335,6 +1345,11 @@ class Webhook(BaseWebhook):
|
||||
The thread to send this webhook to.
|
||||
|
||||
.. versionadded:: 2.0
|
||||
|
||||
delete_after: Optional[:class:`float`]
|
||||
If provided, the number of seconds to wait before deleting the message.
|
||||
The waiting is done in the background and deletion failures are ignored.
|
||||
.. versionadded:: 2.0
|
||||
|
||||
Raises
|
||||
--------
|
||||
@ -1416,6 +1431,9 @@ class Webhook(BaseWebhook):
|
||||
if view is not MISSING and not view.is_finished():
|
||||
message_id = None if msg is None else msg.id
|
||||
self._state.store_view(view, message_id)
|
||||
|
||||
if delete_after is not None and msg is not None:
|
||||
await msg.delete(delay=delete_after)
|
||||
|
||||
return msg
|
||||
|
||||
@ -1570,7 +1588,7 @@ class Webhook(BaseWebhook):
|
||||
self._state.store_view(view, message_id)
|
||||
return message
|
||||
|
||||
async def delete_message(self, message_id: int, /) -> None:
|
||||
async def delete_message(self, message_id: int, delay: Optional[float] = None, /) -> None:
|
||||
"""|coro|
|
||||
|
||||
Deletes a message owned by this webhook.
|
||||
@ -1584,6 +1602,12 @@ class Webhook(BaseWebhook):
|
||||
------------
|
||||
message_id: :class:`int`
|
||||
The message ID to delete.
|
||||
|
||||
delay: Optional[:class:`float`]
|
||||
If provided, the number of seconds to wait before deleting the message.
|
||||
The waiting is done in the background and deletion failures are ignored.
|
||||
|
||||
.. versionadded:: 2.0
|
||||
|
||||
Raises
|
||||
-------
|
||||
@ -1595,6 +1619,9 @@ class Webhook(BaseWebhook):
|
||||
if self.token is None:
|
||||
raise InvalidArgument("This webhook does not have a token associated with it")
|
||||
|
||||
if delay is not None:
|
||||
await asyncio.sleep(delay)
|
||||
|
||||
adapter = async_context.get()
|
||||
await adapter.delete_webhook_message(
|
||||
self.id,
|
||||
|
1274
docs/api.rst
1274
docs/api.rst
File diff suppressed because it is too large
Load Diff
@ -49,7 +49,7 @@ autodoc_typehints = "none"
|
||||
# napoleon_attr_annotations = False
|
||||
|
||||
extlinks = {
|
||||
"issue": ("https://github.com/iDevision/enhanced-discord.py/issues/%s", "GH-"),
|
||||
"issue": ("https://github.com/Rapptz/discord.py/issues/%s", "GH-"),
|
||||
}
|
||||
|
||||
# Links used for cross-referencing stuff in other documentation
|
||||
@ -168,8 +168,9 @@ html_context = {
|
||||
|
||||
resource_links = {
|
||||
"discord": "https://discord.gg/TvqYBrGXEm",
|
||||
"issues": "https://github.com/iDevision/enhanced-discord.py/issues",
|
||||
"examples": f"https://github.com/iDevision/enhanced-discord.py/tree/{branch}/examples",
|
||||
"issues": "https://github.com/Rapptz/discord.py/issues",
|
||||
"discussions": "https://github.com/Rapptz/discord.py/discussions",
|
||||
"examples": f"https://github.com/Rapptz/discord.py/tree/{branch}/examples",
|
||||
}
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
|
@ -38,6 +38,7 @@ If you're having trouble with something, these resources might help.
|
||||
- Ask us and hang out with us in our :resource:`Discord <discord>` server.
|
||||
- If you're looking for something specific, try the :ref:`index <genindex>` or :ref:`searching <search>`.
|
||||
- Report bugs in the :resource:`issue tracker <issues>`.
|
||||
- Ask in our :resource:`GitHub discussions page <discussions>`.
|
||||
|
||||
Extensions
|
||||
------------
|
||||
|
@ -1,210 +0,0 @@
|
||||
import discord
|
||||
from discord.ext import commands
|
||||
from discord import ButtonStyle, Embed, Interaction
|
||||
from discord.ui import Button, View
|
||||
|
||||
|
||||
class Bot(commands.Bot):
|
||||
def __init__(self):
|
||||
super().__init__(
|
||||
command_prefix=commands.when_mentioned_or("$"), intents=discord.Intents(guilds=True, messages=True)
|
||||
)
|
||||
|
||||
async def on_ready(self):
|
||||
print(f"Logged in as {self.user} (ID: {self.user.id})")
|
||||
print("------")
|
||||
|
||||
|
||||
# Define 3 View subclasses that we will switch between depending on if we are viewing the first page, a page in the middle, or the last page.
|
||||
# The first page has the "left" button disabled, because there is no left page to go to
|
||||
class FirstPageComps(View):
|
||||
def __init__(
|
||||
self,
|
||||
author_id: int,
|
||||
):
|
||||
super().__init__()
|
||||
self.value = None
|
||||
self.author_id = author_id
|
||||
|
||||
async def interaction_check(
|
||||
self,
|
||||
interaction: Interaction,
|
||||
):
|
||||
return interaction.user.id == self.author_id
|
||||
|
||||
@discord.ui.button(
|
||||
style=ButtonStyle.primary,
|
||||
disabled=True,
|
||||
label="Left",
|
||||
)
|
||||
async def left(
|
||||
self,
|
||||
button: discord.ui.Button,
|
||||
interaction: Interaction,
|
||||
):
|
||||
self.value = "left"
|
||||
self.stop()
|
||||
|
||||
@discord.ui.button(
|
||||
style=ButtonStyle.primary,
|
||||
label="Right",
|
||||
)
|
||||
async def right(
|
||||
self,
|
||||
button: discord.ui.Button,
|
||||
interaction: Interaction,
|
||||
):
|
||||
self.value = "right"
|
||||
self.stop()
|
||||
|
||||
|
||||
# The middle pages have both left and right buttons available
|
||||
class MiddlePageComps(View):
|
||||
def __init__(
|
||||
self,
|
||||
author_id: int,
|
||||
):
|
||||
super().__init__()
|
||||
self.value = None
|
||||
self.author_id = author_id
|
||||
|
||||
async def interaction_check(
|
||||
self,
|
||||
interaction: Interaction,
|
||||
):
|
||||
return interaction.user.id == self.author_id
|
||||
|
||||
@discord.ui.button(
|
||||
style=ButtonStyle.primary,
|
||||
label="Left",
|
||||
)
|
||||
async def left(
|
||||
self,
|
||||
button: discord.ui.Button,
|
||||
interaction: Interaction,
|
||||
):
|
||||
self.value = "left"
|
||||
self.stop()
|
||||
|
||||
@discord.ui.button(
|
||||
style=ButtonStyle.primary,
|
||||
label="Right",
|
||||
)
|
||||
async def right(
|
||||
self,
|
||||
button: discord.ui.Button,
|
||||
interaction: Interaction,
|
||||
):
|
||||
self.value = "right"
|
||||
self.stop()
|
||||
|
||||
|
||||
# The last page has the right button disabled, because there's no right page to go to
|
||||
class LastPageComps(View):
|
||||
def __init__(
|
||||
self,
|
||||
author_id: int,
|
||||
):
|
||||
super().__init__()
|
||||
self.value = None
|
||||
self.author_id = author_id
|
||||
|
||||
async def interaction_check(
|
||||
self,
|
||||
interaction: Interaction,
|
||||
):
|
||||
return interaction.user.id == self.author_id
|
||||
|
||||
@discord.ui.button(
|
||||
style=ButtonStyle.primary,
|
||||
label="Left",
|
||||
)
|
||||
async def left(
|
||||
self,
|
||||
button: discord.ui.Button,
|
||||
interaction: Interaction,
|
||||
):
|
||||
self.value = "left"
|
||||
self.stop()
|
||||
|
||||
@discord.ui.button(
|
||||
style=ButtonStyle.primary,
|
||||
label="Right",
|
||||
disabled=True,
|
||||
)
|
||||
async def right(
|
||||
self,
|
||||
button: discord.ui.Button,
|
||||
interaction: Interaction,
|
||||
):
|
||||
self.value = "right"
|
||||
self.stop()
|
||||
|
||||
|
||||
# Now we define the function that will take care of the pagination for us. It will take a list of Embeds and allow the user to cycle between them using left/right buttons
|
||||
# There is also an optional title parameter in case you want to give your paginator a title, it will display in the embed title, for example if the title is Book
|
||||
# then the title will look like "Book | Page 1/2". This is very optional and can be removed
|
||||
async def paginate(
|
||||
ctx,
|
||||
pages: list,
|
||||
title: str = None,
|
||||
):
|
||||
|
||||
total_pages = len(pages)
|
||||
first_page = pages[0]
|
||||
last_page = pages[-1]
|
||||
current_page = first_page
|
||||
index = 0
|
||||
|
||||
embed = first_page
|
||||
if title:
|
||||
embed.title = f"{title} | Page {index+1}/{total_pages}"
|
||||
|
||||
view = FirstPageComps(ctx.author.id)
|
||||
# Here we send the message with the view of the first page and the FirstPageComps buttons
|
||||
msg = await ctx.send(
|
||||
embed=embed,
|
||||
view=view,
|
||||
)
|
||||
|
||||
# The default timeout for Views is 3 minutes, but if a user selects to scroll between pages the timer will be reset.
|
||||
# If the timer reaches 0, though, the loop will just silently stop.
|
||||
while True:
|
||||
wait = await view.wait()
|
||||
if wait:
|
||||
return
|
||||
|
||||
if view.value == "right":
|
||||
index += 1
|
||||
current_page = pages[index]
|
||||
view = MiddlePageComps(ctx.author.id) if current_page != last_page else LastPageComps(ctx.author.id)
|
||||
embed = current_page
|
||||
if title:
|
||||
embed.title = f"{title} | Page {index+1}/{total_pages}"
|
||||
|
||||
elif view.value == "left":
|
||||
index -= 1
|
||||
current_page = pages[index]
|
||||
view = MiddlePageComps(ctx.author.id) if current_page != first_page else FirstPageComps(ctx.author.id)
|
||||
embed = current_page
|
||||
if title:
|
||||
embed.title = f"{title} | Page {index+1}/{total_pages}"
|
||||
|
||||
await msg.edit(
|
||||
embed=embed,
|
||||
view=view,
|
||||
)
|
||||
|
||||
|
||||
bot = Bot()
|
||||
|
||||
# To test our new function, let's create a list of a couple Embeds and let our paginator deal with the sending and buttons
|
||||
@bot.command()
|
||||
async def sendpages(ctx):
|
||||
page1 = Embed(description="This is page 1")
|
||||
page2 = Embed(description="This is page 2")
|
||||
page3 = Embed(description="This is page 3")
|
||||
await paginate(ctx, [page1, page2, page3])
|
||||
|
||||
|
||||
bot.run("token")
|
Reference in New Issue
Block a user