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]

其中 <module_names> 是模块名称的空格分隔列表(模块必须可以从工作目录导入),而 [OPTIONS] 可以是以下之一

  • –quiet:静默运行工具,不输出到标准输出。

  • –outpath <output_dir>:指定生成的伪代码文件 outputFile 的输出目录。如果不指定,伪代码文件将在模块二进制文件所在的目录中生成。

  • –sys-path <paths>:在系统路径(《sys.path》)前加上一个空格分隔的字符串列表 <paths>。如果模块未安装到默认查找位置,则此选项很有用。

  • –feature <features>:一个空格分隔的列表,可选启用 PySide 特性(请参阅 注意事项)。当使用 PyPy 时,此选项没有效果。目前可用的功能有

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

    • true_property:将标记为 Qt6 文档中的属性的模块中的所有获取器和设置器函数替换为 Python 属性对象。属性也在相应的 QMetaObject 的类中以这种方式列出。