pitrou commented on code in PR #48618:
URL: https://github.com/apache/arrow/pull/48618#discussion_r2736825288
##########
ci/scripts/python_wheel_macos_build.sh:
##########
@@ -177,6 +177,8 @@ export CMAKE_PREFIX_PATH=${build_dir}/install
export SETUPTOOLS_SCM_PRETEND_VERSION=${PYARROW_VERSION}
pushd ${source_dir}/python
+# Install libcst for build-time stub docstring extraction
+python -m pip install libcst
Review Comment:
Should we add this to `requirements-wheel-build.txt`? What do you think
@raulcd ?
##########
dev/update_stub_docstrings.py:
##########
@@ -0,0 +1,233 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""
+Extract docstrings from pyarrow runtime and insert them into stub files.
+
+Usage (from python/ directory with pyarrow built):
+ python ../dev/update_stub_docstrings.py pyarrow-stubs
+"""
+
+import argparse
+import importlib
+import inspect
+import shutil
+import sys
+from pathlib import Path
+from textwrap import indent
+
+import libcst
+from libcst import matchers as m
+
+
+def _resolve_object(module, path):
+ """Resolve an object by dotted path from a module."""
+ if not path:
+ return module, None, module.__name__
+
+ parts = path.split(".")
+ parent = None
+ obj = module
+
+ for part in parts:
+ parent = obj
+ try:
+ obj = getattr(obj, part)
+ except AttributeError:
+ try:
+ obj = vars(parent).get(part)
+ if obj is not None:
+ continue
+ except TypeError:
+ pass
+ return None, None, None
+
+ return obj, parent, getattr(obj, "__name__", parts[-1])
+
+
+def _get_docstring(name, module, indentation):
+ """Extract and format a docstring for insertion into a stub file."""
+ obj, parent, obj_name = _resolve_object(module, name)
+ if obj is None:
+ print(f"{name} not found in {module.__name__}")
+ return None
+
+ docstring = inspect.getdoc(obj)
+ if not docstring:
+ return None
+
+ # Remove signature prefix
+ parent_name = getattr(parent, "__name__", None) if parent else None
+ if docstring.startswith(obj_name) or (
+ parent_name and docstring.startswith(f"{parent_name}.{obj_name}")
+ ):
+ docstring = "\n".join(docstring.splitlines()[2:])
+
+ # Skip empty docstrings
+ if not docstring.strip():
+ return None
+
+ prefix = " " * indentation
+ return '"""\n' + indent(docstring + '\n"""', prefix)
+
+
+class DocstringInserter(libcst.CSTTransformer):
+ """CST transformer that inserts docstrings into stub file nodes."""
+
+ def __init__(self, module, namespace):
+ self.module = module
+ self.base_namespace = namespace
+ self.stack = []
+ self.indentation = 0
+
+ def _full_name(self):
+ name = ".".join(self.stack)
+ return f"{self.base_namespace}.{name}" if self.base_namespace else name
+
+ def leave_Module(self, original_node, updated_node):
+ new_body = []
+ clone_matcher = m.SimpleStatementLine(
+
body=[m.Assign(value=m.Call(func=m.Name(value="_clone_signature"))),
+ m.ZeroOrMore()]
+ )
+ for stmt in updated_node.body:
+ new_body.append(stmt)
+ if m.matches(stmt, clone_matcher):
+ name = stmt.body[0].targets[0].target.value
+ if self.base_namespace:
+ name = f"{self.base_namespace}.{name}"
+ docstring = _get_docstring(name, self.module, 0)
+ if docstring:
+ new_body.append(libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(docstring))]))
+ return updated_node.with_changes(body=new_body)
+
+ def visit_ClassDef(self, node):
+ self.stack.append(node.name.value)
+ self.indentation += 1
+
+ def leave_ClassDef(self, original_node, updated_node):
+ name = self._full_name()
+ docstring = _get_docstring(name, self.module, self.indentation)
+
+ if docstring:
+ ellipsis_class = m.ClassDef(body=m.IndentedBlock(body=[
+ m.SimpleStatementLine(body=[
+ m.Expr(m.Ellipsis()), m.ZeroOrMore()]), m.ZeroOrMore()]))
+ func_class = m.ClassDef(body=m.IndentedBlock(
+ body=[m.FunctionDef(), m.ZeroOrMore()]))
+
+ if m.matches(updated_node, ellipsis_class):
+ updated_node = updated_node.deep_replace(
+ updated_node.body.body[0].body[0].value,
+ libcst.SimpleString(value=docstring))
+ elif m.matches(updated_node, func_class):
+ docstring_stmt = libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(value=docstring))])
+ updated_node = updated_node.with_changes(
+ body=updated_node.body.with_changes(
+ body=[docstring_stmt] + list(updated_node.body.body)))
+
+ self.stack.pop()
+ self.indentation -= 1
+ return updated_node
+
+ def visit_FunctionDef(self, node):
+ self.stack.append(node.name.value)
+ self.indentation += 1
+
+ def leave_FunctionDef(self, original_node, updated_node):
+ name = self._full_name()
+ ellipsis_func = m.FunctionDef(
+ body=m.SimpleStatementSuite(body=[m.Expr(m.Ellipsis())]))
+
+ if m.matches(original_node, ellipsis_func):
+ docstring = _get_docstring(name, self.module, self.indentation)
+ if docstring:
+ docstring_stmt = libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(value=docstring))])
+ updated_node = updated_node.with_changes(
+ body=libcst.IndentedBlock(body=[docstring_stmt]))
+
+ self.stack.pop()
+ self.indentation -= 1
+ return updated_node
+
+
+LIB_MODULES = {"array", "builder", "compat", "config", "device", "error", "io",
+ "_ipc", "memory", "pandas_shim", "scalar", "table", "tensor",
"_types"}
+
+
+def add_docstrings_to_stubs(stubs_dir):
+ """Update all stub files in stubs_dir with docstrings from pyarrow
runtime."""
+ stubs_dir = Path(stubs_dir)
+ print(f"Updating stub docstrings in: {stubs_dir}")
+
+ pyarrow = importlib.import_module("pyarrow")
+
+ for stub_file in stubs_dir.rglob('*.pyi'):
+ if stub_file.name == "_stubs_typing.pyi":
+ continue
+
+ module_name = stub_file.stem
+ if module_name in LIB_MODULES:
+ namespace = "lib"
+ elif stub_file.parent.name in ("parquet", "interchange"):
+ namespace = f"{stub_file.parent.name}.{module_name}"
+ elif module_name == "__init__":
+ namespace = ""
+ else:
+ namespace = module_name
+
+ print(f" {stub_file.name} -> {namespace or '(root)'}")
+ tree = libcst.parse_module(stub_file.read_text())
+ modified = tree.visit(DocstringInserter(pyarrow, namespace))
+ stub_file.write_text(modified.code)
+
+
+def copy_stubs(src_dir, dest_dir):
+ """Copy .pyi files from src_dir to dest_dir."""
+ src_dir, dest_dir = Path(src_dir), Path(dest_dir)
+ if not src_dir.exists():
+ return
+
+ print(f"Copying stubs: {src_dir} -> {dest_dir}")
+ for src in src_dir.rglob('*.pyi'):
+ dest = dest_dir / src.relative_to(src_dir)
+ dest.parent.mkdir(parents=True, exist_ok=True)
+ shutil.copy2(src, dest)
+
+
+def update_stubs_for_build(stubs_dir, build_lib):
+ """Entry point for setup.py: update docstrings and copy stubs to build
dir."""
+ stubs_dir, build_lib = Path(stubs_dir), Path(build_lib)
+
+ sys.path.insert(0, str(build_lib))
+ try:
+ add_docstrings_to_stubs(stubs_dir)
+ copy_stubs(stubs_dir / "pyarrow", build_lib / "pyarrow")
+ finally:
+ sys.path.pop(0)
+
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(description=__doc__)
+ parser.add_argument("stubs_dir", type=Path, help="Path to pyarrow-stubs
folder")
+ args = parser.parse_args()
+
+ sys.path.insert(0, ".")
Review Comment:
Can you add an absolute path instead so that this script doesn't depend on
the current directory?
##########
ci/scripts/python_wheel_validate_contents.py:
##########
@@ -34,7 +34,7 @@ def validate_wheel(path):
]
assert not outliers, f"Unexpected contents in wheel: {sorted(outliers)}"
print(f"The wheel: {wheels[0]} seems valid.")
-
+ # TODO(GH-32609): Validate some docstrings were generated and added.
Review Comment:
Is the type checking is split into several PRs, perhaps create sub-issues
for clarify as well?
##########
python/pyproject.toml:
##########
@@ -18,6 +18,8 @@
[build-system]
requires = [
"cython >= 3.1",
+ # Needed for build-time stub docstring extraction
+ "libcst>=1.8.6",
Review Comment:
At some point we'll want to deduplicate `pyproject.toml` and the various
`requirements` files? @raulcd
##########
python/setup.py:
##########
@@ -121,8 +121,28 @@ def build_extensions(self):
def run(self):
self._run_cmake()
+ self._update_stubs()
_build_ext.run(self)
+ def _update_stubs(self):
+ """Update stub docstrings and copy to build directory."""
+ stubs_dir = pjoin(setup_dir, 'pyarrow-stubs')
+ if not os.path.exists(stubs_dir):
+ return
+
+ build_cmd = self.get_finalized_command('build')
+ build_lib = os.path.abspath(build_cmd.build_lib)
+
+ # Import here to avoid hard dependency on the dev script
+ sys.path.insert(0, pjoin(setup_dir, '..', 'dev'))
+ try:
+ from update_stub_docstrings import update_stubs_for_build
+ update_stubs_for_build(stubs_dir, build_lib)
+ except ImportError:
+ print("-- Skipping stubs (update_stub_docstrings.py not found)")
Review Comment:
Why would it not be found? It's in the repo, right?
##########
dev/update_stub_docstrings.py:
##########
@@ -0,0 +1,233 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""
+Extract docstrings from pyarrow runtime and insert them into stub files.
+
+Usage (from python/ directory with pyarrow built):
+ python ../dev/update_stub_docstrings.py pyarrow-stubs
+"""
+
+import argparse
+import importlib
+import inspect
+import shutil
+import sys
+from pathlib import Path
+from textwrap import indent
+
+import libcst
+from libcst import matchers as m
+
+
+def _resolve_object(module, path):
+ """Resolve an object by dotted path from a module."""
+ if not path:
+ return module, None, module.__name__
+
+ parts = path.split(".")
+ parent = None
+ obj = module
+
+ for part in parts:
+ parent = obj
+ try:
+ obj = getattr(obj, part)
+ except AttributeError:
+ try:
+ obj = vars(parent).get(part)
+ if obj is not None:
+ continue
+ except TypeError:
+ pass
+ return None, None, None
+
+ return obj, parent, getattr(obj, "__name__", parts[-1])
+
+
+def _get_docstring(name, module, indentation):
+ """Extract and format a docstring for insertion into a stub file."""
+ obj, parent, obj_name = _resolve_object(module, name)
+ if obj is None:
+ print(f"{name} not found in {module.__name__}")
+ return None
+
+ docstring = inspect.getdoc(obj)
+ if not docstring:
+ return None
+
+ # Remove signature prefix
+ parent_name = getattr(parent, "__name__", None) if parent else None
+ if docstring.startswith(obj_name) or (
+ parent_name and docstring.startswith(f"{parent_name}.{obj_name}")
+ ):
+ docstring = "\n".join(docstring.splitlines()[2:])
+
+ # Skip empty docstrings
+ if not docstring.strip():
+ return None
+
+ prefix = " " * indentation
+ return '"""\n' + indent(docstring + '\n"""', prefix)
+
+
+class DocstringInserter(libcst.CSTTransformer):
+ """CST transformer that inserts docstrings into stub file nodes."""
+
+ def __init__(self, module, namespace):
+ self.module = module
+ self.base_namespace = namespace
+ self.stack = []
+ self.indentation = 0
+
+ def _full_name(self):
+ name = ".".join(self.stack)
+ return f"{self.base_namespace}.{name}" if self.base_namespace else name
+
+ def leave_Module(self, original_node, updated_node):
+ new_body = []
+ clone_matcher = m.SimpleStatementLine(
+
body=[m.Assign(value=m.Call(func=m.Name(value="_clone_signature"))),
+ m.ZeroOrMore()]
+ )
+ for stmt in updated_node.body:
+ new_body.append(stmt)
+ if m.matches(stmt, clone_matcher):
+ name = stmt.body[0].targets[0].target.value
+ if self.base_namespace:
+ name = f"{self.base_namespace}.{name}"
+ docstring = _get_docstring(name, self.module, 0)
+ if docstring:
+ new_body.append(libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(docstring))]))
+ return updated_node.with_changes(body=new_body)
+
+ def visit_ClassDef(self, node):
+ self.stack.append(node.name.value)
+ self.indentation += 1
+
+ def leave_ClassDef(self, original_node, updated_node):
+ name = self._full_name()
+ docstring = _get_docstring(name, self.module, self.indentation)
+
+ if docstring:
+ ellipsis_class = m.ClassDef(body=m.IndentedBlock(body=[
+ m.SimpleStatementLine(body=[
+ m.Expr(m.Ellipsis()), m.ZeroOrMore()]), m.ZeroOrMore()]))
+ func_class = m.ClassDef(body=m.IndentedBlock(
+ body=[m.FunctionDef(), m.ZeroOrMore()]))
+
+ if m.matches(updated_node, ellipsis_class):
+ updated_node = updated_node.deep_replace(
+ updated_node.body.body[0].body[0].value,
+ libcst.SimpleString(value=docstring))
+ elif m.matches(updated_node, func_class):
+ docstring_stmt = libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(value=docstring))])
+ updated_node = updated_node.with_changes(
+ body=updated_node.body.with_changes(
+ body=[docstring_stmt] + list(updated_node.body.body)))
+
+ self.stack.pop()
+ self.indentation -= 1
+ return updated_node
+
+ def visit_FunctionDef(self, node):
+ self.stack.append(node.name.value)
+ self.indentation += 1
+
+ def leave_FunctionDef(self, original_node, updated_node):
+ name = self._full_name()
+ ellipsis_func = m.FunctionDef(
+ body=m.SimpleStatementSuite(body=[m.Expr(m.Ellipsis())]))
+
+ if m.matches(original_node, ellipsis_func):
+ docstring = _get_docstring(name, self.module, self.indentation)
+ if docstring:
+ docstring_stmt = libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(value=docstring))])
+ updated_node = updated_node.with_changes(
+ body=libcst.IndentedBlock(body=[docstring_stmt]))
+
+ self.stack.pop()
+ self.indentation -= 1
+ return updated_node
+
+
+LIB_MODULES = {"array", "builder", "compat", "config", "device", "error", "io",
+ "_ipc", "memory", "pandas_shim", "scalar", "table", "tensor",
"_types"}
+
+
+def add_docstrings_to_stubs(stubs_dir):
+ """Update all stub files in stubs_dir with docstrings from pyarrow
runtime."""
+ stubs_dir = Path(stubs_dir)
+ print(f"Updating stub docstrings in: {stubs_dir}")
+
+ pyarrow = importlib.import_module("pyarrow")
+
+ for stub_file in stubs_dir.rglob('*.pyi'):
+ if stub_file.name == "_stubs_typing.pyi":
+ continue
+
+ module_name = stub_file.stem
+ if module_name in LIB_MODULES:
+ namespace = "lib"
+ elif stub_file.parent.name in ("parquet", "interchange"):
+ namespace = f"{stub_file.parent.name}.{module_name}"
+ elif module_name == "__init__":
+ namespace = ""
+ else:
+ namespace = module_name
+
+ print(f" {stub_file.name} -> {namespace or '(root)'}")
+ tree = libcst.parse_module(stub_file.read_text())
+ modified = tree.visit(DocstringInserter(pyarrow, namespace))
+ stub_file.write_text(modified.code)
+
+
+def copy_stubs(src_dir, dest_dir):
+ """Copy .pyi files from src_dir to dest_dir."""
+ src_dir, dest_dir = Path(src_dir), Path(dest_dir)
+ if not src_dir.exists():
+ return
+
+ print(f"Copying stubs: {src_dir} -> {dest_dir}")
+ for src in src_dir.rglob('*.pyi'):
+ dest = dest_dir / src.relative_to(src_dir)
+ dest.parent.mkdir(parents=True, exist_ok=True)
+ shutil.copy2(src, dest)
+
+
+def update_stubs_for_build(stubs_dir, build_lib):
+ """Entry point for setup.py: update docstrings and copy stubs to build
dir."""
+ stubs_dir, build_lib = Path(stubs_dir), Path(build_lib)
+
+ sys.path.insert(0, str(build_lib))
+ try:
+ add_docstrings_to_stubs(stubs_dir)
+ copy_stubs(stubs_dir / "pyarrow", build_lib / "pyarrow")
Review Comment:
It would seem more logical to copy in `setup.py`. @raulcd What do you think?
##########
ci/scripts/python_test_type_annotations.sh:
##########
@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+set -ex
+pyarrow_dir=${1}
+
+if [ "${PYARROW_TEST_ANNOTATIONS}" == "ON" ]; then
Review Comment:
Why this? Presumably one should only call this script if they want to
actually check annotations?
##########
dev/update_stub_docstrings.py:
##########
@@ -0,0 +1,233 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""
+Extract docstrings from pyarrow runtime and insert them into stub files.
+
+Usage (from python/ directory with pyarrow built):
+ python ../dev/update_stub_docstrings.py pyarrow-stubs
+"""
+
+import argparse
+import importlib
+import inspect
+import shutil
+import sys
+from pathlib import Path
+from textwrap import indent
+
+import libcst
+from libcst import matchers as m
+
+
+def _resolve_object(module, path):
+ """Resolve an object by dotted path from a module."""
+ if not path:
+ return module, None, module.__name__
+
+ parts = path.split(".")
+ parent = None
+ obj = module
+
+ for part in parts:
+ parent = obj
+ try:
+ obj = getattr(obj, part)
+ except AttributeError:
+ try:
+ obj = vars(parent).get(part)
+ if obj is not None:
+ continue
+ except TypeError:
+ pass
+ return None, None, None
+
+ return obj, parent, getattr(obj, "__name__", parts[-1])
+
+
+def _get_docstring(name, module, indentation):
+ """Extract and format a docstring for insertion into a stub file."""
+ obj, parent, obj_name = _resolve_object(module, name)
+ if obj is None:
+ print(f"{name} not found in {module.__name__}")
+ return None
+
+ docstring = inspect.getdoc(obj)
+ if not docstring:
+ return None
+
+ # Remove signature prefix
+ parent_name = getattr(parent, "__name__", None) if parent else None
+ if docstring.startswith(obj_name) or (
+ parent_name and docstring.startswith(f"{parent_name}.{obj_name}")
+ ):
+ docstring = "\n".join(docstring.splitlines()[2:])
+
+ # Skip empty docstrings
+ if not docstring.strip():
+ return None
+
+ prefix = " " * indentation
+ return '"""\n' + indent(docstring + '\n"""', prefix)
+
+
+class DocstringInserter(libcst.CSTTransformer):
+ """CST transformer that inserts docstrings into stub file nodes."""
+
+ def __init__(self, module, namespace):
+ self.module = module
+ self.base_namespace = namespace
+ self.stack = []
+ self.indentation = 0
+
+ def _full_name(self):
+ name = ".".join(self.stack)
+ return f"{self.base_namespace}.{name}" if self.base_namespace else name
+
+ def leave_Module(self, original_node, updated_node):
+ new_body = []
+ clone_matcher = m.SimpleStatementLine(
+
body=[m.Assign(value=m.Call(func=m.Name(value="_clone_signature"))),
+ m.ZeroOrMore()]
+ )
+ for stmt in updated_node.body:
+ new_body.append(stmt)
+ if m.matches(stmt, clone_matcher):
+ name = stmt.body[0].targets[0].target.value
+ if self.base_namespace:
+ name = f"{self.base_namespace}.{name}"
+ docstring = _get_docstring(name, self.module, 0)
+ if docstring:
+ new_body.append(libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(docstring))]))
+ return updated_node.with_changes(body=new_body)
+
+ def visit_ClassDef(self, node):
+ self.stack.append(node.name.value)
+ self.indentation += 1
+
+ def leave_ClassDef(self, original_node, updated_node):
+ name = self._full_name()
+ docstring = _get_docstring(name, self.module, self.indentation)
+
+ if docstring:
+ ellipsis_class = m.ClassDef(body=m.IndentedBlock(body=[
+ m.SimpleStatementLine(body=[
+ m.Expr(m.Ellipsis()), m.ZeroOrMore()]), m.ZeroOrMore()]))
+ func_class = m.ClassDef(body=m.IndentedBlock(
+ body=[m.FunctionDef(), m.ZeroOrMore()]))
+
+ if m.matches(updated_node, ellipsis_class):
+ updated_node = updated_node.deep_replace(
+ updated_node.body.body[0].body[0].value,
+ libcst.SimpleString(value=docstring))
+ elif m.matches(updated_node, func_class):
+ docstring_stmt = libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(value=docstring))])
+ updated_node = updated_node.with_changes(
+ body=updated_node.body.with_changes(
+ body=[docstring_stmt] + list(updated_node.body.body)))
+
+ self.stack.pop()
+ self.indentation -= 1
+ return updated_node
+
+ def visit_FunctionDef(self, node):
+ self.stack.append(node.name.value)
+ self.indentation += 1
+
+ def leave_FunctionDef(self, original_node, updated_node):
+ name = self._full_name()
+ ellipsis_func = m.FunctionDef(
+ body=m.SimpleStatementSuite(body=[m.Expr(m.Ellipsis())]))
+
+ if m.matches(original_node, ellipsis_func):
+ docstring = _get_docstring(name, self.module, self.indentation)
+ if docstring:
+ docstring_stmt = libcst.SimpleStatementLine(
+
body=[libcst.Expr(value=libcst.SimpleString(value=docstring))])
+ updated_node = updated_node.with_changes(
+ body=libcst.IndentedBlock(body=[docstring_stmt]))
+
+ self.stack.pop()
+ self.indentation -= 1
+ return updated_node
+
+
+LIB_MODULES = {"array", "builder", "compat", "config", "device", "error", "io",
+ "_ipc", "memory", "pandas_shim", "scalar", "table", "tensor",
"_types"}
+
+
+def add_docstrings_to_stubs(stubs_dir):
+ """Update all stub files in stubs_dir with docstrings from pyarrow
runtime."""
+ stubs_dir = Path(stubs_dir)
+ print(f"Updating stub docstrings in: {stubs_dir}")
+
+ pyarrow = importlib.import_module("pyarrow")
+
+ for stub_file in stubs_dir.rglob('*.pyi'):
+ if stub_file.name == "_stubs_typing.pyi":
+ continue
+
+ module_name = stub_file.stem
+ if module_name in LIB_MODULES:
+ namespace = "lib"
+ elif stub_file.parent.name in ("parquet", "interchange"):
+ namespace = f"{stub_file.parent.name}.{module_name}"
+ elif module_name == "__init__":
+ namespace = ""
+ else:
+ namespace = module_name
+
+ print(f" {stub_file.name} -> {namespace or '(root)'}")
+ tree = libcst.parse_module(stub_file.read_text())
+ modified = tree.visit(DocstringInserter(pyarrow, namespace))
+ stub_file.write_text(modified.code)
+
+
+def copy_stubs(src_dir, dest_dir):
+ """Copy .pyi files from src_dir to dest_dir."""
+ src_dir, dest_dir = Path(src_dir), Path(dest_dir)
+ if not src_dir.exists():
+ return
+
+ print(f"Copying stubs: {src_dir} -> {dest_dir}")
+ for src in src_dir.rglob('*.pyi'):
+ dest = dest_dir / src.relative_to(src_dir)
+ dest.parent.mkdir(parents=True, exist_ok=True)
+ shutil.copy2(src, dest)
+
+
+def update_stubs_for_build(stubs_dir, build_lib):
+ """Entry point for setup.py: update docstrings and copy stubs to build
dir."""
+ stubs_dir, build_lib = Path(stubs_dir), Path(build_lib)
+
+ sys.path.insert(0, str(build_lib))
Review Comment:
Why all the `sys.path` hackery? Is it required for something specific?
Please at least comment on this (but it would be better to avoid this).
##########
dev/update_stub_docstrings.py:
##########
Review Comment:
This is Python-specific so we probably want to put somewhere inside the
`python/` directory? Perhaps in `python/scripts`?
##########
python/setup.py:
##########
@@ -121,8 +121,28 @@ def build_extensions(self):
def run(self):
self._run_cmake()
+ self._update_stubs()
_build_ext.run(self)
+ def _update_stubs(self):
+ """Update stub docstrings and copy to build directory."""
+ stubs_dir = pjoin(setup_dir, 'pyarrow-stubs')
+ if not os.path.exists(stubs_dir):
+ return
+
+ build_cmd = self.get_finalized_command('build')
+ build_lib = os.path.abspath(build_cmd.build_lib)
+
+ # Import here to avoid hard dependency on the dev script
+ sys.path.insert(0, pjoin(setup_dir, '..', 'dev'))
+ try:
+ from update_stub_docstrings import update_stubs_for_build
Review Comment:
Hmm, is `update_stub_docstrings` supposed to be called as a script or as a
Python module?
##########
python/pyproject.toml:
##########
@@ -84,15 +86,51 @@ zip-safe=false
include-package-data=true
[tool.setuptools.packages.find]
-include = ["pyarrow"]
+include = ["pyarrow", "pyarrow.*"]
namespaces = false
[tool.setuptools.package-data]
-pyarrow = ["*.pxd", "*.pyx", "includes/*.pxd"]
+pyarrow = ["*.pxd", "*.pyi", "*.pyx", "includes/*.pxd", "py.typed"]
[tool.setuptools_scm]
root = '..'
version_file = 'pyarrow/_generated_version.py'
version_scheme = 'guess-next-dev'
git_describe_command = 'git describe --dirty --tags --long --match
"apache-arrow-[0-9]*.*"'
fallback_version = '24.0.0a0'
+
+# TODO: Enable type checking once stubs are merged
+[tool.mypy]
+files = ["pyarrow-stubs"]
+mypy_path = "$MYPY_CONFIG_FILE_DIR/pyarrow-stubs"
+exclude = [
+ "^pyarrow/",
+ "^benchmarks/",
+ "^examples/",
+ "^scripts/",
+]
+
+# TODO: Enable type checking once stubs are merged
+[tool.pyright]
+pythonPlatform = "All"
+pythonVersion = "3.10"
Review Comment:
Do we actually have to set a Python version here? If so, should we set a
more recent one e.g. 3.14?
##########
python/pyproject.toml:
##########
@@ -84,15 +86,51 @@ zip-safe=false
include-package-data=true
[tool.setuptools.packages.find]
-include = ["pyarrow"]
+include = ["pyarrow", "pyarrow.*"]
namespaces = false
[tool.setuptools.package-data]
-pyarrow = ["*.pxd", "*.pyx", "includes/*.pxd"]
+pyarrow = ["*.pxd", "*.pyi", "*.pyx", "includes/*.pxd", "py.typed"]
[tool.setuptools_scm]
root = '..'
version_file = 'pyarrow/_generated_version.py'
version_scheme = 'guess-next-dev'
git_describe_command = 'git describe --dirty --tags --long --match
"apache-arrow-[0-9]*.*"'
fallback_version = '24.0.0a0'
+
+# TODO: Enable type checking once stubs are merged
+[tool.mypy]
+files = ["pyarrow-stubs"]
+mypy_path = "$MYPY_CONFIG_FILE_DIR/pyarrow-stubs"
+exclude = [
+ "^pyarrow/",
Review Comment:
This exclusion means we're not checking anything currently, right?
##########
python/setup.py:
##########
@@ -121,8 +121,28 @@ def build_extensions(self):
def run(self):
self._run_cmake()
+ self._update_stubs()
_build_ext.run(self)
+ def _update_stubs(self):
+ """Update stub docstrings and copy to build directory."""
+ stubs_dir = pjoin(setup_dir, 'pyarrow-stubs')
+ if not os.path.exists(stubs_dir):
+ return
+
+ build_cmd = self.get_finalized_command('build')
+ build_lib = os.path.abspath(build_cmd.build_lib)
+
+ # Import here to avoid hard dependency on the dev script
Review Comment:
What does this mean?
##########
python/pyproject.toml:
##########
@@ -84,15 +86,51 @@ zip-safe=false
include-package-data=true
[tool.setuptools.packages.find]
-include = ["pyarrow"]
+include = ["pyarrow", "pyarrow.*"]
Review Comment:
Ah, setuptools doesn't find packages recursively otherwise? I'm a bit
surprised, I think we already have some of them such as `pyarrow.parquet`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
