Type nextcord.Embed method parameters more specifically

[EmreTech]

Summary

The methods for nextcord.Embed should have properly typed parameters.

What is the feature request for?

The core library

The Problem

Currently, many of the parameters in nextcord.Embed methods that are supposed to be str are typed with Any. This is not ideal because static type checkers will allow you to provide any object, whether it's appropriate for the method. It's like that so the parameters can support any object then be stringified later, but it could lead to weird problems if not used correctly.

Here's an example of this:

nextcord/nextcord/embeds.py

Line 324 in dcadc7e

def set_footer(self, *, text: Optional[Any] = None, icon_url: Optional[Any] = None) -> Self:

The Ideal Solution

nextcord.Embed methods should be typed more precisely to only allow objects that support conversion to str. For example, in our example method set_footer, if an object that supports conversion to a string (__str__) is provided, then the type checker will be happy. Otherwise, it will throw an error.

This can be accomplished by typing the parameter with a protocol that lists the supported conversion method. Unfortunately, Python does not have a built-in protocol for conversion to a string because technically every object can be converted to a string. We will have to make our own.

The Current Solution

No response

Additional Context

As discussed on the Discord Server, this issue will be for v3.

[Jodenee]

I'm not sure if a protocol would fit in this situation, as you know every class in python can be converted into a str with or without manually implementing the str magic method as python will just default to repr if str is not implemented, and that's where the issue is. It's impossible to tell if it is implemented or not with protocols as to protocols str is always defined.

But I am aware of one way of achieving this, what we can do instead is make use of an ABC with just the str magic method as an abstract method, but this comes with its own drawbacks such as, forcing the ABC to be inherited by the user's classes and it not supporting literal strings, so the typing would need to be a union of the ABC and str.

If you are fine with me using the above method, I wouldn't mind submitting a pr to resolve your issue.