pyside6-genpyi

pyside6-genpyi 是一个命令行工具，用于为 PySide 模块生成 Python 存根文件 (.pyi)。存根文件定义了 PySide 模块中所有类、 方法（包括重载）、常量和枚举的签名。签名还包含类型提示。这有助于 PySide 与 Python 类型检查器和 IDE 集成。例如，如果您使用 PySide 调用 Qt API 中的任何函数， 您的 IDE 的函数查找功能将显示函数的签名及其参数和返回值 包括类型。

PySide6 已经附带了由 pyside6-genpyi 生成的存根文件。然而，如果你想为多个（或所有）模块生成新的存根文件，例如为了切换一些功能，你可以手动运行 pyside6-genpyi。如果你想为你自己的自定义模块生成存根文件，请参考 shiboken6-genpyi。

用法

要为PySide模块生成存根文件，请运行以下命令：

pyside6-genpyi <module_names> [OPTIONS]

其中 是一个以空格分隔的模块名称列表（这些模块必须可以从工作目录导入），而 [OPTIONS] 可以是以下之一：

  • –quiet: 安静地运行工具，不输出到标准输出。

  • –outpath : 指定生成的存根文件的输出目录。如果未指定，存根文件将在模块二进制文件的位置生成。

  • –sys-path : 在系统路径 (sys.path) 前添加一个由空格分隔的字符串列表 。如果模块未安装在默认的查找位置，这将非常有用。

  • –feature : 一个以空格分隔的可选 PySide 功能列表，用于启用（参见 注意事项）。使用 PyPy 时，此选项无效。目前，以下功能可用：

    • snake_case: 模块中的所有方法从 camelCase 切换到 snake_case。单个大写字母被替换为下划线和小写字母。

    • true_property: 模块中所有在 Qt6 文档中标记为属性的 getter 和 setter 函数被替换为 Python 属性对象。属性也会在类的相应 QMetaObject 中列出。