Type Hints or Library Stubs

[gao462]

Is there a plan to have torch_geometric being fully type hinted or provide library stubs?

I want to pass the static typing check (e.g., mypy, pytype) without adding # type: ignore to torch_geometric.

[rusty1s]

I would say this is probably done to 70%. If you are interested, we can finish the remaining part together.

[rusty1s]

Started to work on this here: #3461

[mihaic]

As far as I understand, you need to ship a py.typed file with PyG to enable type checking:
https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages

Also, the current Mypy test is failing (but appears to be passing because continue-on-error: true), e.g.:
https://github.com/pyg-team/pytorch_geometric/actions/runs/5874955029/job/15930495343#step:5:13

[akihironitta]

@mihaic Thank you for pointing it out. Will be addressed via #8254.

[jonasjuerss]

Sorry for the late follow-up @akihironitta, but was adding py.typed actually ever addressed? I found that I had to manually:

[[tool.mypy.overrides]]
module = ["torch_geometric.*"]
follow_untyped_imports = true

in my pyproject.toml