webassembly003 whisper.cpp的python绑定实现+Cython+Setuptools

python绑定项目

• 官方未提供python的封装绑定，直接调用执行文件
  

• https://github.com/stlukey/whispercpp.py提供了源码和Cpython结合的绑定

• https://github.com/zhujun1980/whispercpp_py提供了ctype方式的绑定，需要先make libwhisper.so

• Pybind11 bindings for Whisper.cpp，有更好的类型安全性和性能

Setuptools

• setuptools 是 Python 中用于构建和分发软件包的工具，它提供了一种简化和标准化的方式来定义和管理项目的元数据、依赖关系以及构建过程。

安装：

pip install setuptools

示例：setup.py 封装python实现的add 模块：

• 项目结构如下：

my_package/
|-- my_package/
|   |-- __init__.py # NULL
|   |-- add.py
|-- setup.py
|-- README.md

• add.py：

# add.py
def add(a, b):
    return a + b

• setup.py：

# setup.py
from setuptools import setup, find_packages

setup(
    name="my_package",
    version="1.0",
    packages=find_packages(),
    install_requires=[
        # Specify your project dependencies here
    ],
)

• 构建和安装：

在项目根目录下运行以下命令：python setup.py build,python setup.py install

其他构建方式：打tar包/tar包安装，打egg包/egg包安装，打whl包/whl包安装

• 使用：

from my_package import add

result = add.add(3, 4)
print(result)  # 输出 7

3. 项目依赖和包管理：

在 setup.py 中，使用 install_requires 列表来指定项目的依赖关系。当用户安装你的包时，这些依赖关系将会自动安装。

5. 使用 setuptools 扩展：

如果你的项目包含 C 或 C++ 扩展，你可以使用 setuptools.Extension 来指定这些扩展。以下是一个简单的例子：

from setuptools import setup, Extension

ext_module = Extension(
    'your_module',  # 模块名称
    sources=['your_module.c'],  # 源代码文件
)

setup(
    name="your_package",
    version="1.0",
    ext_modules=[ext_module],
)

构建 Cython 扩展：

Cython基础

.pxd 文件，.pyx 文件，.pyd 文件

文件类型	描述
.pxd 文件	由 Cython 编程语言编写的 Python 扩展模块头文件。类似于 C 语言的 .h 头文件。包含模块的声明和代码段。可共享外部 C 语言声明，也能包含 C 编译器内联函数。为 .pyx 文件提供接口，以便其他 Cython 模块可以使用更高效的协议与之通信。可使用 cimport 关键字将 .pxd 文件导入 .pyx 模块文件中。
.pyx 文件	由 Cython 编程语言编写的 Python 扩展模块源代码文件。类似于 C 语言的 .c 源代码文件。包含模块的源代码。必须先编译成 .c 文件，再编译成 .pyd（Windows）或 .so（Linux）文件，方可导入和使用。
.pyd 文件	由非 Python 编程语言编写并编译生成的 Python 扩展模块。在 Python 中使用时，通过 import 语句导入。实际上，在 .pyd 文件中封装了一个模块。Cython 可以将个人基于 Python 的模块编译成具有 C 语言特性的 .pyd 文件。

常见的 Cython 数据类型：

1. 基本整数类型：

• int：标准整数类型。
• long：长整数类型。
• bint：布尔类型。

cdef int a = 42
cdef long b = 1234567890123456789
cdef bint flag = True

2. 浮点数类型：

• float：标准浮点数类型。
• double：双精度浮点数类型。

cdef float x = 3.14
cdef double y = 2.71828

3. 数组和缓冲区类型：

• list：Python 列表。
• tuple：Python 元组。
• array：Cython 提供的数组类型。

cdef list py_list = [1, 2, 3]
cdef tuple py_tuple = (4, 5, 6)
cdef int[:] cython_array = array([7, 8, 9])

4. 字符串类型：

