Add pyright as a pre-commit check

[happz]

Another pair of eyes, pyright is a type check plus a bit more, and will inspect the code from slightyl different point of view. As a result, it will report issues mypy cannot spot, or cannot spot yet because the set of implemented checks is simply different.

The slow, gradual approach is the key here, like the one we know from mypy introduction, and slowly files and packages will get covered.

[happz]

@martinhoyer would you have an experience with Pyright? I would like to add it as a complement to mypy, especially when it's able to spot some issues mypy does not report (yet?). However, the pre-commit integration is not as simple.

[martinhoyer]

@martinhoyer would you have an experience with Pyright?

Never used it myself, but read the discussion about pre-commit hook on pyright github. Looks like the wrapper you're using is the way for the foreseeable future. They mention it in their docs as well. (as I'm sure you're already know)
https://github.com/microsoft/pyright/blob/main/docs/ci-integration.md#running-pyright-as-a-pre-commit-hook

I wonder if we can tell pre-commit to re-use the mypy virtualenv, instead of creating new one with all those dependencies.

[happz]

@martinhoyer would you have an experience with Pyright?

Never used it myself, but read the discussion about pre-commit hook on pyright github. Looks like the wrapper you're using is the way for the foreseeable future. They mention it in their docs as well. (as I'm sure you're already know) https://github.com/microsoft/pyright/blob/main/docs/ci-integration.md#running-pyright-as-a-pre-commit-hook

Yep, I've read this one. The wrapper on its own would be fine, I dislike the duplication of requirements, but there seems to be no easy way around this issue :/

I wonder if we can tell pre-commit to re-use the mypy virtualenv, instead of creating new one with all those dependencies.

Maybe, I have no idea, but I will give it a try. On the other hand, mypy check is probably not installing any tmt dependencies, just Click and a pile of stubs. But yeah, we there would be some overlap, sharing might be nice.

[happz]

Ok, trying to get this one merged in its current state: duplication of requirements between pyproject.toml, mypy and pyright, documented, marked as something to fix later. I for one can live with this temporarily, the eventual goal is to have just one place where requirements live, maybe we could teach hatch & pre-commit to play nicely together.

WRT files to check, the check does nothing as of now. It's like the mypy introduction, does nothing, all files are ignored, and we'll be fixing files and modules as we go, making them pass both mypy and pyright checks.

[psss]

Looks good, just two typos and one question.