Repository navigation
Conversation
|
|
|
Thanks for continuing to push this forward Rok! I think this PR is a great next step and is quite clear to review. I have checked out the PR locally and started with running type checkers ( The reason for these warnings and errors in I propose to push the changes directly if we agree the additions makes sense. Meanwhile I will continue with running the |
|
I have run I have also run mypy's stubtest with Besides the reports mentioned above which will be fixed in subsequent PRs, stubtest did found one bug in pyarrow: Note missing "L" in "Decimal". I will work on the fix for this now and would suggest to add it as part of this PR. Can commit directly, if that is ok. |
|
I've run Running on editable dev build 27, with pyright==1.1.414 in my conda env, I also hit errors |
That makes sense and please go for it. I think we should aim for
Huh. I've never noticed these were missing. Given we're not really using them as types I'd skip them if we can.
Huh. Let's do the fix as separate PR, but also include a fix here? (And we'll just rebase over the actual fix on main)
I'm not sure we want (can) bring in ruff as a CI dependency. However we should autoformat before we merge, so we don't do it later and change history for no good reason. So I propose one of you runs the ruff formatter and commits the change into this branch. |
I think
Sounds good. Will open an issue and a PR and add a fix here also. |
Yeah, they are internal and exposed through |
Ok, I'll do that reformatting in a bit. |
|
I have started with reviewing pyarrow tests with running click for output$ mypy --check-untyped-defs --warn-unused-ignores pyarrow/tests/test_array.py
pyarrow/tests/test_array.py:21: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:22: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:25: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:80: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:790: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:986: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:1300: error: List item 3 has incompatible type "None"; expected "int" [list-item]
pyarrow/tests/test_array.py:1302: error: List item 1 has incompatible type "None"; expected "list[tuple[bytes, int]]" [list-item]
pyarrow/tests/test_array.py:1313: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:1320: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:1324: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:1348: error: List item 0 has incompatible type "None"; expected "list[tuple[bytes, int]]" [list-item]
pyarrow/tests/test_array.py:1348: error: List item 1 has incompatible type "None"; expected "list[tuple[bytes, int]]" [list-item]
pyarrow/tests/test_array.py:1362: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:2513: error: Need type annotation for "buffers" (hint: "buffers: list[<type>] = ...") [var-annotated]
pyarrow/tests/test_array.py:2539: error: "object" has no attribute "dtype" [attr-defined]
pyarrow/tests/test_array.py:2541: error: Value of type "object" is not indexable [index]
pyarrow/tests/test_array.py:2542: error: Value of type "object" is not indexable [index]
pyarrow/tests/test_array.py:2543: error: Value of type "object" is not indexable [index]
pyarrow/tests/test_array.py:2885: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:2917: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:2938: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:2939: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:3183: error: Value of type "object" is not indexable [index]
pyarrow/tests/test_array.py:3299: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:3720: error: Incompatible types in assignment (expression has type "None", variable has type "ndarray[tuple[Any, ...], dtype[Any]]") [assignment]
pyarrow/tests/test_array.py:3729: error: Value of type "object" is not indexable [index]
pyarrow/tests/test_array.py:3740: error: Value of type "object" is not indexable [index]
pyarrow/tests/test_array.py:3817: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:4004: error: Incompatible types in assignment (expression has type "MyArrayInvalid", variable has type "MyArray") [assignment]
pyarrow/tests/test_array.py:4017: error: Incompatible types in assignment (expression has type "MyArray2", variable has type "MyArray") [assignment]
pyarrow/tests/test_array.py:4031: error: Incompatible types in assignment (expression has type "MyArray3", variable has type "MyArray") [assignment]
pyarrow/tests/test_array.py:4095: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:4099: error: Unused "type: ignore" comment [unused-ignore]
pyarrow/tests/test_array.py:4315: error: List item 3 has incompatible type "None"; expected "int" [list-item]
pyarrow/tests/test_array.py:4319: error: List item 5 has incompatible type "None"; expected "int" [list-item]
pyarrow/tests/test_array.py:4324: error: List item 2 has incompatible type "None"; expected "int" [list-item]
pyarrow/tests/test_array.py:4324: error: List item 4 has incompatible type "None"; expected "int" [list-item]
pyarrow/tests/test_array.py:4395: error: List item 1 has incompatible type "None"; expected "int" [list-item]
pyarrow/tests/test_array.py:4407: error: List item 0 has incompatible type "None"; expected "int" [list-item]
Found 40 errors in 1 file (checked 1 source file)Type checkers are currently configured to skip I propose to temporarily add the |
|
Another thing: I can't run |
|
Oh, I was too fast here. Unfortunately Would it make sense to remove I will leave this for discussion and start with reading the stubs and comparing them with the APIs, starting with |
|
Ignore statements not being needed is more likely due to changes to typecheckers than due to changes in stubs. Or they might be needed once we import other parts of the library. Also note camel cased (e.g. reportArgumentType) ignores are likely coming from pyright. So if mypy thinks it's a redundant ignore you might want to check pyright too. |
Let's rather remove |
|
OK, agree, when reviewing I plan to do that later and am focusing on reading the stubs currently. |
|
Ehhh... I've fallen into this interesting rabbit hole - There are over 1.5k mypy errors % mypy --check-untyped-defs --warn-unused-ignores pyarrow/tests/test_convert_builtin.py
pyarrow/tests/test_convert_builtin.py:78: error: Module not callable [operator]
pyarrow/tests/test_convert_builtin.py:79: error: Module not callable [operator]
...
pyarrow/tests/test_convert_builtin.py:168: error: Module not callable [operator]
...
Found 321 errors in 1 file (checked 1 source file)
% mypy --check-untyped-defs --warn-unused-ignores pyarrow/tests/test_*.py
Found 1866 errors in 35 files (checked 44 source files)
% ... | grep -c "Module not callable"
1562test_convert_builtin.py:168 : pa.array(... A stub So I propose we reintroduce subfolder |
|
Just to note: with commit eda3425 stubs |
|
@tadeja I suppose the |
|
@jorisvandenbossche oh, yes, I think |
|
@tadeja @rok I have checked typed.pyi and decided to push a commit (4b97c69) after all =) Instead of suggestions I will post the reasoning behind the changes here:
Future TODO:
I have run
|
|
I suppose this is now ready for a wider review! (See #55264 (comment) for potentially useful context) |
@tadeja I think those can partly also be solved by not actually using concrete types like (another point here is that, if we add a specific element type, we could probably say the elements should be |
paddyroddy
left a comment
There was a problem hiding this comment.
No blockers, just listed some thoughts.
| # The previous step already ran the ruff hooks. | ||
| SKIP: ruff-check,ruff-format | ||
| run: | | ||
| pre-commit run --hook-stage manual python-stubs --all-files --color=always --show-diff-on-failure |
There was a problem hiding this comment.
Would recommend prek over pre-commit. More feature rich, friendlier community and faster. Acts as a drop-in replacement.
| pre-commit run --hook-stage manual python-stubs --all-files --color=always --show-diff-on-failure | |
| prek run --hook-stage manual python-stubs --all-files --color=always --show-diff-on-failure |
There was a problem hiding this comment.
https://github.com/j178/prek looks great.
We currently use pre-commit a lot (even in CI where better performance would come in handy) and it'd might make sense to completely switch to prek elsewhere too.
| # modules that aren't annotated yet, e.g. pyarrow.compute, are treated as Any | ||
| # (see python/pyproject.toml). | ||
| - repo: https://github.com/astral-sh/ruff-pre-commit | ||
| rev: v0.17.2 |
There was a problem hiding this comment.
Are we keeping these up-to-date anywhere? @renovatebot or @dependabot as options, I guess @pre-commit-ci too (although not a fan of anything @pre-commit personally).
There was a problem hiding this comment.
Given pace of typechecker development this might be a good idea. Added 34f5978, but we might need to discuss this in a wider setting? @jorisvandenbossche @AlenkaF @tadeja what do you think?
There was a problem hiding this comment.
The pinned version here in pre-commit is not really related to pace of typechecker development, it is just pinning the ruff formatter.
But anyway, automating the updates of our pre-commit hooks seems a good idea.
There was a problem hiding this comment.
Ah yes, sorry, I was going for the #55264 (comment) comment.
| @@ -0,0 +1,20 @@ | |||
| # Type checkers and the type stubs of PyArrow's dependencies, pinned so that | |||
There was a problem hiding this comment.
How will these versions be maintained?
There was a problem hiding this comment.
Could this instead be done through a lock file (uv.lock for example)?
There was a problem hiding this comment.
Using uv.lock might be a good idea, but we're not using uv widely enough yet I think. Added another dependabot 0733c1d to track versions.
@jorisvandenbossche @AlenkaF @tadeja what do you think?
There was a problem hiding this comment.
My preference would be to keep the current requirements file. That is a bit easier to re-use if you are not using uv for development locally (we don't even mention uv in our contributing docs, IMO for good reason given all the C++ dependencies)
OK, just remembered to post this - verified and fixed to a more suitable |
Add a monthly, grouped Dependabot update for the hook revisions in .pre-commit-config.yaml. clang-format is excluded because bumping it reformats the codebase.
Add a monthly, grouped Dependabot update for the pins in python/requirements-stubs.txt. The allow list keeps it away from the other requirements files in python/.
|
Just as an fyi - there's the preview-docs page with the Type checking section which is PR's |
|
@raulcd I think we're slowly converging here. Could you please look at and bless (or not) the CI or rather non-annotations changes? :) |
| python-stubs: | ||
| patterns: | ||
| - "*" | ||
| # Only update the pins of python/requirements-stubs.txt. |
There was a problem hiding this comment.
Is it possible to more explicitly "include" just this file? (to avoid having to list all those manually, and also to avoid conflicts. For example, I think we should also pin numpy, but that is also included in some of the other requirements files)
There was a problem hiding this comment.
Quick search says we could use exclude-paths instead of includes, see b816747.
Replace the allow list with exclude-paths, so Dependabot reads only python/requirements-stubs.txt in python/ and any package pinned there (e.g. numpy) is updated without touching the other requirements files.
| types-python-dateutil==2.9.0.20261021 | ||
| types-requests==2.33.0.20261006 | ||
| # Annotated dependencies of the type stub tests, usually installed already. | ||
| numpy |
There was a problem hiding this comment.
I think it might be better to pin numpy as well. I think in some earlier comments in the PR thread, it was already mentioned that you get different errors with different versions of numpy (that is also my experience with seeing people maintain the type hints in pandas, that a numpy update typically requires updating some type hints (or ignores) as well)
Numpy will indeed already be installed typically when calling this (from python_test_type_annotations.sh), but then it will just update whatever version is already installed, which is fine?
There was a problem hiding this comment.
| mypy==2.4.0 | ||
| pandas-stubs==3.0.5.260914 | ||
| pyright==1.1.414 | ||
| # The scipy extra installs the matching scipy, which the type stub tests import. | ||
| scipy-stubs[scipy]==1.17.1.5 | ||
| ty==0.0.99 | ||
| types-cffi==2.1.0.20260827 | ||
| types-psutil==7.2.2.20260906 | ||
| types-python-dateutil==2.9.0.20261021 | ||
| types-requests==2.33.0.20261006 | ||
| # Annotated dependencies of the type stub tests, usually installed already. | ||
| numpy |
There was a problem hiding this comment.
| mypy==2.4.0 | |
| pandas-stubs==3.0.5.260914 | |
| pyright==1.1.414 | |
| # The scipy extra installs the matching scipy, which the type stub tests import. | |
| scipy-stubs[scipy]==1.17.1.5 | |
| ty==0.0.99 | |
| types-cffi==2.1.0.20260827 | |
| types-psutil==7.2.2.20260906 | |
| types-python-dateutil==2.9.0.20261021 | |
| types-requests==2.33.0.20261006 | |
| # Annotated dependencies of the type stub tests, usually installed already. | |
| numpy | |
| # NumPy's annotations change between releases, which changes the results of | |
| # the type checkers. | |
| numpy==2.4.6 | |
| mypy==2.4.0 | |
| pandas-stubs==3.0.5.260914 | |
| pyright==1.1.414 | |
| # The scipy extra installs the matching scipy, which the type stub tests import. | |
| scipy-stubs[scipy]==1.17.1.5 | |
| ty==0.0.99 | |
| types-cffi==2.1.0.20260827 | |
| types-psutil==7.2.2.20260906 | |
| types-python-dateutil==2.9.0.20261021 | |
| types-requests==2.33.0.20261006 | |
| # Annotated dependencies of the type stub tests, usually installed already. |
Rationale for this change
This is the next step in adding type annotations to PyArrow (#32609). It merges #49103 (internal type system stubs) and #49193 (core data structures) because the two depend on each other and can't be type checked separately.
What changes are included in this PR?
This PR adds stubs for core data structures and types. Annotations live in
pyarrow-stubs/and can be used at development time. Annotations are not packaged into wheels. Annotations are tested in CI withci/scripts/python_test_type_annotations.shand can be linted and tested locally withpre-commit.During review we agreed on no generics for now (could be follow-up) and overloads are used sparingly.
Detailed AI generated description of changes
**Type stubs** (`python/pyarrow-stubs/`)pyarrow.libthat hold data types and core data structures:types,array,table,tensor,builder,memory,device,configanderror.pyarrow.types(theis_*predicates, withTypeIs/TypeGuardnarrowing).pyarrow/__init__.pyinow re-exports the annotated public names explicitly, sopa.array,pa.Table,pa.schemaetc. are typed.io,ipc,scalarand_compute. Their names resolve toAny, exceptBufferandExtensionScalar, which are empty classes for now.pyarrow/__init__.pyiandlib.pyialso keep a module-level__getattr__returningAnyfor names that aren't annotated yet (to be removed before the stubs ship, [CI] Remove all __getattr__(name) -> Any from *.pyi files before next release #48970).Layout
pyarrow-stubs/is now laid out as a PEP 561 stub-only package (pyarrow-stubs/__init__.pyiinstead ofpyarrow-stubs/pyarrow/__init__.pyi), so type checkers and IDEs pick it up fromarrow/python..pxifiles compiled intopyarrow.liblive in a stub-onlypyarrow-stubs/__lib/package and are re-exported fromlib.pyi. A flat layout madepa.array,pa.tableandpa.scalarresolve to stub modules instead of functions.Annotation conventions agreed during review
DataTypesubclasses in_stubs_typing.pyidescribe the results of the type factories.Selfwhen the runtime returns the receiver's class and a concrete class otherwise. Parameters never useSelf.Arrayrather than a specific subclass such asBooleanArrayorInt32Array, because user variables are usually inferred asArray.pa.array()is annotated as returningArray. The cases where it returns aChunkedArrayare tracked in [Python] Let array() return aChunkedArrayonly when asked #55499.asarray()has overloads.__getitem__andasarray).unit,null_placement, ...) areLiteraltypes, as in NumPy and pandas-stubs.NDArray[...].__eq__without__hash__are marked unhashable.Type checking setup
python/pyproject.tomlto checkpyarrow-stubsandpyarrow-stubs-tests. Modules that aren't annotated yet are treated asAny.python/requirements-stubs.txtpins the type checkers and the stub packages of the dependencies. CI and pre-commit both install from it.python-stubspre-commit hooks: ruff lint and format for the.pyifiles run on commit; mypy, pyright and ty run on request (pre-commit run --hook-stage manual python-stubs --all-files) and in the Lint CI job.ci/scripts/python_test_type_annotations.shnow also runs the type stub tests and stubtest against the PyArrow built in CI.python/scripts/run_stubtest.pyrunsmypy.stubtestwith the__libmodules mapped topyarrow.lib, using a small allowlist.Other changes
array.pxi,scalar.pxi,tensor.pxiandtypes.pxi, and comparisons inpyarrow/teststhat were missingassert.# type: ignorecomments on the optional-import fallbacks in a fewpyarrow/testsfiles.CMakeLists.txt(commented-out install block),python_wheel_validate_contents.pyandupdate_stub_docstrings.py.Are these changes tested?
Yes.
The PyArrow test suite (
pyarrow/tests) is not type checked in CI yet.Yes CI runs (
ci/scripts/python_test_type_annotations.sh) which in runs typecheckers and tests inpython/pyarrow-stubs-tests/.Changes are also teste locally via
pre-commit. Once we package annotations into wheels we should expand testing.Are there any user-facing changes?
No. The stubs are still not packaged into wheels.
Was AI used for this PR?
In accordance to the AI generation guidelines, please disclose below whether and how AI was used in this PR.
PR code and description written by:
Reviewed before submission by: