Adds overloads to create_pdarray #5224
Open
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
drculhane
force-pushed
the
Closes-5171
branch
from
634f20c to
4c388cb
Compare
drculhane
force-pushed
the
Closes-5171
branch
from
4c388cb to
16dfffe
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5224 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 4
Lines ? 63
Branches ? 0
========================================
Hits ? 63
Misses ? 0
Partials ? 0 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ajpotts
reviewed
Jan 15, 2026
arkouda/numpy/pdarrayclass.py
Outdated
|
|
||
|
|
||
| @overload | ||
| def create_pdarray(repMsg: str, max_bits: None = ...) -> pdarray: ... |
Contributor
There was a problem hiding this comment.
Please use rep_msg instead of repMsg to match pep8.
ajpotts
reviewed
Jan 15, 2026
|
|
||
| @overload | ||
| def create_pdarray(repMsg: memoryview, max_bits: int) -> pdarray: ... | ||
|
|
Contributor
There was a problem hiding this comment.
The overloads could be collapsed to 2 like this:
@overload
def create_pdarray(rep_msg: str, max_bits: int | None = ...) -> pdarray: ...
@overload
def create_pdarray(rep_msg: memoryview, max_bits: int | None = ...) -> pdarray: ...
ajpotts
reviewed
Jan 15, 2026
arkouda/numpy/pdarrayclass.py
Outdated
| rep_msg : str | ||
| space-delimited string containing the pdarray name, datatype, size | ||
| dimension, shape,and itemsize | ||
| repMsg : str, memoryview |
Contributor
There was a problem hiding this comment.
Again, this should be rep_msg.
ajpotts
reviewed
Jan 15, 2026
arkouda/numpy/pdarrayclass.py
Outdated
| repMsg : str, memoryview | ||
| a space-delimited response from the arkouda server describing a newly | ||
| created array. The message encodes, in order, the array name, dtype, | ||
| total size, rank, shape, and itemsize. If provides as a memoryview, |
Contributor
There was a problem hiding this comment.
Should say "provided" rather than "provides"
ajpotts
reviewed
Jan 15, 2026
arkouda/numpy/pdarrayclass.py
Outdated
| total size, rank, shape, and itemsize. If provides as a memoryview, | ||
| it will be decoded to a UTF-8 string before parsing. | ||
| max_bits: int, otional |
Contributor
There was a problem hiding this comment.
I think you mean "optional" rather than "otional".
ajpotts
reviewed
Jan 15, 2026
arkouda/numpy/pdarrayclass.py
Outdated
| """ | ||
| Return a pdarray instance pointing to an array created by the arkouda server. | ||
| The user should not call this function directly. | ||
| This intended for internal use only. The user should not call this function |
Contributor
There was a problem hiding this comment.
"This is intended" instead of "This indended".
drculhane
force-pushed
the
Closes-5171
branch
from
8ce08d1 to
d193506
Compare
drculhane
force-pushed
the
Closes-5171
branch
from
d193506 to
56dba65
Compare
jaketrookman
approved these changes
Jan 16, 2026
Contributor
jaketrookman
left a comment
jaketrookman
left a comment
There was a problem hiding this comment.
Besides the small formatting and grammar changes, looks good
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Closes #5171