Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bca6b874c6 | ||
|
|
f6caa6f016 | ||
|
|
6dae35001e | ||
|
|
4d52ef7f50 |
@@ -9,13 +9,13 @@ buttons) behind previous / jump / next navigation, with an optional cache button
|
|||||||
`requirements.txt`:
|
`requirements.txt`:
|
||||||
|
|
||||||
```
|
```
|
||||||
dpy_paginator @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_paginator.git@v0.1.0
|
dpy_paginator @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_paginator.git@v0.1.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Direct:
|
Direct:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install "dpy_paginator @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_paginator.git@v0.1.0"
|
pip install "dpy_paginator @ git+ssh://git@git.rethinkstudios.io/rethink-public/dpy_paginator.git@v0.1.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
Requires `discord.py` (pulled transitively).
|
Requires `discord.py` (pulled transitively).
|
||||||
@@ -116,7 +116,8 @@ await ButtonPaginator(pages, cache=cache, cache_sleep=1.0).start(ctx)
|
|||||||
```
|
```
|
||||||
|
|
||||||
Omit `cache` or pass `None`/`[]` and the button never appears. When set, `cache`
|
Omit `cache` or pass `None`/`[]` and the button never appears. When set, `cache`
|
||||||
must have one entry per rendered page.
|
must have one entry per rendered page — a shorter `cache` raises `ValueError` at
|
||||||
|
construction rather than failing with an `IndexError` mid-navigation.
|
||||||
|
|
||||||
## Constructor options
|
## Constructor options
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "dpy_paginator"
|
name = "dpy_paginator"
|
||||||
version = "0.1.0"
|
version = "0.1.1"
|
||||||
description = "Button-navigated paginator for discord.py — config-free, injectable emojis, installable."
|
description = "Button-navigated paginator for discord.py — config-free, injectable emojis, installable."
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
|
|||||||
@@ -159,6 +159,8 @@ class ButtonPaginator(Generic[PageT_co], discord.ui.View):
|
|||||||
cache_sleep: seconds to wait after priming before refreshing the view
|
cache_sleep: seconds to wait after priming before refreshing the view
|
||||||
"""
|
"""
|
||||||
super().__init__(timeout=timeout)
|
super().__init__(timeout=timeout)
|
||||||
|
if not pages:
|
||||||
|
raise ValueError("ButtonPaginator requires at least one page")
|
||||||
self.author_id: Optional[int] = author_id
|
self.author_id: Optional[int] = author_id
|
||||||
self.delete_message_after: bool = delete_message_after
|
self.delete_message_after: bool = delete_message_after
|
||||||
self.mentions_allowed = mentions_allowed or discord.AllowedMentions.all()
|
self.mentions_allowed = mentions_allowed or discord.AllowedMentions.all()
|
||||||
@@ -174,6 +176,11 @@ class ButtonPaginator(Generic[PageT_co], discord.ui.View):
|
|||||||
|
|
||||||
total_pages, left_over = divmod(len(self.pages), self.per_page)
|
total_pages, left_over = divmod(len(self.pages), self.per_page)
|
||||||
self.max_pages: int = total_pages + (1 if left_over else 0)
|
self.max_pages: int = total_pages + (1 if left_over else 0)
|
||||||
|
if cache is not None and len(cache) < self.max_pages:
|
||||||
|
raise ValueError(
|
||||||
|
f"cache has {len(cache)} entries but there are {self.max_pages} pages; "
|
||||||
|
"cache needs one entry per page"
|
||||||
|
)
|
||||||
self._page_kwargs: Dict[str, Any] = self._fresh_kwargs()
|
self._page_kwargs: Dict[str, Any] = self._fresh_kwargs()
|
||||||
|
|
||||||
def _fresh_kwargs(self) -> Dict[str, Any]:
|
def _fresh_kwargs(self) -> Dict[str, Any]:
|
||||||
@@ -202,7 +209,7 @@ class ButtonPaginator(Generic[PageT_co], discord.ui.View):
|
|||||||
"""return the content for a page index, wrapping out-of-range to 0"""
|
"""return the content for a page index, wrapping out-of-range to 0"""
|
||||||
if page_number < 0 or page_number >= self.max_pages:
|
if page_number < 0 or page_number >= self.max_pages:
|
||||||
self.current_page = 0
|
self.current_page = 0
|
||||||
return self.pages[self.current_page]
|
return self.get_page(0)
|
||||||
if self.per_page == 1:
|
if self.per_page == 1:
|
||||||
return self.pages[page_number]
|
return self.pages[page_number]
|
||||||
base = page_number * self.per_page
|
base = page_number * self.per_page
|
||||||
@@ -367,17 +374,31 @@ class ButtonPaginator(Generic[PageT_co], discord.ui.View):
|
|||||||
kwargs.pop("view", None)
|
kwargs.pop("view", None)
|
||||||
|
|
||||||
self.reset_files(kwargs)
|
self.reset_files(kwargs)
|
||||||
send_kwargs["ephemeral"] = self.ephemeral
|
|
||||||
|
|
||||||
if isinstance(obj, discord.Interaction):
|
if isinstance(obj, discord.Interaction):
|
||||||
|
# ephemeral is an interaction-response concept; only these paths accept it
|
||||||
if obj.response.is_done():
|
if obj.response.is_done():
|
||||||
self.message = await obj.followup.send(**kwargs, **send_kwargs)
|
self.message = await obj.followup.send(**kwargs, ephemeral=self.ephemeral, **send_kwargs)
|
||||||
else:
|
else:
|
||||||
await obj.response.send_message(**kwargs, **send_kwargs)
|
await obj.response.send_message(**kwargs, ephemeral=self.ephemeral, **send_kwargs)
|
||||||
self.message = await obj.original_response()
|
self.message = await obj.original_response()
|
||||||
elif isinstance(obj, Messageable):
|
elif isinstance(obj, Messageable):
|
||||||
|
# Messageable.send (a raw channel) has no ephemeral param — never pass it
|
||||||
self.message = await obj.send(**kwargs, **send_kwargs)
|
self.message = await obj.send(**kwargs, **send_kwargs)
|
||||||
else:
|
else:
|
||||||
raise TypeError(f"expected Interaction or Messageable, got {obj.__class__.__name__}")
|
raise TypeError(f"expected Interaction or Messageable, got {obj.__class__.__name__}")
|
||||||
|
|
||||||
return self.message
|
return self.message
|
||||||
|
|
||||||
|
async def on_timeout(self) -> None:
|
||||||
|
"""delete the message on timeout when delete_message_after is set
|
||||||
|
|
||||||
|
only the expected discord failures (already deleted, or no permission) are
|
||||||
|
swallowed; an unexpected error surfaces rather than being silently dropped.
|
||||||
|
"""
|
||||||
|
if not self.delete_message_after or self.message is None:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
await self.message.delete()
|
||||||
|
except (discord.NotFound, discord.Forbidden):
|
||||||
|
pass
|
||||||
|
|||||||
Reference in New Issue
Block a user