Use LinePaginator from bot-core

[shtlrs]

This works in conjunction with bot-core#189

It serves as an example of how the new client code consuming bot-core's LinePaginator would look like.

[mbaruh]

If this is using defaults, wouldn't it be better for the paginator to use those settings by default? Meaning, you wouldn't need to explicitly send it settings for it to work, only when you want to use something custom. This will save another import and function arg every time you want to you the paginator.

[shtlrs]

The entire problem lies within the trashcan. It's the thing that causes problems for contribs, since that emoji is only available in our server.

So if you don't pass those to the paginator when you're running bot, the paginator will crash since you can't use that emoji.

[ChrisLovering]

If that's the case, it might be better to just use https://emojipedia.org/wastebasket/ instead, to avoid all those problems.

[shtlrs]

You mean use it in our server as well ?
Tbh, I didn't consider that as an option, as I thought it was put in place on purpose.

If we were to use that, then we wouldn't be needing the pydnatinc model, import & extra parameter indeed.

[ChrisLovering]

Yea, not sure why we decided on the custom emoji instead of this unicode one. We also have the option to use https://emojipedia.org/stop-sign/ too. Using a unicode emoji would remove a lot of hassle.

[shtlrs]

I meant class method *

Well, i don't remember what it does specifically now but I'll see what I can do about it

[shtlrs]

@wookie184

Hey ! I'm trying to pick this up again and I was wondering what you meant exactly by

One simple way around this for now would be to just create a wrapper here that passes in the necessary constants and we can just use that instead. In the future we may want to think of other ways we can have configuration for bot-core.

Do you mean that we'd keep the pagination emojis as part of the parameters, and then make a decorator that will pass them for us ?
Something like

def pass_parameters(**kwargs_to_pass):
    def inner(func):
         def wrapper(*args, **kwargs):
              kwargs.update(kwargs_to_pass)
              return func(*args, **kwargs)
          retun wrapper
    return inner

Then we'd decorate the paginate method and pass the emojis using the previous deco ?

[wookie184]

I was thinking we could replace bot/pagination.py with something like this

from pydis_core import LinePaginator as _LinePaginator
...

PaginationEmojis = PaginationEmojisModel(delete=Emojis.trashcan)

class LinePaginator(_LinePaginator):
    @classmethod
    async def paginate(cls, *args, **kwargs) -> discord.Message | None:
        return await super().paginate(PaginationEmojis, *args, **kwargs)

then we wouldn't need to update any imports either.

The main annoying thing there is by using "*args" and "**kwargs" you lose hints in the editor about what the arguments are and what types you can pass. Not sure if there's a nice way around that other than just copying the parameter list.

[shtlrs]

Ah, you meant that kind of wrapper.
Okay, I see.

Not sure if there's a nice way around that other than just copying the parameter list.
Don't think there is, even with PEP 692 it wouldn't be quite feasible.

I think just copying the parameter list is fine, this will be used by us only, and anyone who wishes to not used the default emojis we provide can fallback to _LinePaginator

[shtlrs]

@wookie184 Implemented in #2879

[shtlrs]

Superseded by #2879