Add PEP561 type marker

[palango]

What was wrong?

Related to Issue #1582

How was it fixed?

This was my first try, but it doesn't seem to work. When running make dist I see the following line:

...
adding 'web3/net.py'
adding 'web3/parity.py'
adding 'web3/pm.py'
adding 'web3/py.typed'
adding 'web3/testing.py'
adding 'web3/types.py'
...

But when I later look into the source package, it's not there.

Todo:

• Add entry to the release notes

Cute Animal Picture

[kclowes]

@palango I'm pretty new to typing myself, but looking at a similar PR in the eth-abi package, I think what you have is all that you need to do. I ran a make sdist for eth-abi, and it doesn't show eth-abi/py.typed in the source package either. @carver do you have any other feedback/insight?

[cburgdorf]

The change looks in fact correct. A simple way to verify it would be to install web3 at this commit via pip, import some web3 functions, call reveal_type(some_function) and run mypy on it. If it shows the correct types, it is working, if it reports Any it isn't.

[kclowes]

Aha! Thanks @cburgdorf!

[palango]

Thanks @cburgdorf

I tested with a small script on a venv on my branch and master.

from web3 import Web3

a = Web3()
b = a.eth.getTransactionReceipt('test')

reveal_type(b)
reveal_type(a.eth.getTransactionReceipt)

Master

mypy test.py
test.py:1: error: Cannot find implementation or library stub for module named 'web3'
test.py:1: note: See https://mypy.readthedocs.io/en/latest/running_mypy.html#missing-imports
test.py:6: note: Revealed type is 'Any'
test.py:7: note: Revealed type is 'Any'
Found 1 error in 1 file (checked 1 source file)

This branch

 mypy test.py
test.py:4: error: Argument 1 to "getTransactionReceipt" of "Eth" has incompatible type "str"; expected "Union[Hash32, HexBytes, HexStr]"
test.py:6: note: Revealed type is 'TypedDict('web3.types.TxReceipt', {'blockHash': hexbytes.main.HexBytes, 'blockNumber': builtins.int, 'contractAddress': Union[eth_typing.evm.ChecksumAddress, None], 'cumulativeGasUsed': builtins.int, 'gasUsed': web3.types.Wei, 'from': eth_typing.evm.ChecksumAddress, 'logs': builtins.list[TypedDict('web3.types.LogReceipt', {'address': eth_typing.evm.ChecksumAddress, 'blockHash': hexbytes.main.HexBytes, 'blockNumber': eth_typing.evm.BlockNumber, 'data': eth_typing.encoding.HexStr, 'logIndex': builtins.int, 'payload': hexbytes.main.HexBytes, 'removed': builtins.bool, 'topic': hexbytes.main.HexBytes, 'topics': typing.Sequence[hexbytes.main.HexBytes], 'transactionHash': hexbytes.main.HexBytes, 'transactionIndex': builtins.int})], 'logsBloom': hexbytes.main.HexBytes, 'root': eth_typing.encoding.HexStr, 'status': builtins.int, 'to': eth_typing.evm.ChecksumAddress, 'transactionHash': hexbytes.main.HexBytes, 'transactionIndex': builtins.int})'
test.py:7: note: Revealed type is 'def (transaction_hash: Union[eth_typing.evm.Hash32, hexbytes.main.HexBytes, eth_typing.encoding.HexStr]) -> TypedDict('web3.types.TxReceipt', {'blockHash': hexbytes.main.HexBytes, 'blockNumber': builtins.int, 'contractAddress': Union[eth_typing.evm.ChecksumAddress, None], 'cumulativeGasUsed': builtins.int, 'gasUsed': web3.types.Wei, 'from': eth_typing.evm.ChecksumAddress, 'logs': builtins.list[TypedDict('web3.types.LogReceipt', {'address': eth_typing.evm.ChecksumAddress, 'blockHash': hexbytes.main.HexBytes, 'blockNumber': eth_typing.evm.BlockNumber, 'data': eth_typing.encoding.HexStr, 'logIndex': builtins.int, 'payload': hexbytes.main.HexBytes, 'removed': builtins.bool, 'topic': hexbytes.main.HexBytes, 'topics': typing.Sequence[hexbytes.main.HexBytes], 'transactionHash': hexbytes.main.HexBytes, 'transactionIndex': builtins.int})], 'logsBloom': hexbytes.main.HexBytes, 'root': eth_typing.encoding.HexStr, 'status': builtins.int, 'to': eth_typing.evm.ChecksumAddress, 'transactionHash': hexbytes.main.HexBytes, 'transactionIndex': builtins.int})'

So this seems to work as expected. Would it be a lot of effort to create a release with this change?

[kclowes]

Thanks @palango! And thanks for the input @carver and @cburgdorf!