Skip to content

[Python] Improve ergonomics of compute functions #25538

@asfimport

Description

@asfimport

Introspection of exported compute functions currently yield suboptimal output:

>>> from pyarrow import compute as pc                                                                                                                                 
>>> pc.list_flatten                                                                                                                                                   
<function pyarrow.compute._simple_unary_function.<locals>.func(arg)>
>>> ?pc.list_flatten                                                                                                                                                  
Signature: pc.list_flatten(arg)
Docstring: <no docstring>
File:      ~/arrow/dev/python/pyarrow/compute.py
Type:      function
>>> help(pc.list_flatten)                                                                                                                                             
Help on function func in module pyarrow.compute:

func(arg)

The function should ideally have:

  • the right global name
  • an appropriate signature
  • a docstring

Reporter: Antoine Pitrou / @pitrou
Assignee: Antoine Pitrou / @pitrou

Related issues:

PRs and other links:

Note: This issue was originally created as ARROW-9465. Please see the migration documentation for further details.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions