Full type hinting

Summary

Typehinting everything in the library as per PEP 484

What is the feature request for?

The core library

The Problem

Pycharm’s inferred typehints don’t seem to work as well as they should due to the fact the library doesn’t use typehints are per PEP 484. It seems to be able to somewhat infer them from the ReST-style docs, but not fully. I’ve not seen this problem with typehints.

The particular line from the code

    def add_listener(self, func, name=None):
        """The non decorator alternative to :meth:`.listen`.

        Parameters
        -----------
        func: :ref:`coroutine <coroutine>`
            The function to call.
        name: Optional[:class:`str`]
            The name of the event to listen for. Defaults to ``func.__name__``.

The Ideal Solution

If name was typehinted as name: str = None, pycharm would be able to infer it correctly.

The Current Solution

The current solution(s) to the problem would be ignoring the warnings, or disabling them entirely. While these are completely valid solutions, they seem suboptimal, especially when working with an undocumented version, i.e., 2.0.

Additional Context

No response

[crazygmr101]

While you could wait until 2.0 for full/official typings of the library, @bryanforbes has kindly been maintaining stubs for 1.x versions of the library, which can be seen here.

I’m actually running a fork of 2.0, trying to keep up with Interactions and the latest changes. I’ve written a small library to handle buttons and such, but I know this lib would more than likely do it better 😛

[NCPlayz]

While you could wait until 2.0 for full/official typings of the library, @BryanForbes has kindly been maintaining stubs for 1.x versions of the library, which can be seen here.