Add documentation for `TypedDict` return values of methods usable by 3rd parties

[pipermerriam]

What was wrong?

While making an application that uses the web3.py library I found myself really wishing there were strong return types for the various methods like w3.eth.get_block(...). Basically, I want to have something like a TypedDict which strongly defines the return types of the various web3 methods.

How can it be fixed?

The web3 library should have TypedDict types for all of the various return types that return a mapping. These types should be importable by 3rd party libraries (probably via web3.typing) and should also be documented (probably in a new section of the documentation focused on how to do typing for 3rd party applications).

[pipermerriam]

I realize these are already present under web3.types

Looks like the primary thing would be to document them.

[covendev]

I would like to take this up if the issue is still open.

[kclowes]

Yep, feel free to make a PR! Thanks @Rnamita!

[NewMountain]

I'd be interested in helping here, but it's not totally clear what the desired outcome is. Is the ask to add type annotations to all files in /docs or specifically to add a new section to the docs making the fact there are types explicit?

[kclowes]

Awesome, thanks @NewMountain! Maybe both? IMHO, a new section in the docs seems like lower hanging fruit, so maybe we can start with that and then we can add types to the rest of the docs in a later PR if that would be useful. How does that sound?

[theyashwanthsai]

Hey I am interested in trying it out. Can I take this up?

[1VIP1786]

i will fix this

[xdatalinq]

Has this issue already been informally assigned to anyone?

[NewMountain]

Hi all. Apologies. When I committed to this, I was in a very different situation. Please do not block on me.

[pacrob]

It has not been assigned, all yours, @xdatalinq

[xdatalinq]

@pacrob is there a community/project discord I could ask a few questions in? This is my first "public" commit, I'd like to ask few questions to get a sense of how much work I'm signed up for and precisely what's expected so I actually do a good job.

[pacrob]

Our Discord