Skip to content
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

mypy type checking seems to break in strict mode -- a mypy bug? #52

Open
bluenote10 opened this issue Dec 22, 2022 · 2 comments
Open

mypy type checking seems to break in strict mode -- a mypy bug? #52

bluenote10 opened this issue Dec 22, 2022 · 2 comments
Labels
question User queries

Comments

@bluenote10
Copy link

Following up on patrick-kidger/torchtyping#41 I'm trying the same things here. However I'm not really having a big success so far with mypy. Am I doing anything wrong?

import torch
from jaxtyping import Float

dim1 = "dim1"


# Expected to work but fails with:
# error: Returning Any from function declared to return "Tensor"
def simple_test_a(x: Float[torch.Tensor, "dim1"]) -> torch.Tensor:
    return x


# Expected to work but fails with:
# error: Returning Any from function declared to return "float"
def simple_test_b(x: Float[torch.Tensor, "dim1"]) -> float:
    return x.item()


# Expected to error, but passes type checking
def simple_test_c(x: Float[torch.Tensor, "dim1"]) -> None:
    x.asdfasdfasdf()

VSCode (pyright) seems to do a little better, but apparently doesn't like the import:

image

@patrick-kidger
Copy link
Owner

patrick-kidger commented Dec 22, 2022

I can't replicate your issue I'm afraid. Running:

import torch
from jaxtyping import Float

def simple_test_a(x: Float[torch.Tensor, "dim1"]) -> torch.Tensor:
    reveal_type(x)
    return x

def simple_test_b(x: Float[torch.Tensor, "dim1"]) -> float:
    reveal_type(x)
    return x.item()

def simple_test_c(x: Float[torch.Tensor, "dim1"]) -> None:
    reveal_type(x)
    x.asdfasdfasdf()

prints:

tmp.py:5: note: Revealed type is "torch._tensor.Tensor"
tmp.py:9: note: Revealed type is "torch._tensor.Tensor"
tmp.py:13: note: Revealed type is "torch._tensor.Tensor"
tmp.py:14: error: "Tensor" has no attribute "asdfasdfasdf"  [attr-defined]

This is with versions:

torch: 1.13.1
jaxtyping: 0.2.9
mypy: 0.991

As for VSCode, this issue is due to a now-resolved bug in pyright: microsoft/pyright#4287 . Try updating your pyright version.

@bluenote10
Copy link
Author

bluenote10 commented Dec 22, 2022

Interesting, it seems to be related with strict mode. I can replicate your output when I run mypy in non-strict mode:

test.py:6: note: Revealed type is "torch._tensor.Tensor"
test.py:11: note: Revealed type is "torch._tensor.Tensor"
test.py:16: note: Revealed type is "torch._tensor.Tensor"
test.py:17: error: "Tensor" has no attribute "asdfasdfasdf"  [attr-defined]

As soon as I add a mypy.ini containing

[mypy]
strict = True

the output becomes:

test.py:5: error: Name "dim1" is not defined  [name-defined]
test.py:6: note: Revealed type is "Any"
test.py:7: error: Returning Any from function declared to return "Tensor"  [no-any-return]
test.py:10: error: Name "dim1" is not defined  [name-defined]
test.py:11: note: Revealed type is "Any"
test.py:12: error: Returning Any from function declared to return "float"  [no-any-return]
test.py:15: error: Name "dim1" is not defined  [name-defined]
test.py:16: note: Revealed type is "Any"

Note that even the revealed types change.

Using exactly the same package versions.

Looks like a mypy bug?

@bluenote10 bluenote10 changed the title Basic mypy support? mypy type checking seems to break in strict mode -- a mypy bug? Dec 23, 2022
@patrick-kidger patrick-kidger added the question User queries label Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question User queries
Projects
None yet
Development

No branches or pull requests

2 participants