TYP: numba stub #44233
TYP: numba stub #44233
Conversation
simonjayhawkins
added
Typing
| @numba.jit(numba.boolean(numba.int64[:]), nopython=True, nogil=True, parallel=False) | ||
| @numba.jit( | ||
| # error: Any? not callable | ||
| numba.boolean(numba.int64[:]), # type: ignore[misc] |
There was a problem hiding this comment.
partial stub does not include numba types so they resolve to Any (and not callable)
@mroeschke not sure of best practice, is it preferable to use the numba types instead of the string representation for production code?
There was a problem hiding this comment.
Either is recommended in the docs. Strings just have some parsing overhead looking at the code, but probably just fine to use the string representation if it makes typing here easier.
There was a problem hiding this comment.
I think we could evolve the stubs as needed so will leave as-is for now.
stubs/numba.pyi
Outdated
| # TODO: If a callable is provided it will be called with the call expression | ||
| # node that is requesting inlining, the caller's IR and callee's IR as | ||
| # arguments, it is expected to return Truthy as to whether to inline. | ||
| target: Literal["cpu", "gpu", "npyufunc", "cuda"] = ..., # deprecated |
There was a problem hiding this comment.
we could leave this out, we don't currently use this and since it is deprecated may want to not do so.
There was a problem hiding this comment.
Generally we only use signature_or_function, nopython, nogil, parallel if that would simplify the typing. looplift may be utilized in the future.
There was a problem hiding this comment.
There's an open issue on numba tracker numba/numba#7424
The open PR to fix only deals with the decorator preserving types
I will also be using this stub in my numba branch and adding additional types as needed. Will look at the types for the numba types next if this PR is accepted.
It maybe that being more complete helps the community to share effort until official numba stubs are available.
stubs/numba.pyi
Outdated
| | list[numba.core.types.abstract.Type] = ..., | ||
| locals: dict = ..., # TODO: Mapping of local variable names to Numba types | ||
| cache: bool = ..., | ||
| pipeline_class: numba.compiler.CompilerBase = ..., |
There was a problem hiding this comment.
this will resolve to Any
stubs/numba.pyi
Outdated
| def jit( | ||
| signature_or_function: str | ||
| | list[str] | ||
| | numba.core.types.abstract.Type |
There was a problem hiding this comment.
This is added for completeness but will resolve to Any.
pyproject.toml
Outdated
| @@ -60,6 +60,7 @@ markers = [ | |||
|
|
|||
| [tool.mypy] | |||
| # Import discovery | |||
| mypy_path = "stubs" | |||
There was a problem hiding this comment.
microsoft/pyright#2514 (comment)
stubPath = "stubs" for pyright or rename the folder to typings.
There was a problem hiding this comment.
Probably also need to append "stubs" to include to make sure that pyright also checks stubs itself for any errors/suggestions.
There was a problem hiding this comment.
done for mypy. what do I need to change for pyright?
There was a problem hiding this comment.
I think the following should work
include = ["pandas", "stubs"]
stubPath = "stubs"
You can probably also remove the pyright file-based ignore comments: pandas/core/window/numba_.py and pandas/core/util/numba_.py
There was a problem hiding this comment.
If it is setup correctly, pyright will complain about the incomplete __getattr__ (add a file-based ignore comment).
|
There are a few more cases of pandas/core/window/online.py: @numba.jit(nopython=nopython, nogil=nogil, parallel=parallel) # type: ignore[misc] edit: because of |
|
@twoertwein merge when ready here. can certainly be followups to fix more stuff. |
partial stub to preserve type signatures for decorated functions.
draft since will rebase once #43828 is merged.
cc @twoertwein @mroeschke