diff --git a/Cargo.toml b/Cargo.toml index 5bec57d84..e40faf521 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -26,6 +26,7 @@ members = [ "benchmarks", "examples" ] +exclude = [ "python" ] resolver = "2" [workspace.dependencies] diff --git a/python/.gitignore b/python/.gitignore new file mode 100644 index 000000000..74486f04c --- /dev/null +++ b/python/.gitignore @@ -0,0 +1,2 @@ +venv +*.so \ No newline at end of file diff --git a/python/Cargo.toml b/python/Cargo.toml new file mode 100644 index 000000000..6a63b6f73 --- /dev/null +++ b/python/Cargo.toml @@ -0,0 +1,42 @@ +# 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. + +[package] +name = "pyballista" +version = "0.12.0" +homepage = "https://github.com/apache/arrow-ballista" +repository = "https://github.com/apache/arrow-ballista" +authors = ["Apache Arrow "] +description = "Apache Arrow Ballista Python Client" +readme = "README.md" +license = "Apache-2.0" +edition = "2021" +rust-version = "1.64" +include = ["/src", "/pyballista", "/LICENSE.txt", "pyproject.toml", "Cargo.toml", "Cargo.lock"] + +[dependencies] +ballista = { path = "../ballista/client", version = "0.12.0" } +datafusion = "35.0.0" +datafusion-python = "35.0.0" +pyo3 = { version = "0.20", features = ["extension-module", "abi3", "abi3-py38"] } +tokio = { version = "1.35", features = ["macros", "rt", "rt-multi-thread", "sync"] } + +[lib] +crate-type = ["cdylib"] +name = "pyballista" + + diff --git a/python/LICENSE.txt b/python/LICENSE.txt new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/python/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/python/README.md b/python/README.md new file mode 100644 index 000000000..1819a7201 --- /dev/null +++ b/python/README.md @@ -0,0 +1,64 @@ + + +# PyBallista + +Minimal Python client for Ballista. + +The goal of this project is to provide a way to run SQL against a Ballista cluster from Python and collect +results as PyArrow record batches. + +Note that this client currently only provides a SQL API and not a DataFrame API. A future release will support +using the DataFrame API from DataFusion's Python bindings to create a logical plan and then execute that logical plan +from the Ballista context ([tracking issue](https://github.com/apache/arrow-ballista/issues/971)). + +This project is versioned and released independently from the main Ballista project and is intentionally not +part of the default Cargo workspace so that it doesn't cause overhead for maintainers of the main Ballista codebase. + +## Example Usage + +```python +from pyballista import SessionContext +>>> ctx = SessionContext("localhost", 50050) +>>> ctx.sql("create external table t stored as parquet location '/mnt/bigdata/tpch/sf10-parquet/lineitem.parquet'") +>>> df = ctx.sql("select * from t limit 5") +>>> df.collect() +``` + +## Creating Virtual Environment + +```shell +python3 -m venv venv +source venv/bin/activate +pip3 install -r requirements.txt +``` + +## Building + +```shell +maturin develop +``` + +Note that you can also run `maturin develop --release` to get a release build locally. + +## Testing + +```shell +python3 -m pytest +``` diff --git a/python/pyballista/__init__.py b/python/pyballista/__init__.py new file mode 100644 index 000000000..480e9edab --- /dev/null +++ b/python/pyballista/__init__.py @@ -0,0 +1,38 @@ +# 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. + +from abc import ABCMeta, abstractmethod +from typing import List + +try: + import importlib.metadata as importlib_metadata +except ImportError: + import importlib_metadata + +import pyarrow as pa + +from .pyballista_internal import ( + SessionContext, + DataFrame +) + +__version__ = importlib_metadata.version(__name__) + +__all__ = [ + "SessionContext", + "DataFrame", +] diff --git a/python/pyballista/tests/__init__.py b/python/pyballista/tests/__init__.py new file mode 100644 index 000000000..13a83393a --- /dev/null +++ b/python/pyballista/tests/__init__.py @@ -0,0 +1,16 @@ +# 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. diff --git a/python/pyballista/tests/test_context.py b/python/pyballista/tests/test_context.py new file mode 100644 index 000000000..46e67e10b --- /dev/null +++ b/python/pyballista/tests/test_context.py @@ -0,0 +1,26 @@ +# 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. +from pyballista import SessionContext +import pytest + +def test_create_context(): + SessionContext("localhost", 50050) + +def test_select_one(): + ctx = SessionContext("localhost", 50050) + df = ctx.sql("SELECT 1") + df.collect() \ No newline at end of file diff --git a/python/pyproject.toml b/python/pyproject.toml new file mode 100644 index 000000000..71bd5ec2e --- /dev/null +++ b/python/pyproject.toml @@ -0,0 +1,64 @@ +# 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. + +[build-system] +requires = ["maturin>=0.15,<0.16"] +build-backend = "maturin" + +[project] +name = "pyballista" +description = "Python client for Apache Arrow Ballista Distributed SQL Query Engine" +readme = "README.md" +license = {file = "LICENSE.txt"} +requires-python = ">=3.6" +keywords = ["ballista", "sql", "rust", "distributed"] +classifier = [ + "Development Status :: 2 - Pre-Alpha", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "License :: OSI Approved", + "Operating System :: MacOS", + "Operating System :: Microsoft :: Windows", + "Operating System :: POSIX :: Linux", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python", + "Programming Language :: Rust", +] +dependencies = [ + "pyarrow>=11.0.0", +] + +[project.urls] +homepage = "https://arrow.apache.org/ballista" +documentation = "https://arrow.apache.org/ballista" +repository = "https://github.com/apache/arrow-ballista" + +[tool.isort] +profile = "black" + +[tool.maturin] +module-name = "pyballista.pyballista_internal" +include = [ + { path = "Cargo.lock", format = "sdist" } +] +exclude = [".github/**", "ci/**", ".asf.yaml"] +# Require Cargo.lock is up to date +locked = true diff --git a/python/requirements.txt b/python/requirements.txt new file mode 100644 index 000000000..f6acb1761 --- /dev/null +++ b/python/requirements.txt @@ -0,0 +1,2 @@ +pyarrow +pytest \ No newline at end of file diff --git a/python/src/lib.rs b/python/src/lib.rs new file mode 100644 index 000000000..186a570e0 --- /dev/null +++ b/python/src/lib.rs @@ -0,0 +1,117 @@ +// 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. + +use datafusion::arrow::pyarrow::ToPyArrow; +use datafusion::prelude::DataFrame; +use pyo3::exceptions::PyException; +use pyo3::prelude::*; +use std::future::Future; +use std::sync::Arc; +use tokio::runtime::Runtime; + +use ballista::prelude::*; + +/// PyBallista SessionContext +#[pyclass(name = "SessionContext", module = "pyballista", subclass)] +pub struct PySessionContext { + ctx: BallistaContext, +} + +#[pymethods] +impl PySessionContext { + #[new] + pub fn new(host: &str, port: u16, py: Python) -> PyResult { + let config = BallistaConfig::new().unwrap(); + let ballista_context = BallistaContext::remote(host, port, &config); + let ctx = wait_for_future(py, ballista_context).map_err(to_pyerr)?; + Ok(Self { ctx }) + } + + pub fn sql(&mut self, query: &str, py: Python) -> PyResult { + let result = self.ctx.sql(query); + let df = wait_for_future(py, result)?; + Ok(PyDataFrame::new(df)) + } +} + +#[pyclass(name = "DataFrame", module = "pyballista", subclass)] +#[derive(Clone)] +pub struct PyDataFrame { + /// DataFusion DataFrame + df: Arc, +} + +impl PyDataFrame { + /// creates a new PyDataFrame + pub fn new(df: DataFrame) -> Self { + Self { df: Arc::new(df) } + } +} + +#[pymethods] +impl PyDataFrame { + /// Executes the plan, returning a list of `RecordBatch`es. + /// Unless some order is specified in the plan, there is no + /// guarantee of the order of the result. + fn collect(&self, py: Python) -> PyResult> { + let batches = wait_for_future(py, self.df.as_ref().clone().collect())?; + // cannot use PyResult> return type due to + // https://github.com/PyO3/pyo3/issues/1813 + batches.into_iter().map(|rb| rb.to_pyarrow(py)).collect() + } +} + +fn wait_for_future(py: Python, f: F) -> F::Output +where + F: Send, + F::Output: Send, +{ + let runtime: &Runtime = &get_tokio_runtime(py).0; + py.allow_threads(|| runtime.block_on(f)) +} + +fn get_tokio_runtime(py: Python) -> PyRef { + let ballista = py.import("pyballista._internal").unwrap(); + let tmp = ballista.getattr("runtime").unwrap(); + match tmp.extract::>() { + Ok(runtime) => runtime, + Err(_e) => { + let rt = TokioRuntime(tokio::runtime::Runtime::new().unwrap()); + let obj: &PyAny = Py::new(py, rt).unwrap().into_ref(py); + obj.extract().unwrap() + } + } +} + +fn to_pyerr(err: BallistaError) -> PyErr { + PyException::new_err(err.to_string()) +} + +#[pyclass] +pub(crate) struct TokioRuntime(tokio::runtime::Runtime); + +#[pymodule] +fn pyballista_internal(_py: Python, m: &PyModule) -> PyResult<()> { + // Register the Tokio Runtime as a module attribute so we can reuse it + m.add( + "runtime", + TokioRuntime(tokio::runtime::Runtime::new().unwrap()), + )?; + m.add_class::()?; + m.add_class::()?; + Ok(()) +}