ARROW-10316: [Python] Improve introspection of compute function options #10581
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
@amol- Do you want to review this? |
Member
Author
|
Ping @amol- |
amol-
reviewed
Jul 1, 2021
pitrou
force-pushed
the
ARROW-10316-wrapped-compute-func
branch
2 times, most recently
from
c224729 to
61459cf
Compare
Generate a signature for compute functions that better reflects the accepted arguments.
Example before:
```
>>> pc.sum?
Signature: pc.sum(array, *, options=None, memory_pool=None, **kwargs)
Docstring:
Compute the sum of a numeric array.
[...]
```
Same example after:
```
>>> ?pc.sum
Signature:
pc.sum(
array,
*,
memory_pool=None,
options=None,
skip_nulls=True,
min_count=1,
)
Docstring:
Compute the sum of a numeric array.
[...]
```
One caveat is that the individual options are not explicitly documented (yet):
```
Parameters
----------
array : Array-like
Argument to compute function
memory_pool : pyarrow.MemoryPool, optional
If not passed, will allocate memory from the default memory pool.
options : pyarrow.compute.ScalarAggregateOptions, optional
Parameters altering compute function semantics
**kwargs : optional
Parameters for ScalarAggregateOptions constructor. Either `options`
or `**kwargs` can be passed, but not both at the same time.
```
pitrou
force-pushed
the
ARROW-10316-wrapped-compute-func
branch
from
61459cf to
b07b223
Compare
Member
Author
|
Will merge now. Thank you for the reviews! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generate a signature for compute functions that better reflects the accepted arguments.
Example before:
Same example after:
One caveat is that the individual options are not explicitly documented (yet):