当site-packages的类型为.so，Python解释器不会提示或列出该模块可用的函数和类的原因及解决方法

本文链接：https://blog.csdn.net/ciky2011/article/details/139796339

原因：

当你在Python中导入一个.so文件（或者任何扩展模块）时，如果它不提供任何Python级别的接口或文档，Python解释器通常不会提示或列出可用的函数和类。这是因为扩展模块可能是用C语言编写的，并且它们通常不会向Python解释器提供元信息，这些信息可以用来生成帮助文档或自动完成功能。

解决方法：

为 .so 文件提供Python级别的接口或文档通常涉及创建Python包装器，这个包装器将C扩展的API转换为Python友好的函数和类。这通常意味着你需要编写一些Python代码来加载 .so 文件，并通过 ctypes 或其他类似库调用其中的函数。同时，你也可以为这些函数和类编写文档字符串（docstrings），以便提供Python级别的文档。

以下是如何为 .so 文件提供Python接口和文档的基本步骤：

编写Python包装器代码：
创建一个Python模块，该模块使用 ctypes 加载 .so 文件，并定义函数来调用 .so 文件中暴露的C函数。
定义参数类型和返回值：
使用 ctypes 的数据类型来定义C函数的参数类型和返回值类型，确保正确的类型转换。
编写文档字符串：
为每个包装函数编写Python文档字符串（docstrings），解释函数的目的、参数和返回值。
提供示例和教程：
如果可能的话，编写一些示例代码和教程，展示如何使用你的Python包装器。
生成文档：
使用工具如 sphinx 或 docstrings 生成格式化的文档。

下面是一个简单的例子，展示如何为 .so 文件提供Python接口和文档：

example.py (Python包装器)

import ctypes

# 加载.so文件
lib = ctypes.CDLL('./path/to/your/library.so')

# 定义C函数的参数类型和返回值类型
lib.add.argtypes = [ctypes.c_int, ctypes.c_int]
lib.add.restype = ctypes.c_int

# Python包装函数
def add(a, b):
    """
    Add two integers together.

    Args:
        a (int): The first integer to add.
        b (int): The second integer to add.

    Returns:
        int: The sum of the two integers.
    """
    return lib.add(a, b)

# 其他包装函数...

文档生成
你可以使用像 sphinx 这样的工具来从Python代码中的docstrings自动生成文档。安装 sphinx 后，你可以在项目的根目录下创建一个 docs 文件夹，并使用 sphinx-quickstart 命令来初始化文档项目。然后，你可以编辑生成的 conf.py 文件来配置你的文档项目，并编写 .rst 格式的源文件来组织你的文档内容。

最后，运行 sphinx-build 命令来生成HTML或其他格式的文档。

注意事项：