PyVortex #729
Merged
PyVortex #729
Conversation
This file contains 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
danking
force-pushed
the
dk/python-documentation-struct-read-projection
branch
from
67a213d to
4d55c61
Compare
a10y
reviewed
Sep 4, 2024
robert3005
reviewed
Sep 4, 2024
robert3005
requested changes
Sep 4, 2024
danking
force-pushed
the
dk/python-documentation-struct-read-projection
branch
5 times, most recently
from
3f31390 to
2bfb65b
Compare
PyVortex -------- The generated documentation for this branch is available at https://spiraldb.github.io/vortex/docs/ The Python package is now structured like this: - `vortex` - `array()`: converts a list or an Arrow array into a Vortex array. - `encodings` - `Array`: In Rust this is called a PyArray and it is just PyO3 wrapper around a Vortex Rust Array. - `to_pandas` - `to_numpy` - `compress()`: compresses an Array. - `dtype`: A module containing dtype constructors, e.g. `uint(32, nullable=False)` - `io`: Readers and writers which currently only work for Struct arrays without top-level nulls. - `read()` - `write()` - `expr` - `Expr`: a class, implemented in Rust, which constructs vortex-exprs using the obvious Python operators. I also added `python_repr` which returns a Display-able struct that renders itself in the Python `repr` style. In particular, the dtypes look like `uint(32, False)` rather than `u32`. I think the only bugfixes in this PR are: 1. pyvortex/src/encode.rs: propagate the nullability from Arrow to `Array::from_arrow`. 2. arrow/recordbatch.rs and arrow/dtype.rs need to return compatible nullability and validity. Future Work ----------- 1. Automatically generate and deploy the documentation to github.io. 2. Run `cd pyvortex/docs && make doctest` on every commit.
danking
force-pushed
the
dk/python-documentation-struct-read-projection
branch
from
f1bd829 to
52851b3
Compare
robert3005
reviewed
Sep 5, 2024
robert3005
reviewed
Sep 5, 2024
pyvortex/src/dtype.rs
Outdated
| @@ -26,8 +31,12 @@ impl PyDType { | |||
| format!("{}", self.inner) | |||
| } | |||
|
|
|||
| fn __repr__(&self) -> String { | |||
| format!("{}", self.inner.python_repr()) | |||
There was a problem hiding this comment.
this can be
Suggested change
| format!("{}", self.inner.python_repr()) | |
| self.inner.python_repr().to_string() |
robert3005
approved these changes
Sep 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PyVortex
The generated documentation for this branch is available at https://spiraldb.github.io/vortex/docs/
The Python package is now structured like this:
vortexarray(): converts a list or an Arrow array into a Vortex array.encodingsArray: In Rust this is called a PyArray and it is just PyO3 wrapper around a Vortex Rust Array. -to_pandas-to_numpycompress(): compresses an Array.dtype: A module containing dtype constructors, e.g.uint(32, nullable=False)io: Readers and writers which currently only work for Struct arrays without top-level nulls.read()write()expr-Expr: a class, implemented in Rust, which constructs vortex-exprs using the obvious Python operators.I also added
python_reprwhich returns a Display-able struct that renders itself in the Pythonreprstyle. In particular, the dtypes look likeuint(32, False)rather thanu32.I think the only bugfixes in this PR are:
Array::from_arrow.Future Work
cd pyvortex/docs && make docteston every commit.