diff --git a/binding/python/.gitignore b/binding/python/.gitignore new file mode 100644 index 0000000..3708dbc --- /dev/null +++ b/binding/python/.gitignore @@ -0,0 +1,33 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# Environments +.env +.venv +env/ +venv/ +ENV/ + +# PyPI configuration file +.pypirc diff --git a/binding/python/LICENSE b/binding/python/LICENSE new file mode 100644 index 0000000..739ef00 --- /dev/null +++ b/binding/python/LICENSE @@ -0,0 +1,225 @@ + 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. + +========================================================================== +The following license applies to the ip2region library +-------------------------------------------------------------------------- +Copyright (c) 2015 Lionsoul + +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. diff --git a/binding/python/MANIFEST.in b/binding/python/MANIFEST.in new file mode 100644 index 0000000..e5eb5f9 --- /dev/null +++ b/binding/python/MANIFEST.in @@ -0,0 +1,3 @@ +include LICENSE +include ReadMe.md +recursive-include tests *_test.py *_test.v \ No newline at end of file diff --git a/binding/python/ReadMe.md b/binding/python/ReadMe.md index da70d2d..158b931 100644 --- a/binding/python/ReadMe.md +++ b/binding/python/ReadMe.md @@ -13,7 +13,7 @@ search(ip: str | bytes) ### 关于 IPv4 和 IPv6 该 xdb 查询客户端实现同时支持对 IPv4 和 IPv6 的查询，使用方式如下： ```python -import xdb.util as util +import ip2region.util as util # 如果是 IPv4: 设置 xdb 路径为 v4 的 xdb 文件，IP版本指定为 util.IPv4 db_path = "../../data/ip2region_v4.xdb" # 或者你的 ipv4 xdb 的路径 @@ -30,7 +30,7 @@ version = util.IPv6 ### 文件验证 建议您主动去验证 xdb 文件的适用性，因为后期的一些新功能可能会导致目前的 Searcher 版本无法适用你使用的 xdb 文件，验证可以避免运行过程中的一些不可预测的错误。 你不需要每次都去验证，例如在服务启动的时候，或者手动调用命令验证确认版本匹配即可，不要在每次创建的 Searcher 的时候运行验证，这样会影响查询的响应速度，尤其是高并发的使用场景。 ```python -import xdb.util as util +import ip2region.util as util try: util.verify_from_file(db_path) @@ -47,7 +47,7 @@ except Exception e: ### 完全基于文件的查询 ```python -import xdb.searcher as xdb +import ip2region.searcher as xdb # 1，使用上述的 version 和 db_path 创建完全基于文件的查询对象 try: @@ -76,8 +76,8 @@ searcher.close() 我们可以提前从 `xdb` 文件中加载出来 `VectorIndex` 数据，然后全局缓存，每次创建 Searcher 对象的时候使用全局的 VectorIndex 缓存可以减少一次固定的 IO 操作，从而加速查询，减少 IO 压力。 ```python -import xdb.util as util -import xdb.searcher as xdb +import ip2region.util as util +import ip2region.searcher as xdb # 1、从 db_path 中预先加载 VectorIndex 缓存，并且把这个得到的数据作为全局变量，后续反复使用。 try: @@ -113,8 +113,8 @@ searcher.close() 我们也可以预先加载整个 xdb 文件的数据到内存，然后基于这个数据创建查询对象来实现完全基于内存的查询，类似之前的 memory search。 ```python -import xdb.util as util -import xdb.searcher as xdb +import ip2region.util as util +import ip2region.searcher as xdb # 1、从 db_path 加载整个 xdb 到内存。 try: diff --git a/binding/python/bench_test.py b/binding/python/bench_test.py index f02025e..9542a1f 100644 --- a/binding/python/bench_test.py +++ b/binding/python/bench_test.py @@ -9,8 +9,8 @@ import io import sys import argparse import time -import xdb.util as util -import xdb.searcher as xdb +import ip2region.util as util +import ip2region.searcher as xdb def create_searcher(db_path, cache_policy): # open the source xdb file diff --git a/binding/python/xdb/__init__.py b/binding/python/ip2region/__init__.py similarity index 100% rename from binding/python/xdb/__init__.py rename to binding/python/ip2region/__init__.py diff --git a/binding/python/xdb/searcher.py b/binding/python/ip2region/searcher.py similarity index 98% rename from binding/python/xdb/searcher.py rename to binding/python/ip2region/searcher.py index c22e092..243e033 100644 --- a/binding/python/xdb/searcher.py +++ b/binding/python/ip2region/searcher.py @@ -6,7 +6,7 @@ # Author Leon import io -import xdb.util as util +import ip2region.util as util class Searcher(object): ''' diff --git a/binding/python/xdb/util.py b/binding/python/ip2region/util.py similarity index 100% rename from binding/python/xdb/util.py rename to binding/python/ip2region/util.py diff --git a/binding/python/search_test.py b/binding/python/search_test.py index c9e75ef..56dc5b6 100644 --- a/binding/python/search_test.py +++ b/binding/python/search_test.py @@ -9,8 +9,8 @@ import io import sys import argparse import time -import xdb.util as util -import xdb.searcher as xdb +import ip2region.util as util +import ip2region.searcher as xdb def create_searcher(db_path, cache_policy): # open the source xdb file diff --git a/binding/python/setup.py b/binding/python/setup.py new file mode 100644 index 0000000..8424dd8 --- /dev/null +++ b/binding/python/setup.py @@ -0,0 +1,23 @@ +import setuptools + +setuptools.setup( + name="ip2region", + version="3.0.0", + description="official python binding for ip2region with both IPv4 and IPv6 supported", + long_description=open("ReadMe.md", encoding='utf-8').read(), + long_description_content_type='text/markdown', + + url="https://github.com/lionsoul2014/ip2region", + license="Apache-2.0 License", + author_email="chenxin619315@gmail.com", + author="lionsoul2014", + + packages=setuptools.find_packages(), + include_package_data=True, + install_requires=[], + classifiers=( + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + ), +) \ No newline at end of file diff --git a/binding/python/util_test.py b/binding/python/util_test.py index 772ce12..63d548a 100644 --- a/binding/python/util_test.py +++ b/binding/python/util_test.py @@ -8,8 +8,8 @@ import os import sys import time -import xdb.util as util -import xdb.searcher as xdb +import ip2region.util as util +import ip2region.searcher as xdb script_dir = os.path.dirname(__file__) data_dir = os.path.join(script_dir, '../../data/') @@ -158,4 +158,4 @@ if __name__ == "__main__": c_time = time.time() - s_time print(f"|---Done, elapsed {c_time:.6f}s") else: - sys.exit("unable to call function {}".format(func)) \ No newline at end of file + sys.exit("unable to call function {}".format(func))