Add type hints

[RobertCraigie]

Would be really nice for the Python API if this project provided type hints along with a py.typed marker file :)

In terms of the actual implementation, the easiest solution, due to the multitude of overloads on the subprocess functions, would probably be to alias them, e.g.

import subprocess
from typing import TYPE_CHECKING

if TYPE_CHECKING:
  run = subprocess.run
  ...
else:
  def run(args, **kwargs):
    return subprocess.run([path, *args], **kwargs)
  ...

For context, I'm planning on supporting this package in https://github.com/RobertCraigie/prisma-client-py which is very strictly typed which means Pyright complains that this package is missing type hints or if any method / variable I access does not have a known type.

from nodejs import node  # error: Stub file not found for "nodejs"

[samwillis]

Ah, awesome! I had gone looking for how best to add type annotations to this and wasn't sure the bast way. It looks like that would be compatible all the way back to 3.5 too, so that good.

I shall make those changes, Thanks!

[samwillis]

Hi @RobertCraigie,

I have just released a new version that adds these type aliases and the import pattern from your other issue. If you could let me know how you get on with Pyright, that would be awesome!

[RobertCraigie]

@samwillis This looks great, thanks for working on this!

Still seeing some errors with Pyright:

import nodejs  # error: Stub file not found for "nodejs"

This is because the package is missing an empty py.typed file in the root of the package, e.g. https://github.com/RobertCraigie/prisma-client-py/blob/main/src/prisma/py.typed. This is very easy to forget to do and I suspect mypy will report an error for this as well.

import nodejs

nodejs.run(["foo"])  # error:  "run" is not exported from module "nodejs"

This is because of the way the imports are re-exported in the __init__.py file. For pyright to consider an import declaration to be exported then it has to be aliased, e.g.

from . import node as node