From 04cfb306a5f594d6cad87042d6a0714bc5603e0a Mon Sep 17 00:00:00 2001 From: Justin Joyce Date: Sat, 11 Mar 2023 11:19:08 +0000 Subject: [PATCH] 0.0.9 --- LICENSE | 222 +++++++++++++++++++++++++++++---- README.md | 4 +- orso/converters.py | 5 +- orso/dataframe.py | 10 +- orso/version.py | 4 +- tests/test_converters_arrow.py | 1 - tests/test_dataframe.py | 47 +++++-- 7 files changed, 254 insertions(+), 39 deletions(-) diff --git a/LICENSE b/LICENSE index 6599338..cc77bde 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2023 Justin Joyce - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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 2021-2023 Justin Joyce + + 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. \ No newline at end of file diff --git a/README.md b/README.md index 2243eb3..5f005c8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ Orso is not intended to compete with [Polars](https://www.pola.rs/) or [Pandas]( ## License -[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/mabel-dev/orso/blob/main/LICENSE) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/mabel-dev/orso/blob/master/LICENSE) + +Orso is licensed under Apache 2.0 unless explicitly indicated otherwise. ## Status diff --git a/orso/converters.py b/orso/converters.py index 5d0836a..89f2317 100644 --- a/orso/converters.py +++ b/orso/converters.py @@ -18,13 +18,16 @@ from orso.row import Row -def to_arrow(dataset): +def to_arrow(dataset, size=None): try: import pyarrow except ImportError as import_error: raise MissingDependencyError(import_error.name) from import_error # Create a list of PyArrow arrays from the rows arrays = [pyarrow.array(col) for col in zip(*dataset._rows)] + # Limit the number of rows to 'size' + if size: + arrays = itertools.islice(arrays, size) # Create a PyArrow table from the arrays and schema table = pyarrow.Table.from_arrays(arrays, dataset.column_names) diff --git a/orso/dataframe.py b/orso/dataframe.py index 5544297..804415c 100644 --- a/orso/dataframe.py +++ b/orso/dataframe.py @@ -51,10 +51,10 @@ def from_arrow(cls, tables): return from_arrow(tables) - def arrow(self): + def arrow(self, size=None): from orso.converters import to_arrow - return to_arrow(self) + return to_arrow(self, size=size) def pandas(self): from orso.converters import to_pandas @@ -149,6 +149,12 @@ def slice(self, offset: int = 0, length: int = None): return DataFrame(schema=self._schema, rows=self._rows[offset:]) return DataFrame(schema=self._schema, rows=self._rows[offset : offset + length]) + def filter(self, mask): + """ + Select rows from the DataFRame. The DataFrame is filtered based on boolean array. + """ + return DataFrame(schema=self._schema, rows=(t for t, m in zip(self._rows, mask) if m)) + def row(self, i): self.materialize() return self._rows[i] diff --git a/orso/version.py b/orso/version.py index 682841b..d7f2ef1 100644 --- a/orso/version.py +++ b/orso/version.py @@ -10,5 +10,5 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "0.0.8" -__author__ = "@joocer" +__version__: str = "0.0.9" +__author__: str = "@joocer" diff --git a/tests/test_converters_arrow.py b/tests/test_converters_arrow.py index cdc1801..62c178b 100644 --- a/tests/test_converters_arrow.py +++ b/tests/test_converters_arrow.py @@ -1,7 +1,6 @@ import os import sys -import pandas import pyarrow sys.path.insert(1, os.path.join(sys.path[0], "..")) diff --git a/tests/test_dataframe.py b/tests/test_dataframe.py index 2e6e51a..416061a 100644 --- a/tests/test_dataframe.py +++ b/tests/test_dataframe.py @@ -9,8 +9,7 @@ from orso.row import Row -@pytest.fixture -def schema(): +def create_schema(): return { "A": {"type": int, "nullable": False}, "B": {"type": str, "nullable": True}, @@ -18,8 +17,7 @@ def schema(): } -@pytest.fixture -def rows(): +def create_rows(): row_factory = Row.create_class( { "A": {"type": int, "nullable": False}, @@ -36,31 +34,37 @@ def rows(): ) -@pytest.fixture -def dataframe(schema, rows): +def create_dataframe(): + schema = create_schema() + rows = create_rows() return DataFrame(rows=rows, schema=schema) -def test_dataframe_materialize(dataframe): +def test_dataframe_materialize(): + dataframe = create_dataframe() dataframe.materialize() assert isinstance(dataframe._rows, list) -def test_dataframe_collect(dataframe): +def test_dataframe_collect(): + dataframe = create_dataframe() result = dataframe.collect(["A", "C"]) assert result == ([1, 2, 3, 4, 5], [1.1, 2.2, 3.3, 4.4, 5.5]) -def test_dataframe_slice(dataframe): +def test_dataframe_slice(): + dataframe = create_dataframe() result = dataframe.slice(offset=1, length=2) assert len(result) == 2 -def test_dataframe_iter(dataframe): +def test_dataframe_iter(): + dataframe = create_dataframe() assert len(list(dataframe)) == 5 -def test_dataframe_len(dataframe): +def test_dataframe_len(): + dataframe = create_dataframe() assert len(dataframe) == 5 @@ -77,3 +81,24 @@ def test_dataframe_user_init(): df = DataFrame(cities) assert df.column_names == ("name", "population", "country", "founded", "area", "language") assert df.rowcount == 5 + + +def test_dataframe_filter(): + # Filter rows where column A is greater than 2 + dataframe = create_dataframe() + mask = [row[0] > 2 for row in dataframe] + filtered_dataframe = dataframe.filter(mask) + assert len(filtered_dataframe) == 3 + assert filtered_dataframe.collect(["A"]) == ([3, 4, 5],) + + +if __name__ == "__main__": # prgama: nocover + test_dataframe_materialize() + test_dataframe_collect() + test_dataframe_slice() + test_dataframe_iter() + test_dataframe_len() + test_dataframe_user_init() + test_dataframe_filter() + + print("✅ okay")