Skip to content

Commit d77a1c6

Browse files
author
popop098
committed
🎉 Begin!
1 parent 407b251 commit d77a1c6

File tree

6 files changed

+370
-3
lines changed

6 files changed

+370
-3
lines changed

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ __pycache__/
55

66
# C extensions
77
*.so
8-
8+
.idea
99
# Distribution / packaging
1010
.Python
1111
build/

‎PycordPaginator/PagiNation.py

+231
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
from typing import List, Union
2+
import discord
3+
from discord.abc import Messageable
4+
from pycord_components import (
5+
PycordComponents,
6+
Button,
7+
ButtonStyle,
8+
Select,
9+
SelectOption,
10+
Interaction,
11+
)
12+
13+
from .errors import MissingAttributeException,InvaildArgumentException
14+
from discord.ext import commands
15+
class Paginator:
16+
def __init__(
17+
self,
18+
client: PycordComponents,
19+
channel: Messageable,
20+
ctx: Interaction,
21+
contents: List[str] = None,
22+
embeds: List[discord.Embed] = None,
23+
use_select: bool = False,
24+
only: discord.ext.commands.Context.author = None,
25+
desc: dict = None
26+
):
27+
self.context = ctx
28+
self.client = client
29+
self.channel = channel
30+
self.contents = contents
31+
self.embeds = embeds
32+
self.use_select = use_select
33+
self.index = 0
34+
self.only = only
35+
self.desc = desc
36+
37+
if self.contents is not None and self.embeds is not None:
38+
raise MissingAttributeException("You can't use contents and embeds at once!")
39+
40+
if self.contents is None and self.embeds is None:
41+
raise MissingAttributeException("Both contents and embeds are None!")
42+
if self.contents is not None or self.embeds is not None and self.desc is None:
43+
raise InvaildArgumentException("Contents or embeds can't be None when desc is None.")
44+
45+
if self.embeds is not None and len(self.embeds) != len(self.desc):
46+
raise InvaildArgumentException("The number of embeds and desc do not match each other!")
47+
if self.contents is not None and len(self.contents) != len(self.desc):
48+
raise InvaildArgumentException("The number of contents and desc do not match each other!")
49+
50+
51+
def get_components(self):
52+
if self.embeds == None:
53+
if self.use_select:
54+
keys = []
55+
values = []
56+
for key,value in self.desc:
57+
keys.append(key)
58+
values.append(value)
59+
return [
60+
self.client.add_callback(
61+
Select(
62+
custom_id="paginator_select",
63+
options=[
64+
SelectOption(
65+
label=keys[i], value=str(i), default=keys[i] == self.index,description=values[i]
66+
)
67+
for i in range(len(self.contents))
68+
],
69+
),
70+
self.select_callback,
71+
)
72+
]
73+
else:
74+
return [
75+
[ self.client.add_callback(
76+
Button(style=ButtonStyle.blue, emoji="⏮"),
77+
self.button_first_callback,
78+
),
79+
self.client.add_callback(
80+
Button(style=ButtonStyle.blue, emoji="◀️"),
81+
self.button_left_callback,
82+
),
83+
Button(
84+
label=f"Page {self.index + 1}/{len(self.contents)}",
85+
disabled=True,
86+
),
87+
self.client.add_callback(
88+
Button(style=ButtonStyle.blue, emoji="▶️"),
89+
self.button_right_callback,
90+
),
91+
self.client.add_callback(
92+
Button(style=ButtonStyle.blue, emoji="⏭"),
93+
self.button_last_callback,
94+
),
95+
]
96+
]
97+
else:
98+
if self.use_select:
99+
keys = []
100+
values = []
101+
for key, value in self.desc.items():
102+
keys.append(key)
103+
values.append(value)
104+
return [
105+
self.client.add_callback(
106+
Select(
107+
custom_id="paginator_select",
108+
options=[
109+
SelectOption(
110+
label=keys[i], value=str(i), default=keys[i] == self.index,description=values[i]
111+
)
112+
for i in range(len(self.embeds))
113+
],
114+
),
115+
self.select_callback,
116+
)
117+
]
118+
else:
119+
return [
120+
[self.client.add_callback(
121+
Button(style=ButtonStyle.blue, emoji="⏮"),
122+
self.button_first_callback,
123+
),
124+
self.client.add_callback(
125+
Button(style=ButtonStyle.blue, emoji="◀️"),
126+
self.button_left_callback,
127+
),
128+
Button(
129+
label=f"Page {self.index + 1}/{len(self.embeds)}",
130+
disabled=True,
131+
),
132+
self.client.add_callback(
133+
Button(style=ButtonStyle.blue, emoji="▶️"),
134+
self.button_right_callback,
135+
),
136+
self.client.add_callback(
137+
Button(style=ButtonStyle.blue, emoji="⏭"),
138+
self.button_last_callback,
139+
),
140+
]
141+
]
142+
143+
144+
145+
async def start(self):
146+
if self.embeds == None:
147+
self.msg = await self.channel.send(
148+
content=self.contents[self.index], components=self.get_components()
149+
)
150+
else:
151+
self.msg = await self.channel.send(
152+
embed=self.embeds[self.index], components=self.get_components()
153+
)
154+
155+
async def select_callback(self, inter: Interaction):
156+
self.index = int(inter.values[0])
157+
if self.embeds == None:
158+
await inter.edit_origin(
159+
content=self.contents[self.index], components=self.get_components()
160+
)
161+
else:
162+
await inter.edit_origin(
163+
embed=self.embeds[self.index], components=self.get_components()
164+
)
165+
async def button_first_callback(self, inter: Interaction):
166+
if self.index == 0:
167+
pass
168+
else:
169+
self.index = 0
170+
171+
await self.button_callback(inter)
172+
173+
async def button_left_callback(self, inter: Interaction):
174+
if self.index == 0:
175+
if self.embeds == None:
176+
self.index = len(self.contents) - 1
177+
else:
178+
self.index = len(self.embeds) - 1
179+
else:
180+
self.index -= 1
181+
182+
await self.button_callback(inter)
183+
184+
async def button_right_callback(self, inter: Interaction):
185+
if self.embeds == None:
186+
if self.index == len(self.contents) - 1:
187+
self.index = 0
188+
else:
189+
self.index += 1
190+
else:
191+
if self.index == len(self.embeds) - 1:
192+
self.index = 0
193+
else:
194+
self.index += 1
195+
196+
await self.button_callback(inter)
197+
198+
async def button_last_callback(self, inter: Interaction):
199+
if self.embeds == None:
200+
if self.index == len(self.contents) - 1:
201+
pass
202+
else:
203+
self.index = len(self.contents) - 1
204+
else:
205+
if self.index == len(self.embeds) - 1:
206+
pass
207+
else:
208+
self.index = len(self.embeds) - 1
209+
210+
await self.button_callback(inter)
211+
212+
async def button_callback(self, inter: Interaction):
213+
if not self.only == None:
214+
if inter.user.id == self.only.id and inter.message.id != self.context.message.id:
215+
if self.embeds == None:
216+
await inter.edit_origin(
217+
content=self.contents[self.index], components=self.get_components()
218+
)
219+
else:
220+
await inter.edit_origin(
221+
embed=self.embeds[self.index], components=self.get_components()
222+
)
223+
else:
224+
if self.embeds == None:
225+
await inter.edit_origin(
226+
content=self.contents[self.index], components=self.get_components()
227+
)
228+
else:
229+
await inter.edit_origin(
230+
embed=self.embeds[self.index], components=self.get_components()
231+
)

