-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for TypedDict
return values of methods usable by 3rd parties
#1628
Comments
I realize these are already present under Looks like the primary thing would be to document them. |
TypedDict
types for return values of methods usable by 3rd parties.TypedDict
return values of methods usable by 3rd parties
I would like to take this up if the issue is still open. |
Yep, feel free to make a PR! Thanks @Rnamita! |
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 |
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? |
Hey I am interested in trying it out. Can I take this up? |
i will fix this |
Has this issue already been informally assigned to anyone? |
Hi all. Apologies. When I committed to this, I was in a very different situation. Please do not block on me. |
It has not been assigned, all yours, @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. |
Our Discord |
Is this issue still open ? If so I would like to help implement this. |
Yep, still available! |
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 aTypedDict
which strongly defines the return types of the various web3 methods.How can it be fixed?
The
web3
library should haveTypedDict
types for all of the various return types that return a mapping. These types should be importable by 3rd party libraries (probably viaweb3.typing
) and should also be documented (probably in a new section of the documentation focused on how to do typing for 3rd party applications).The text was updated successfully, but these errors were encountered: