Skip to content

GH-49194: [Python][Annotations] Compute module - #49201

Draft
rok wants to merge 7 commits into
apache:mainfrom
rok:pyarrow-stubs-pr4-compute
Draft

rok wants to merge 7 commits into
apache:mainfrom
rok:pyarrow-stubs-pr4-compute

Conversation

@rok

@rok rok commented Feb 9, 2026 •

Copy link
Copy Markdown
Member

Rationale for this change

Closes: #49194

What changes are included in this PR?

Adds type annotation stubs for compute, _compute, _compute_docstring, and _acero modules. Includes source fixes in compute.py and acero.py, and type-ignore annotations in related tests.

Are these changes tested?

Yes, by CI.

Are there any user-facing changes?

Compute module functions will be type annotated.

@github-actions

github-actions Bot commented Feb 9, 2026

Copy link
Copy Markdown

⚠️ GitHub issue #49194 has been automatically assigned in GitHub to PR creator.



filter = array_filter
take = array_take

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: redefine take rather than alias to exclude Expression

rok added a commit to rok/arrow that referenced this pull request Nov 13, 2026
Add type annotation stubs for compute, _compute, _compute_docstring,
and _acero modules.

These are the stubs of apacheGH-49201 as they were, at their original paths.
The type checker accommodations that apacheGH-49201 made in compute.py,
acero.py and the PyArrow tests are left out, as the type checkers no
longer run on pyarrow/ (see apacheGH-55264).
rok added a commit to rok/arrow that referenced this pull request Nov 13, 2026
Add type annotation stubs for compute, _compute, _compute_docstring,
and _acero modules.

These are the stubs of apacheGH-49201 as they were, at their original paths.
The type checker accommodations that apacheGH-49201 made in compute.py,
acero.py and the PyArrow tests are left out, as the type checkers no
longer run on pyarrow/ (see apacheGH-55264).
rok added a commit to rok/arrow that referenced this pull request Nov 13, 2026
Add type annotation stubs for compute, _compute, _compute_docstring,
and _acero modules.

These are the stubs of apacheGH-49201 as they were, at their original paths.
The type checker accommodations that apacheGH-49201 made in compute.py,
acero.py and the PyArrow tests are left out, as the type checkers no
longer run on pyarrow/ (see apacheGH-55264).
@rok
rok force-pushed the pyarrow-stubs-pr4-compute branch from d3f0fb7 to a78bedf Compare November 13, 2026 13:06
@rok
rok force-pushed the pyarrow-stubs-pr4-compute branch 2 times, most recently from 29a6b0b to fb3204a Compare November 13, 2026 13:29
@rok

rok commented Nov 17, 2026

Copy link
Copy Markdown
Member Author

Given there were changes in the data types PR you might want to rebase or merge them here @AlenkaF.

@AlenkaF
AlenkaF force-pushed the pyarrow-stubs-pr4-compute branch from e8779e3 to 300602b Compare November 18, 2026 05:21
@AlenkaF

AlenkaF commented Nov 18, 2026

Copy link
Copy Markdown
Member

Oh, should have squashed, sorry.

@@ -0,0 +1,18 @@
# Licensed to the Apache Software Foundation (ASF) under one

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this file needed or we can remove it?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't remember what this is, I suppose remove.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will test if removed.

from pyarrow import lib

ArrayLike: TypeAlias = Any
ScalarLike: TypeAlias = Any

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to myself: when #55592 is merged, update the ScalarLike alias and make sure to narrow return types that use this alias.

Comment thread python/pyarrow-stubs/_stubs_typing.pyi Resolved
Comment thread python/pyarrow-stubs/_compute.pyi Resolved
AlenkaF and others added 6 commits November 18, 2026 15:54
Annotate pyarrow.compute, pyarrow._compute, pyarrow._acero and
pyarrow._compute_docstrings, following the approach of apacheGH-55264: plain
classes and unions instead of generics, in the flat pyarrow-stubs/
layout.

- Array arguments accept any Array or ChunkedArray, since pa.array()
  and most of the API return plain Array instances. The return types
  name the kind of array where the function determines it. The scalar
  classes are placeholders (Any) until scalar.pyi is annotated.
- The signatures match the runtime, as checked by stubtest.
- pyarrow.compute and pyarrow._compute are type checked instead of
  being treated as Any.
- Add type annotation tests for the compute and Acero stubs.
@AlenkaF
AlenkaF force-pushed the pyarrow-stubs-pr4-compute branch from 300602b to bc6a844 Compare November 19, 2026 09:19
check(assert_type(field.equals(pc.field("a")), bool), bool)

# Calling a compute function with an expression builds an expression.
check(pc.count(field), pc.Expression)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to myself: add assert_type checks once the scalar stubs land.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Python][Annotations] Compute module

3 participants