Unparameterized `np.ndarray` typings produce "Type of ... is partially unknown" Pyright type errors.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- numpy, python
- Domain
- developer-experience, tooling
Research direction
Start by reproducing the issue with example.py, the strict Pyright configuration, and the LinearRegression.fit entry point. Trace the private MatrixLike alias in the sklearn.linear_model stubs, identify the unparameterized ndarray annotations involved, and run Pyright again to confirm the partially-unknown errors are resolved.
Written by the indexing model from the issue text.
Description
Problem
The type np.ndarray is stubbed in this library as:
class ndarray(_ArrayOrScalarCommon, Generic[_ShapeType, _DType_co]):
...
Throughout these stubs, the type np.ndarray is used without provided type parameters, seemingly with the expectation that this is treated as np.ndarray[Any, Any] (or more properly np.ndarray[object. object]). However, Pyright in strict mode alternately interprets this as np.ndarray[Unknown, Unknown].
As a result, every method that involves np.ndarray or a type alias which includes it produces a partially-unknown-type error:
Example Reproduction
For example, if we take the following simple file example.py...
import numpy as np
from typings.sklearn.linear_model import LinearRegression
def example():
x = np.array([1, 2, 3, 4, 5])
y = np.array([2, 4, 6, 8, 10])
linreg = LinearRegression()
linreg.fit(x, y)
❯ pyright src/path/to/example.py
src/path/to/example.py
src/path/to/example/example.py:11:5 - error: Type of "fit" is partially unknown
Type of "fit" is "(X: ndarray[Unknown, Unknown] | DataFrame | spmatrix | Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], y: ndarray[Unknown, Unknown] | DataFrame | spmatrix | Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], sample_weight: Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes] | None = None) -> LinearRegression"
In this case, the error occurs because the type of fit is:
def fit(
self: LinearRegression_Self,
X: MatrixLike | ArrayLike,
y: MatrixLike | ArrayLike,
sample_weight: None | ArrayLike = None,
) -> LinearRegression_Self:
...
And in turn MatrixLike is a (private) typealias that resolves to:
MatrixLike = np.ndarray | pd.DataFrame | spmatrix
Resolution
At least for this example, changing that type alias as follows resolves the type error.
MatrixLike = np.ndarray | pd.DataFrame | spmatrix
System Details:
OS: MacOS Sonoma 14.1.2
Python: CPython 3.12.1
Pyright: 1.1.358
Pyright configuration:
[tool.pyright]
include = ["./src", "./tests"]
stubPath = "./typings"
typeCheckingMode = "strict"
reportMissingImports = true
reportMissingTypeStubs = true
pythonVersion = "3.12"
- Dominant language
- Python
- Stars
- 304
- Forks
- 104
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/python-type-stubs
-
Maintenance Status Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
microsoft/python-type-stubs#395 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 58/100
microsoft/python-type-stubs#392 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
microsoft/python-type-stubs#345 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
microsoft/python-type-stubs#315 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
microsoft/python-type-stubs#211 · 8 comments · 29 reactions ·
All issues in microsoft/python-type-stubs
Similar issues
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100