• str：Python 字符串类型。
• bytes：字节类型。

cdef str py_string = "Hello"
cdef bytes cython_bytes = b"World"

bytes

在 CPython（即官方的 Python 解释器）中，bytes 对象是不可变的序列，用于存储二进制数据。它与 bytearray 对象的主要区别在于，bytes 对象是不可变的，而 bytearray 对象是可变的。

以下是关于 bytes 对象的一些基本信息：

1. 不可变性：bytes 对象是不可变的，这意味着一旦创建，其内容不能被修改。你不能像列表一样通过索引赋值来改变 bytes 对象中的某个元素。

2. 字节表示：bytes 对象包含一系列字节，每个字节的值范围在 0 到 255 之间。字节以整数表示，并可以使用 b'...' 语法来创建 bytes 字面值。

   # 创建bytes对象
   b = b'Hello, World!'
   

3. 字节序列的操作：bytes 支持与字节序列相关的许多操作，例如索引、切片、长度计算等。

   # 使用索引获取字节值
   print(b[0])  # 输出 72 (ASCII码中 'H' 的值)
   
   # 使用切片获取部分字节序列
   print(b[7:])  # 输出 b'World!'
   
   # 计算字节序列的长度
   print(len(b))  # 输出 13
   

4. 不可变性的好处：bytes 对象的不可变性使得它适用于表示一些固定不变的二进制数据，例如文件内容、网络数据等。此外，由于不可变性，bytes 对象可以作为字典的键，而 bytearray 对象不能。

   # 不可变性允许bytes对象作为字典键
   data_dict = {b'key': 'value'}
   

5. 内置方法：bytes 类型提供了一些内置方法，如 decode() 用于将字节解码为字符串，hex() 用于获取字节的十六进制表示。

   # 解码为字符串
   string_representation = b.decode('utf-8')
   
   # 获取十六进制表示
   hex_representation = b.hex()
   

• 这将创建一个 Python 字节字符串对象，该对象包含 原始 C 字符串。它可以在 Python 代码中安全地传递，并且 将在对它的最后一个引用结束时进行垃圾回收 范围。重要的是要记住，字符串中的 null 字节会起作用 作为终止符字符，通常从 C 中知道。以上将 因此，仅适用于不包含 null 的 C 字符串 字节。

5. 其他类型：

• object：Python 对象类型，通常用于处理任意类型的对象。
• memoryview：内存视图类型，用于处理内存缓冲区。
• pointer：指针类型，用于与 C 语言中的指针进行交互。

cdef object generic_object = some_function()
cdef memoryview buffer_view = memoryview(some_buffer)
cdef int* ptr = some_pointer

6. 并行迭代类型：

• prange：并行迭代类型，用于在循环中实现并行迭代。

from cython.parallel import prange

cdef int i
for i in prange(10):
    # 在此进行并行迭代的操作

这些类型提供了在 Cython 中进行类型声明和优化的灵活性。选择适当的类型取决于你的算法和数据的特性，以及在 Cython 中进行性能优化的目标。

Cpython的强制类型转换

在 Cython 中，与 C 类型相关的强制类型转换通常是通过 C 的类型声明和类型转换函数来实现的。以下是一些常见的 Cython 中的类型转换示例：

1. C 的类型声明

在 Cython 中，可以使用 C 的类型声明来明确变量的类型。例如，对于整数、浮点数和字符类型：

cdef int x = 42
cdef double y = 3.14
cdef char c = 'A'

2. Python 对象到 C 类型的转换

使用 () 语法将 Python 对象强制转换为 C 类型。例如，将 Python 中的整数对象转换为 C 中的整数：

cdef int py_int = 42
cdef int c_int = py_int

3. C 类型到 Python 对象的转换

使用 () 语法将 C 类型强制转换为 Python 对象。例如，将 C 中的整数转换为 Python 中的整数对象：

cdef int c_int = 42
cdef object py_int =