add boostrap_line_paginator_with_emojis util

[shtlrs]

Closes #261

[netlify]

✅ Deploy Preview for bot-core ready!

Name	Link
🔨 Latest commit	13498a3
🔍 Latest deploy log	https://app.netlify.com/sites/bot-core/deploys/66a64361aef6680008c4c17d
😎 Deploy Preview	https://deploy-preview-262--bot-core.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[jchristgit]

Why wouldn't we use a subclass of paginator that takes an additional init arg that it uses in paginate instead? Something like

class CustomPaginationEmojisLinePaginator(LinePaginator):
    def __init__(self, *args, **kwargs) -> None:
        self.pagination_emojis = kwargs.pop("pagination_emojis", ...)  # dunno default
        super().__init__(*args, **kwargs)

    @classmethod
    async def paginate(*args, **kwargs) -> discord.Message | None:
        return await super().paginate(*args, **kwargs, pagination_emojis=self.pagination_emojis)

[shtlrs]

@jchristgit I have just your response.

paginate is a class method, i won't be able to access the pagination_emojis instance attribute if I do it like that.

So in this case, you'd still have to pass it each time to the paginate method, which itself instantiates a LinePaginator

[jchristgit]

What about this?

def boostrap_line_paginator_with_emojis(pagination_emojis: PaginationEmojis) -> type[LinePaginator]:
    """Bootsrap a LinePaginator class with custom emojis."""
    class _LinePaginator(LinePaginator):
        @classmethod
        async def paginate(cls, *args, **kwargs) -> discord.Message | None:
            return await cls.paginate(*args, **kwargs, pagination_emojis=pagination_emojis)

[shtlrs]

What about this?

def boostrap_line_paginator_with_emojis(pagination_emojis: PaginationEmojis) -> type[LinePaginator]:
    """Bootsrap a LinePaginator class with custom emojis."""
    class _LinePaginator(LinePaginator):
        @classmethod
        async def paginate(cls, *args, **kwargs) -> discord.Message | None:
            return await cls.paginate(*args, **kwargs, pagination_emojis=pagination_emojis)

Yeah that works, I just want to avoid args and kwargs generally but yeah

[jchristgit]

Yeah that works, I just want to avoid args and kwargs generally but yeah

Why the hate against args and kwargs?

I think that we should use my solution but I'm biased. @ChrisLovering what do you think?

[shtlrs]

Yeah that works, I just want to avoid args and kwargs generally but yeah

Why the hate against args and kwargs?

I think that we should use my solution but I'm biased. @ChrisLovering what do you think?

Because the signature doesn't tell you anything about the function anymore, and the api loses meaning. The only way to find out is to read inside the wrapped method

[jchristgit]

Because the signature doesn't tell you anything about the function anymore, and the api loses meaning. The only way to find out is to read inside the wrapped method

But we don't implement the function ourselves, we just copy the signature. So we cannot be an authorative source on what the meaning of the API is supposed ot be, because as soon as upstream changes it, it's going to break. I would rather have a single function that loses meaning (and you can document it as "same method as [link to linepaginator.paginate], but uses ``emoji`` for this and that") as opposed to a single function that needs to update every time some dependency changes its function signature.

[shtlrs]

Hmmmm, not sure about that.

You're exposing a new public interface for your clients, so the maintenance is part of the job. What you're trying to do, wrapping it, adding or removing stuff doesn't matter. I don't know, it just doesn't sit well with me for some reason.

[jchristgit]

Bella, The Hague, apparently the LinePaginator is defined in the exact same module. Why don't we just update the existing class to do this ?

[shtlrs]

@jchristgit How about we do it like this

from functools import partial


class LinePaginator:

    @classmethod
    def idk_what_to_call_this_but_it_returns_a_new_paginator_with_emojis(cls, emojis):
        paginator = type(cls.__name__, cls.__bases__, dict(cls.__dict__))
        paginator.paginate = partial(paginator.paginate, emojis=emojis)
        return paginator

I think this could work

[jchristgit]

Yes, that could probably work. But as a casual reader I now need to remember what type did and why it did what it does.

I have no idea what we are doing here, because it's defined in the same module.

Isn't this more straightforward?

def paginate_with_default_emojis(*args, **kwargs):
    kwargs.setdefault("pagination_emojis", ...)
    return LinePaginator.paginate(*args, **kwargs)