PinInPy 1.0.0__tar.gz

pininpy-1.0.0/.editorconfig

@@ -0,0 +1,9 @@
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = tab  # 缩进风格
+tab_width = 4  # 缩进宽度
+charset = utf-8  # 文件编码格式
+end_of_line = crlf  # 行尾格式，Windows一般为CRLF，Linux一般为LF，根据需要更改
+insert_final_newline = true   #文件结尾添加换行符，以防警告

pininpy-1.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,109 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # scikit-build-core 完美支持这三大平台
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive 
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+          
+      - name: Install generic dependencies
+        run: pip install cmake ninja
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.3.0
+        env:
+          CIBW_BUILD_VERBOSITY: "TRUE"
+          -DBUILD_SHARED_LIBS=ON: "ON"
+
+      - uses: actions/upload-artifact@v6
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.0.1
+        with:
+          submodules: recursive
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: python -m pip install build
+
+      - name: Build sdist
+        run: python -m build --sdist
+
+      # 【关键步骤 1B】: 上传源码包
+      - name: Upload sdist
+        uses: actions/upload-artifact@v6
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish_to_pypi:
+    name: Publish package to PyPI
+    # 必须等待所有构建任务成功完成
+    needs: [build_sdist]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # 这是必须的，允许 workflow 向 PyPI 进行身份验证
+      contents: read
+
+    steps:
+      # 【关键步骤 2】: 下载所有之前上传的工件
+      # 首先下载所有 wheel 文件到一个临时目录
+      - name: Download all wheels
+        uses: actions/download-artifact@v6
+        with:
+          # 使用通配符匹配所有以 cibw-wheels- 开头的工件
+          pattern: cibw-wheels-*
+          # 将它们合并到同一个目录下
+          merge-multiple: true
+          # 指定下载到 dist 目录
+          path: dist/
+      
+      # 接着下载源码包
+      - name: Download sdist
+        uses: actions/download-artifact@v6
+        with:
+          name: sdist
+          path: dist/
+
+      # 现在，dist/ 目录里已经包含了所有的 .whl 和 .tar.gz 文件
+      # 最后执行发布
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pininpy-1.0.0/.gitignore

@@ -0,0 +1 @@
+build/

pininpy-1.0.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "PinIn4Cpp"]
+	path = PinIn4Cpp
+	url = https://github.com/KagiamamaHIna/PinIn4Cpp.git

pininpy-1.0.0/CMakeLists.txt

