diff --git a/bindings/python/LICENSE b/bindings/python/LICENSE new file mode 100644 index 00000000..f49a4e16 --- /dev/null +++ b/bindings/python/LICENSE @@ -0,0 +1,201 @@ + 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. \ No newline at end of file diff --git a/bindings/python/MANIFEST.in b/bindings/python/MANIFEST.in new file mode 100644 index 00000000..b1eaf85c --- /dev/null +++ b/bindings/python/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst +include LICENSE \ No newline at end of file diff --git a/bindings/python/README.rst b/bindings/python/README.rst new file mode 100644 index 00000000..b84547ff --- /dev/null +++ b/bindings/python/README.rst @@ -0,0 +1,8 @@ +============ +PyMongoArrow +============ +:Info: A companion library to PyMongo that makes it easy to move data + between MongoDB and Apache Arrow. See + `GitHub `_ + for the latest source. +:Author: Prashant Mital diff --git a/bindings/python/pymongoarrow/__init__.py b/bindings/python/pymongoarrow/__init__.py new file mode 100644 index 00000000..939299a6 --- /dev/null +++ b/bindings/python/pymongoarrow/__init__.py @@ -0,0 +1,31 @@ +# Copyright 2021-present MongoDB, Inc. +# +# 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. + +from pymongoarrow.libbson.version import __version__ as libbson_version +from pymongoarrow.version import __version__, _MIN_LIBBSON_VERSION + + +try: + from pkg_resources import parse_version as _parse_version +except ImportError: + from distutils.version import LooseVersion as _LooseVersion + + def _parse_version(version): + return _LooseVersion(version) + + +if _parse_version(libbson_version) < _parse_version(_MIN_LIBBSON_VERSION): + raise ImportError( + "Expected libbson version {} or greater, found {}}".format( + _MIN_LIBBSON_VERSION, libbson_version)) diff --git a/bindings/python/pymongoarrow/libbson/__init__.pxd b/bindings/python/pymongoarrow/libbson/__init__.pxd new file mode 100644 index 00000000..f8bf20e3 --- /dev/null +++ b/bindings/python/pymongoarrow/libbson/__init__.pxd @@ -0,0 +1,129 @@ +# Copyright 2021-present MongoDB, Inc. +# +# 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. + +# Cython compiler directives +# cython: language_level=3 +# distutils: language=c +from libc.stdint cimport int32_t, int64_t, uint8_t, uint32_t, uint64_t + + +# libbson type wrappings +# wrappings are not defined for the following types: +# - bson_json_reader_t +# - bson_md5_t (deprecated) +# - bson_string_t +# - bson_subtype_t +# - bson_unichar_t +# - bson_value_t +# - bson_visitor_t +# - bson_writer_t +cdef extern from "bson/bson.h": + ctypedef struct bson_t: + uint32_t flags + uint32_t len + uint8_t padding[120] + + ctypedef struct bson_context_t: + pass + + ctypedef struct bson_decimal128_t: + pass + + ctypedef struct bson_error_t: + uint32_t domain + uint32_t code + char message[504] + + ctypedef struct bson_iter_t: + pass + + ctypedef struct bson_oid_t: + uint8_t bytes[12] + + ctypedef struct bson_reader_t: + pass + + ctypedef enum bson_type_t: + BSON_TYPE_EOD, + BSON_TYPE_DOUBLE, + BSON_TYPE_UTF8, + BSON_TYPE_DOCUMENT, + BSON_TYPE_ARRAY, + BSON_TYPE_BINARY, + BSON_TYPE_UNDEFINED, + BSON_TYPE_OID, + BSON_TYPE_BOOL, + BSON_TYPE_DATE_TIME, + BSON_TYPE_NULL, + BSON_TYPE_REGEX, + BSON_TYPE_DBPOINTER, + BSON_TYPE_CODE, + BSON_TYPE_SYMBOL, + BSON_TYPE_CODEWSCOPE, + BSON_TYPE_INT32, + BSON_TYPE_TIMESTAMP, + BSON_TYPE_INT64, + BSON_TYPE_DECIMAL128, + BSON_TYPE_MAXKEY, + BSON_TYPE_MINKEY + + +# bson_t API +cdef extern from "bson/bson.h": + void bson_destroy(bson_t *bson) + + const uint8_t * bson_get_data(const bson_t *bson) + + bint bson_has_field(const bson_t *bson, const char *key) + + bint bson_init_static(bson_t *b, const uint8_t *data, size_t length) + + char * bson_as_json(const bson_t *bson, size_t *length) + + +# bson_iter_t API +cdef extern from "bson/bson.h": + bint bson_iter_init(bson_iter_t *iter, const bson_t *bson) + + bint bson_iter_init_from_data(bson_iter_t *iter, const uint8_t *data, size_t length) + + bint bson_iter_next(bson_iter_t *iter) + + const char * bson_iter_key(const bson_iter_t *iter) + + bson_type_t bson_iter_type(const bson_iter_t *iter) + + bint bson_iter_bool(const bson_iter_t *iter) + + int64_t bson_iter_date_time(const bson_iter_t *iter) + + # TODO: add decimal128 + + double bson_iter_double(const bson_iter_t *iter) + + int32_t bson_iter_int32(const bson_iter_t *iter) + + int64_t bson_iter_int64(const bson_iter_t *iter) + + +# bson_reader_t API +cdef extern from "bson/bson.h": + bson_reader_t * bson_reader_new_from_data(const uint8_t *data, size_t length) + + const bson_t * bson_reader_read(bson_reader_t *reader, bint *reached_eof) + + +# runtime version checking API +cdef extern from "bson/bson.h": + const char * bson_get_version() diff --git a/bindings/python/pymongoarrow/libbson/version.pyx b/bindings/python/pymongoarrow/libbson/version.pyx new file mode 100644 index 00000000..93208ebf --- /dev/null +++ b/bindings/python/pymongoarrow/libbson/version.pyx @@ -0,0 +1,21 @@ +# Copyright 2021-present MongoDB, Inc. +# +# 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. + +# Cython compiler directives +# cython: language_level=3 +# distutils: language=c +from pymongoarrow.libbson cimport bson_get_version + + +__version__ = bson_get_version().decode('utf-8') diff --git a/bindings/python/pymongoarrow/version.py b/bindings/python/pymongoarrow/version.py new file mode 100644 index 00000000..82ad90cd --- /dev/null +++ b/bindings/python/pymongoarrow/version.py @@ -0,0 +1,17 @@ +# Copyright 2021-present MongoDB, Inc. +# +# 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. + +__version__ = '0.1.0.dev0' + +_MIN_LIBBSON_VERSION = '1.17.0' diff --git a/bindings/python/setup.py b/bindings/python/setup.py new file mode 100644 index 00000000..06fbc478 --- /dev/null +++ b/bindings/python/setup.py @@ -0,0 +1,30 @@ +from setuptools import find_packages, setup +from Cython.Build import cythonize + +import os + + +def get_pymongoarrow_version(): + """Single source the version.""" + version_file = os.path.realpath(os.path.join( + os.path.dirname(__file__), 'pymongoarrow', 'version.py')) + version = {} + with open(version_file) as fp: + exec(fp.read(), version) + return version['__version__'] + + +def get_extension_modules(): + modules = cythonize(['pymongoarrow/*.pyx', + 'pymongoarrow/libbson/*.pyx']) + for module in modules: + module.libraries.append('bson-1.0') + return modules + + +setup( + name='pymongoarrow', + version=get_pymongoarrow_version(), + packages=find_packages(), + ext_modules=get_extension_modules(), + setup_requires=['cython >= 0.29']) diff --git a/bindings/python/test/test_libbson.py b/bindings/python/test/test_libbson.py new file mode 100644 index 00000000..c0f6a751 --- /dev/null +++ b/bindings/python/test/test_libbson.py @@ -0,0 +1,22 @@ +# Copyright 2021-present MongoDB, Inc. +# +# 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. +from unittest import TestCase + +from pymongoarrow.libbson.version import __version__ as libbson_version + + +class TestLibbson(TestCase): + def test_version(self): + self.assertIsNotNone(libbson_version) + self.assertIsInstance(libbson_version, str) diff --git a/bindings/python/test/test_pymongoarrow.py b/bindings/python/test/test_pymongoarrow.py new file mode 100644 index 00000000..178c57cc --- /dev/null +++ b/bindings/python/test/test_pymongoarrow.py @@ -0,0 +1,22 @@ +# Copyright 2021-present MongoDB, Inc. +# +# 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. +from unittest import TestCase + +from pymongoarrow.version import __version__ + + +class TestPyMongoArrow(TestCase): + def test_version(self): + self.assertIsNotNone(__version__) + self.assertIsInstance(__version__, str)