nanobind-stubgen

为nanobind模块生成Python存根文件（pyi），以供IDE中的代码补全使用。

安装

pip install nanobind-stubgen

用法

Nanobind stubgen使用inspect模块反向工程模块结构并检测nanobind类型。nanobind类型的文档字符串包含函数签名，这些签名将被用于创建存根文件。

要为模块创建pyi文件，首先安装模块，然后使用模块名称作为第一个参数调用nanobind-stubgen。以下是如何为nanogui生成存根的示例

nanobind-stubgen nanogui

可以通过指定参数--out来更改输出路径（默认为当前目录）。要将pyi文件直接在nanogui包目录中创建，可以使用以下命令（注意更改Python版本）

nanobind-stubgen nanogui --out venv/lib/python3.9/site-packages

限制

• 存根生成器不使用nanobind项目，而是使用实际编译的Python模块。这意味着，生成器只能检测写入到nanobind的__doc__字符串中的模块和函数信息。
• pyi文件中只添加了一些导入
• 支持方法重载，但仅限于一定程度

帮助

positional arguments:
  module             Module to create stubs (e.g. nanogui).

optional arguments:
  -h, --help         show this help message and exit
  --package PACKAGE  Optional package path to import module from.
  --out OUT          Output path for the generated pyi files.

关于

MIT许可证