@@ -0,0 +1,48 @@
+cmake_minimum_required(VERSION 3.15)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+project(PinInPy LANGUAGES C CXX)
+
+if(MSVC)
+    add_compile_options(/utf-8)
+endif()
+
+set(PININ4CPP_INSTALL OFF CACHE INTERNAL "")
+add_subdirectory("PinIn4Cpp")
+
+find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+if(MSVC)
+    #之前测试的时候发现win会找不到python3.lib，这个可以强制指定他找libs文件夹，里面有对应的python3.lib
+    if(Python_LIBRARIES)
+        get_filename_component(PYTHON_LIB_DIR "${Python_LIBRARIES}" DIRECTORY)
+
+        link_directories(${PYTHON_LIB_DIR})
+        message(STATUS "Python Library Dir: ${PYTHON_LIB_DIR}")
+    endif()
+endif()
+
+message(STATUS "Python Library: ${Python_LIBRARIES}")
+message(STATUS "Python Include: ${Python_INCLUDE_DIRS}")
+
+set(PY_BINDING_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+
+# 生成 CFFI 胶水代码 (.c)
+set(GENERATED_C "${CMAKE_CURRENT_BINARY_DIR}/_pinin4cpp_cffi.c")
+
+add_custom_command(
+    OUTPUT ${GENERATED_C}
+    COMMAND "${Python3_EXECUTABLE}" "${PY_BINDING_DIR}/build_cffi.py"
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    DEPENDS "${PY_BINDING_DIR}/build_cffi.py"
+)
+
+# Python编译模块
+python_add_library(_pinin4cpp_cffi MODULE ${GENERATED_C})
+
+
+target_link_libraries(_pinin4cpp_cffi PRIVATE PinIn4Cpp::PinIn4Cpp)
+target_link_libraries(_pinin4cpp_cffi PRIVATE Python::Module)
+
+install(TARGETS _pinin4cpp_cffi DESTINATION PinInPy)
+install(FILES PinIn4Cpp/LICENSE DESTINATION PinInPy/PinIn4Cpp)
+install(DIRECTORY PinIn4Cpp/licenses/ DESTINATION PinInPy/PinIn4Cpp/licenses)
+install(DIRECTORY package/ DESTINATION PinInPy)

pininpy-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 KagiyamaHina
+
+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.

pininpy-1.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.2
+Name: PinInPy
+Version: 1.0.0
+Summary: Python library for Pinyin searching
+Keywords: PinIn,pinyin match,pinyin,cffi
+Author-Email: SajoYukimi <kagiyamahino@gmail.com>
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: C++
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: Natural Language :: Chinese (Traditional)
+Project-URL: Homepage, https://github.com/KagiamamaHIna/PinInPy
+Project-URL: Bug Tracker, https://github.com/KagiamamaHIna/PinInPy/issues
+Project-URL: Source, https://github.com/KagiamamaHIna/PinInPy
+Requires-Python: >=3.9
+Requires-Dist: cffi
+Description-Content-Type: text/markdown
+
+[![Upload Python Package](https://github.com/KagiamamaHIna/PinInPy/actions/workflows/python-publish.yml/badge.svg)](https://github.com/KagiamamaHIna/PinInPy/actions/workflows/python-publish.yml)
+![PyPI version](https://img.shields.io/pypi/v/PinInPy)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/PinInPy)
+![PyPI - License](https://img.shields.io/pypi/l/PinInPy)
+
+# PinIn Python
+基于[PinIn4Cpp](https://github.com/KagiamamaHIna/PinIn4Cpp)的Python封装，提供C++的性能的同时用python的方式使用PinIn4Cpp
+
+## 特性
+完全基于PinIn4Cpp的C API，因此相比C++版本功能略有减少
+- 提供Pythonic的封装，而不必调用原始的C API
+- 高效的构建和即时搜索性能
+- 可配置的预设键位方案和模糊音方案
+
+## 安装
+```
+pip install PinInPy
+```
+
+## 示例
+**注意**：拼音字典文件(pinyin.txt)，需要自行准备，也可以从[pinyin-data](https://github.com/mozillazg/pinyin-data)中下载直接使用
+
+```python
+import PinInPy
+# BEGIN是前缀匹配，也就是根据字符串开头开始匹配
+tree = PinInPy.TreeSearcher(PinInPy.Logic.BEGIN, "pinyin.txt")
+tree.put_string("佐城雪美")
+tree.put_string("游佐梢")
+tree.put_string("市原仁奈")
+
+print(tree.execute_search("zcxm"))#根据zcxm搜索 打印: ["佐城雪美"]
+print(tree.execute_search("zchenxm"))#测试无模糊音时 打印: []
+
+pinin = tree.get_pinin()# 获取PinIn对象，可以用于配置依赖PinIn对象的TreeSearcher
+pinin.get_config().set_fEng2En(True).commit()# 设置eng -> en的模糊音
+# 这时候en == eng
+print(tree.execute_search("zchenxm"))# 打印: ["佐城雪美"]
+
+pinin.get_config().set_keyboard(PinInPy.Keyboard.MICROSOFT).commit()# 设置键位为微软双拼
+# y b(ou) z o(uo)  u(sh) k(ao) == you zuo shao
+print(tree.execute_search("ybzouk"))# 打印: ["游佐梢"]
+
+# 可以根据已有的PinIn对象去构造新的搜索树，PinIn上的配置是会被共享的 CONTAIN是部分匹配，部分匹配则是可以从任意位置开始匹配
+# 通常部分匹配的性能更差
+tree2 = PinInPy.TreeSearcher(PinInPy.Logic.CONTAIN, pinin)
+tree2.put_string("佐城雪美")
+tree2.put_string("游佐梢")
+tree2.put_string("市原仁奈")
+tree2.put_string("serika")
+# r f(en) n l(ai) == ren nai
+print(tree2.execute_search("rfnl"))# 因为是部分匹配，所以后面会被匹配仁奈 打印: ["市原仁奈"]
+# 注意！ 双拼是成对匹配的，如果只有奇数个拼音音素输入则不会匹配任何中文
+print(tree2.execute_search("r"))# 打印: ["serika"]
+```
+## 注意事项
+不包含PinIn4Cpp中的ParallelSearch，拼音格式化功能，Keyboard自定义（只能使用预设），从内存中加载字典文件，从内存中加载二进制序列化文件的功能
+PinIn类也不暴露拼音获取功能
+
+理论上是平台无关的，但是GitHub Actions只构建了Linux，Windows，MacOS的Wheel包，如果你的目标平台不是其中之一的话可以自行尝试下载源代码，配置CMake，配置C/C++编译器，用```pip install .```安装

pininpy-1.0.0/PinIn4Cpp/.editorconfig

@@ -0,0 +1,70 @@
+root = true
+
+[*.{c++,cc,cpp,cppm,cxx,h,h++,hh,hpp,hxx,inl,ipp,ixx,tlh,tli}]
+
+indent_style = tab
+tab_width = 4
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+
+cpp_generate_documentation_comments = xml
+
+cpp_indent_braces = false
+cpp_indent_multi_line_relative_to = innermost_parenthesis
+cpp_indent_within_parentheses = indent
+cpp_indent_preserve_within_parentheses = true
+cpp_indent_case_contents = true
+cpp_indent_case_labels = false
+cpp_indent_case_contents_when_block = false
+cpp_indent_lambda_braces_when_parameter = true
+cpp_indent_goto_labels = one_left
+cpp_indent_preprocessor = leftmost_column
+cpp_indent_access_specifiers = false
+cpp_indent_namespace_contents = true
+cpp_indent_preserve_comments = false
+cpp_new_line_before_open_brace_namespace = ignore
+cpp_new_line_before_open_brace_type = ignore
+cpp_new_line_before_open_brace_function = ignore
+cpp_new_line_before_open_brace_block = ignore
+cpp_new_line_before_open_brace_lambda = ignore
+cpp_new_line_scope_braces_on_separate_lines = false
+cpp_new_line_close_brace_same_line_empty_type = false
+cpp_new_line_close_brace_same_line_empty_function = false
+cpp_new_line_before_catch = true
+cpp_new_line_before_else = true
+cpp_new_line_before_while_in_do_while = false
+cpp_space_before_function_open_parenthesis = remove
+cpp_space_within_parameter_list_parentheses = false
+cpp_space_between_empty_parameter_list_parentheses = false
+cpp_space_after_keywords_in_control_flow_statements = true
+cpp_space_within_control_flow_statement_parentheses = false
+cpp_space_before_lambda_open_parenthesis = false
+cpp_space_within_cast_parentheses = false
+cpp_space_after_cast_close_parenthesis = false
+cpp_space_within_expression_parentheses = false
+cpp_space_before_block_open_brace = true
+cpp_space_between_empty_braces = false
+cpp_space_before_initializer_list_open_brace = false
+cpp_space_within_initializer_list_braces = true
+cpp_space_preserve_in_initializer_list = true
+cpp_space_before_open_square_bracket = false
+cpp_space_within_square_brackets = false
+cpp_space_before_empty_square_brackets = false
+cpp_space_between_empty_square_brackets = false
+cpp_space_group_square_brackets = true
+cpp_space_within_lambda_brackets = false
+cpp_space_between_empty_lambda_brackets = false
+cpp_space_before_comma = false
+cpp_space_after_comma = true
+cpp_space_remove_around_member_operators = true
+cpp_space_before_inheritance_colon = true
+cpp_space_before_constructor_colon = true
+cpp_space_remove_before_semicolon = true
+cpp_space_after_semicolon = true
+cpp_space_remove_around_unary_operator = true
+cpp_space_around_binary_operator = insert
+cpp_space_around_assignment_operator = insert
+cpp_space_pointer_reference_alignment = left
+cpp_space_around_ternary_operator = insert
+cpp_wrap_preserve_blocks = one_liners

pininpy-1.0.0/PinIn4Cpp/.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain