pyright is missing from optional dependencies + wrong `check` env dependencies

[benoit74]

In pyproject.toml, pyright is not present as an optional dependencies.

And hatch check environment depends from test optional dependencies which it does not use.

[rgaudin]

It's on purpose. Pyright is a node tool. That python package is just a wrapper that installs it and walk over your PATH to find it. While I think the intention is good, I want to control where this tool is going to be installed and when to upgrade. It can be done with the wrapper but it requires setting environment variables… which is outside the scope of our python setup and thus cancels the benefit of it.

Without the wrapper

• first run of checks will probably fail with “pyright: command not found”
• dev has to install pyright (relatively straightforward but we can add a paragraph in our bootstrap wiki
• other runs for all our projects would use it.
• dev has control over where and how it is installed and can upgrade accordingly

With the wrapper

• first run in every project will install node and pyright in an unknown location
• dev thinks its a python package while it's not
• wrapper phones home to check if pyright update is available
• wrapper automatically updates pyright when available
• this happens individually in every project

As written above, it's possible to control where to install, but dev has to set some wrapper-specific environment variables and make sure those are exposed for every pyright call.

I find the no-wrapper approach cleaner and more flexible but I agree it introduce an initial fail. If that's a concern, we could react to it missing in the invoke tasks and display a dev-friendly message leading to the install documentation.

What do you think?

[rgaudin]

We could also have the wrapper in a feature and advertise it should pyright call failed due to missing binary.

[benoit74]

I understand most of your concerns, but (yes, there is a but 🤣)

• not using the wrapper also means in many cases not having a consistent pyright version between CI and dev environment ; this is made especially complex when jumping from one project to another one
• the wrapper install node and pyright only if missing
• the wrapper install pyright in a well known location, either PYRIGHT_PYTHON_CACHE_DIR if set, or elseXDG_CACHE_HOME if set, or else ~/.cache ; this avoids having many times the same version which is meaninfull
• the wrapper does not automatically updates pyright, it keeps in sync the wrapper and the tool versions and warns you that a new version is available (which might be a bit annoying, but ok)

  
  > pyright --version
  WARNING: there is a new pyright version available (v1.1.312 -> v1.1.317).
  Please install the new version or set PYRIGHT_PYTHON_FORCE_VERSION to `latest`

pyright 1.1.312

- the wrapper works well when offline, timeout is set at 1 sec (obviously two stuff are tried since it took 2 secs in my test)

time pyright 0 errors, 0 warnings, 0 informations pyright 2.02s user 0.15s system 146% cpu 1.474 total

This first point is a significant concern for me, as a developer I usually prefer to not mind about such details, and as a maintainer I would prefer to not have to explain this to every new developer on a project.

And yes, I added the wrapper in a feature in my PR.

[rgaudin]

OK I'm sold 😉 Thanks for the details. I clearly misread the README.