Skip to content

GH-49831: [Python] Withhold py.typed from the wheel until stubs are complete #50168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rok wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −3
Open

GH-49831: [Python] Withhold py.typed from the wheel until stubs are complete #50168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions ci/scripts/python_wheel_validate_contents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ def validate_wheel(path):
info.filename.split("/")[-1] == filename for info in wheel_zip.filelist
), f"{filename} is missing from the wheel."

assert any(
info.filename == "pyarrow/py.typed" for info in wheel_zip.filelist
), "pyarrow/py.typed is missing from the wheel."
# TODO(GH-48970): Uncomment when stubfiles are complete
# assert any(
# info.filename == "pyarrow/py.typed" for info in wheel_zip.filelist
# ), "pyarrow/py.typed is missing from the wheel."

source_root = Path(__file__).resolve().parents[2]
stubs_dir = source_root / "python" / "pyarrow-stubs" / "pyarrow"
Comment on lines 62 to 63

@dangotbanned dangotbanned Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@rok I strongly recommend excluding the entire directory.

This is all that is in there? 🤨

arrow/python/pyarrow-stubs/pyarrow/__init__.pyi

Lines 24 to 29 in 4fce185

from typing import Any
# TODO(GH-48970): remove __getattr__ before release as this
# will annotate non-existing attributes as Any.
# https://github.com/apache/arrow/issues/48970
def __getattr__(name: str) -> Any: ...

We've been pinning pyarrow<24 and the errors we see in (narwhals-dev/narwhals#3560) will still be there for type checkers that aren't mypy 😔

@rok rok Jun 15, 2026

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.

Ok, I'll change this to do so. Sorry it's taking so long.

Expand Down
5 changes: 5 additions & 0 deletions python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ metadata.version.provider = "scikit_build_core.metadata.setuptools_scm"
sdist.include = ["pyarrow/_generated_version.py", "cmake_modules/", "pyarrow-stubs/"]
wheel.packages = ["pyarrow"]
wheel.install-dir = "pyarrow"
# TODO(GH-48970): Remove this when stubfiles are complete
# Withhold the PEP 561 marker until the type stubs are complete. The .pyi files still ship
# and are tested in CI, but without py.typed type checkers ignore them, we don't break
# downstream users (GH-49831). The file is kept in-tree for CI type-checking.
wheel.exclude = ["pyarrow/py.typed"]
Comment thread
rok marked this conversation as resolved.

[tool.scikit-build.cmake.define]
PYARROW_BUNDLE_ARROW_CPP = {env = "PYARROW_BUNDLE_ARROW_CPP", default = "OFF"}
Expand Down
Loading