ApeWorX / ApeWorX/web3.py

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

Open
#1,628 18 comments 0 reactions 0 assignees View on GitHub
Good First Issue priority: p3 nice to have
Dominant language
Python
Stars
5.5k
Forks
1.7k
Avg merge
3d 10h
Merged PRs (30d)
2

Description

### 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).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.