‎PycordPaginator/__init__.py

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from .PagiNation import Paginator
2+
3+
__version__ = "0.0.1"

‎PycordPaginator/errors.py

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
class MissingAttributeException(Exception):
2+
pass
3+
4+
5+
class InvaildArgumentException(Exception):
6+
pass

‎README.md

+104-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,104 @@
1-
# pycord-paginator
2-
paginator using pycord_components
1+
<div align="center">
2+
<div>
3+
<h1>Pycord-Paginator</h1>
4+
<span> <a href="https://pypi.org/project/pycord-components"><img src="https://raw.githubusercontent.com/kiki7000/discord.py-components/master/.github/logo.png" alt="discord-components logo" height="10" style="border-radius: 50%"></a>With pycord-components</span>
5+
</div>
6+
<div>
7+
</div>
8+
<div>
9+
<h3>paginator using pycord_components</h3>
10+
</div>
11+
</div>
12+
13+
## Welcome!
14+
It's a paginator for pycord-componets! Thanks to the original creator khk4912 (khk4912 /EZPaginator)!
15+
16+
This project is open source ⭐.
17+
18+
[official discord server](https://shrt.kro.kr/discord), so if you have a question, feel free to ask it on this server.
19+
20+
It was produced by referring to the open source of "[decave27](https://github.com/decave27/ButtonPaginator)".
21+
## Install
22+
```
23+
pip install --upgrade PycordPaginator
24+
```
25+
26+
## Example
27+
```py
28+
from PagiNation import Paginator
29+
from discord.ext.commands import Bot
30+
from pycord_components import PycordComponents
31+
import discord
32+
33+
bot = Bot("your prefix")
34+
35+
@bot.event
36+
async def on_ready():
37+
PycordComponents(bot)
38+
print(f"Logged in as {bot.user}!")
39+
40+
@bot.command()
41+
async def pagination(ctx):
42+
embeds = [discord.Embed(title="1 page"), discord.Embed(title="2 page"), discord.Embed(title="3 page"),
43+
discord.Embed(title="4 page"), discord.Embed(title="5 page")]
44+
desc = {
45+
"Basic help":"Basic help description",
46+
"example help1":"example help1 description",
47+
"example help2":"example help2 description",
48+
"example help3":"example help3 description",
49+
"example help4":"example help4 description"
50+
}
51+
52+
53+
e = Paginator(
54+
client=bot.components_manager,
55+
embeds=embeds,
56+
channel=ctx.channel,
57+
only=ctx.author,
58+
ctx=ctx,
59+
use_select=True,
60+
desc=desc)
61+
await e.start()
62+
63+
bot.run("your token")
64+
```
65+
66+
67+
## result
68+
### use_select == True
69+
![button](https://media.discordapp.net/attachments/889514827905630290/892211050114609182/2021_09_28_09_41_30_720.gif?width=585&height=644)
70+
71+
72+
### use_select == False
73+
![select](https://media.discordapp.net/attachments/889514827905630290/892211620506382406/2021_09_28_09_49_44_57.gif?width=585&height=644)
74+
75+
## option
76+
```py
77+
class Paginator:
78+
def __init__(
79+
self,
80+
client: PycordComponents,
81+
channel: Messageable,
82+
ctx: Interaction,
83+
contents: List[str] = None,
84+
embeds: List[discord.Embed] = None,
85+
use_select: bool = False, #if False, use buttons
86+
only: discord.ext.commands.Context.author = None,
87+
desc: dict = None
88+
):
89+
```
90+
91+
## License
92+
This project is under the MIT License.
93+
94+
## Contribute
95+
Anyone can contribute to this by forking the repository, making a change, and create a pull request!
96+
97+
But you have to follow these to PR.
98+
+ Use the black formatter.
99+
+ Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
100+
+ Test.
101+
102+
## Thanks to
103+
+ [khk4912](https://github.com/khk4912/EZPaginator) - Original Paginator developer
104+
+ [Leek5](https://github.com/Leek5/pycord-components) - pycord componets lib developer

‎setup.py

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
from setuptools import setup, find_packages
2+
from PycordPaginator import __version__
3+
4+
setup(
5+
name="PycordPaginator",
6+
license="MIT",
7+
version=__version__,
8+
description="paginator using pycord_components",
9+
author="SpaceDEV",
10+
author_email="[email protected]",
11+
url="https://github.com/SpaceDEVofficial/pycord-paginator",
12+
packages=find_packages(),
13+
long_description=open('README.md', 'rt', encoding='UTF8').read(),
14+
long_description_content_type="text/markdown",
15+
keywords=["discord.py", "paginaion", "button", "components", "discord_components"],
16+
python_requires=">=3.6",
17+
install_requires=["py-cord","pycord-components"],
18+
zip_safe=False,
19+
classifiers=[
20+
"Programming Language :: Python :: 3",
21+
"Programming Language :: Python :: 3.6",
22+
"Programming Language :: Python :: 3.7",
23+
"Programming Language :: Python :: 3.8",
24+
],
25+
)

0 commit comments

Comments
 (0)