SIP参考指南 - 介绍

Posted 2020-07-28 上善若『水』瓶座

介绍

    本文是SIP4.18的参考指南。SIP是一种Python工具，用于自动生成Python与C、C++库的绑定。SIP最初是在1998年用PyQt开发的，用于Python与Qt GUI toolkit的绑定，但适用于生成任何C或C++库的绑定。

    此版本SIP生成的绑定可用于Python 2.3以后的版本，包括Python 3.x。

    还有许多其他类似的工具，例如SWIG。事实上，SIP如此名字是因为它源于一个小型的SWIG。但不像SWIG，SIP是特别设计于将Python与C/C++进行绑定的，它尽可能地集成更多C/C++的功能。

    SIP官网：http://www.riverbankcomputing.com/software/sip
    在这里你总能找到最新的稳定版与最新版的文档。

    SIP也可以从Mercurial库下载：http://www.riverbankcomputing.com/hg/sip.

许可

    SIP许可类似于Python，也采用GPL协议(包括v2和v3)。如果你使用SIP，意味着你必须遵循GPL协议。

特征

SIP和它所生成的绑定拥有如下特征：

• 加载迅速，内存占用低。
• 自动转换标准的Python与C/C++数据类型。
• 不同参数签名的函数和方法的重载
• 访问C++类的protected方法
• 能够定义一个继承于C++类型的Python子类，包括C++抽象类
• Python子类可以实现__dtor__()方法来支持C++类的虚析构函数的调用。
• 支持普通C++函数、类方法、静态类方法、虚类方法和抽象类方法。
• 可以在Python中重新实现C++虚/抽象方法
• 支持全局和Class变量
• 支持全局和Class操作
• 支持C++命名空间
• 支持C++模板
• 支持C++异常并转换为Python异常
• 丰富的comparsion slots的自动生成
• 支持deprecation警告
• 支持定义C++类与相似的Python数据类型的映射，并自动调用
• 支持自动利用任何可用的运行时类型信息，确保Python实例对象类型与对应的C++对象实例相匹配
• 可以转换在类型与meta类型之间转换python对象，用以包装一个C/C++数据类型
• 支持Python全局解释器锁，包括指示一个C++函数可能被阻塞，从而允许释放锁，让其他Python线程运行。
• 支持将多个简单的或私有相关的模块合并为一个模块。
• 支持C++实例所有权概念（即代码的哪些部分负责调用实例的析构函数），支持所有权在应用程序运行期间的改变。
• 产生一个本身建立在其他C++类库之上的C++类库，允许不同的bindings之间代码集成与共享。
• 支持用一套规范的文件，定义复杂的版本控制系统。允许控制C++类库的全生命周期，包括指定特定于平台的可选功能。
• 支持自动生成PEP 484 类型hint stub文件，可以在指定的文件中包含说明文档，并允许外部工具提取和处理。
• 可以在所有生成的源码中自动包含规范文件中所声明的版权和授权信息。
• 可以在Python书写的构建系统中继承配置，编译并且安装你自己的绑定，从而无需担心平台的具体问题。
• 使用distutils构建你的扩展支持。
• SIP以及其生成的bindings，可以运行在UNIX，Linux，Windows，MacOS/X，android and ios中

SIP组件

SIP由一些不同的组件构成。

• SIP代码生成器。它处理.sip规范文件并生成C或C++bindings。转换详情参考《使用SIP(Using SIP)》一节。
• SIP头文件(sip.h)。它包含生成C与C++代码所需要的规范与数据结构。
• SIP模块（sip.so或sip.pyd）。这是一个python扩展模块，自动由SIP生成的bindings导入，并为它们提供一些通用的工具函数。详情参考《应用程序Python API(Python API for Applications)》
• SIP构建系统（sipconfig.py）。它是一个纯python模块，在SIP被配置并封装所有系统的相关信息时被创建。它包含目录名称、编译和链接标志以及版本号，它也包含一些Python类与函数。它帮助你为bindings编写配置脚本。
• SIP distutils扩展(sipdistutils.py)。这是一个distutils扩展，可以用distutils构建你的扩展模块。用于替代手动编写SIP构建系统的配置脚本。它可以很简单的添加.sip文件到你需要构建和扩展的文件清单。详情参见《用distutils构建扩展(Building Your Extension with distutils)》。

SIP v5的准备

SIP指定文件的语法将在SIP v5中改变。SIP代码生成器的命令行选项也会改变。为了帮助用户管理过度，将采用以下方法

• 尽可能把所有不兼容的变更，首先在SIP v4中实现。
• 不兼容的变更实现之后，老的语法将被指定为deprecated（提示警告），但仍然在v4中支持。

Qt支持

SIP为创建基于Digia的Qt 工具包提供支持。

SIP代码生成器理解signal/slot类型安全的回调机制，该机制被Qt用于把对象连接到一起。它允许应用程序定义新的Python signals，并且允许python调用对象可以像slot一样使用。