CN117908857A - 混合编程开发方法、系统、存储介质和计算机设备 - Google Patents

Abstract

本申请涉及一种混合编程开发方法、系统、存储介质和计算机设备，其中，该方法包括：步骤S1：解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息；步骤S2：解析源目录中的所有头文件，以获取头文件中的导出类、导出函数，并根据导出类以及导出函数生成shiboken配置；步骤S3：将shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件；步骤S4：完成C++库与Python的相互调用。本申请的有益效果是：本申请在每次代码发生变更时，可自动化生成配置文件，不需要手动调整，可有效的简化转换所需配置文件，大幅减少C++代码更新后的维护工作量。

Description

混合编程开发方法、系统、存储介质和计算机设备

技术领域

本申请涉及软件编程技术领域，特别是涉及混合编程开发方法、系统、存储介质和计算机设备。

背景技术

C++具有高性能、直接内存控制、硬件的底层访问优势特点，而Python则具有语法简单易读、开发速度快、生态丰富的特点，为了实现两者优势特征的结合，现阶段可通过shiboken2模块的转换功能来实现将C++程序集成至Python，以在Python上调用C++的类和函数，以实现跨平台混合编辑开发的目的。

然而，当前方案shiboken2模块转换所需的配置文件需要手动配置，配置操作相对复杂，需要细化到具体的命名空间和类，例如：QCoreApplication类型，需要在配置文件中配置，对应的类型名称，若有增删函数和其他需求也需要手动配置；并且会使得C++代码调整后的维护工作量大，例如：当C++中的类增加或删除，命名空间调整时需要修改配置文件，其中还包含一些特殊类型的自动化处理，例如多继承、智能指针和引用类型的情况。

发明内容

本申请实施例提供了一种混合编程开发方法、系统、存储介质和计算机设备，以解决现有技术中配置文件过于复杂、C++代码调整后的维护工作量大的问题。

第一方面，本申请实施例提供了一种混合编程开发方法，具体包括以下步骤：

步骤S1：解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息；

步骤S2：解析所述源目录中的所有头文件，以获取所述头文件中的导出类、导出函数，并根据所述导出类以及所述导出函数生成shiboken配置；

步骤S3：将所述shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件；

步骤S4：完成C++库与Python的相互调用。

本发明提出的混合编程开发方法，通过解析配置文件，获取配置文件中的关键信息，根据关键信息生成shiboken配置；再shiboken2.exe程序进行编译，生成python数据文件。本申请技术方案可以实现在C++代码中执行Python的代码，在Python代码中执行C++的代码，也就是相互调用，并且本申请在每次代码发生变更时，可自动化生成配置文件，不需要手动调整，通过本申请技术方案可有效的简化转换所需配置文件，大幅减少C++代码更新后的维护工作量。

进一步的，本发明实施例提出的混合编程开发方法，还具有如下附加技术特征：

优选的，所述解析所述源目录中的所有头文件，以获取所述头文件中的导出类、导出函数的步骤具体包括：

步骤S21：采用Clang解析递归遍历每个所述头文件；

步骤S22：将解析结果转换为包含命名空间、类、函数、枚举信息的数据源，其中，所述数据源包括所述导出类以及所述导出函数。

优选的，所述将所述shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件的步骤之后，还包括：

步骤S31：读取所述python数据文件内部的类、函数、注释信息；

步骤S32：根据所述python数据文件内部的类、函数、注释信息生成可供Python智能提示识别的存根文件。

优选的，所述生成python数据文件的步骤具体包括：

步骤S41：执行shiboken2.exe生成转换代码；

步骤S42：基于所述转换代码构建cmake项目，编译生成所述python数据文件。

第二方面，本申请实施例提供了混合编程开发系统。所述系统包括：

第一解析模块：用于解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息；

第二解析模块：用于解析所述源目录中的所有头文件，以获取所述头文件中的导出类、导出函数；

shiboken配置生成模块：用于根据所述导出类以及所述导出函数生成shiboken配置；

pyd生成模块：用于将所述shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件；

调用模块：用于实现C++库与Python的相互调用。

优选的，所述第二解析模块具体包括：

遍历单元：用于递归遍历每个所述头文件；

转换单元：用于将解析结果转换为包含命名空间、类、函数、枚举信息的数据源，其中，所述数据源包括所述导出类以及所述导出函数。

优选的，所述系统还包括：

读取模块：用于读取所述python数据文件内部的类、函数、注释信息；

pyi生成模块：用于根据所述python数据文件内部的类、函数、注释信息生成可供Python智能提示识别的存根文件。

优选的，所述pyd生成模块具体包括：

转换代码生成单元：用于生成转换代码；

项目构建单元：用于基于所述转换代码构建cmake项目；

编译单元：用于编译生成所述python数据文件。

第三方面，本申请实施例提供了一种可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现如上述第一方面所述的混合编程开发方法。

第四方面，本申请实施例提供了一种计算机设备，包括存储器、处理器以及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如上述第一方面所述的混合编程开发方法。

本申请的一个或多个实施例的细节在以下附图和描述中提出，以使本申请的其他特征、目的和优点更加简明易懂。

附图说明

此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：

图1是本发明第一实施例提出的混合编程开发方法流程图；

图2是本发明第一实施例中Python调用C++库的示例如图；

图3是本发明第一实施例中C++执行Python的示例图；

图4是本发明第一实施例提出的混合编程开发方法中，解析源目录的方法流程图；

图5是本发明第一实施例提出的混合编程开发方法中，生成存根文件的方法流程图；

图6是本发明第一实施例中pyi生成的示例如图；

图7是本发明第一实施例中构建cmake项目的示例图；

图8是本发明第一实施例中输出pyd的示例图。

具体实施方式

为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行描述和说明。应当理解，此处所描述的具体实施例仅仅用以解释本申请，并不用于限定本申请。基于本申请提供的实施例，本领域普通技术人员在没有作出创造性劳动的前提下所获得的所有其他实施例，都属于本申请保护的范围。

显而易见地，下面描述中的附图仅仅是本申请的一些示例或实施例，对于本领域的普通技术人员而言，在不付出创造性劳动的前提下，还可以根据这些附图将本申请应用于其他类似情景。此外，还可以理解的是，虽然这种开发过程中所作出的努力可能是复杂并且冗长的，然而对于与本申请公开的内容相关的本领域的普通技术人员而言，在本申请揭露的技术内容的基础上进行的一些设计，制造或者生产等变更只是常规的技术手段，不应当理解为本申请公开的内容不充分。

在本申请中提及“实施例”意味着，结合实施例描述的特定特征、结构或特性可以包含在本申请的至少一个实施例中。在说明书中的各个位置出现该短语并不一定均是指相同的实施例，也不是与其它实施例互斥的独立的或备选的实施例。本领域普通技术人员显式地和隐式地理解的是，本申请所描述的实施例在不冲突的情况下，可以与其它实施例相结合。

除非另作定义，本申请所涉及的技术术语或者科学术语应当为本申请所属技术领域内具有一般技能的人士所理解的通常意义。本申请所涉及的“一”、“一个”、“一种”、“该”等类似词语并不表示数量限制，可表示单数或复数。本申请所涉及的术语“包括”、“包含”、“具有”以及它们任何变形，意图在于覆盖不排他的包含；例如包含了一系列步骤或模块(单元)的过程、方法、系统、产品或设备没有限定于已列出的步骤或单元，而是可以还包括没有列出的步骤或单元，或可以还包括对于这些过程、方法、产品或设备固有的其它步骤或单元。本申请所涉及的“连接”、“相连”、“耦接”等类似的词语并非限定于物理的或者机械的连接，而是可以包括电气的连接，不管是直接的还是间接的。本申请所涉及的“多个”是指两个或两个以上。“和/或”描述关联对象的关联关系，表示可以存在三种关系，例如，“A和/或B”可以表示：单独存在A，同时存在A和B，单独存在B这三种情况。字符“/”一般表示前后关联对象是一种“或”的关系。本申请所涉及的术语“第一”、“第二”、“第三”等仅仅是区别类似的对象，不代表针对对象的特定排序。

C++具有高性能、直接内存控制、硬件的底层访问优势特点，而Python则具有语法简单易读、开发速度快、生态丰富的特点，为了实现两者优势特征的结合，现阶段可通过shiboken2模块的转换功能来实现将C++程序集成至Python，以在Python上调用C++的类和函数，以实现跨平台混合编辑开发的目的。

然而，当前方案shiboken2模块转换所需的配置文件需要手动配置，配置操作相对复杂，需要细化到具体的命名空间和类，例如：QCoreApplication类型，需要在配置文件中配置对应的类型名称，若有增删函数和其他需求也需要手动配置；并且会使得C++代码调整后的维护工作量大，当C++中的类增加或删除，命名空间调整时需要修改配置文件，其中还包含一些特殊类型的自动化处理，例如多继承、智能指针和引用类型的情况。

为此，本发明提出一种混合编程开发方法，以解决上述问题。

请参阅图1，为根据本申请实施例一提出的混合编程开发方法流程图，该混合编程开发方法基于Qt框架的pyside界面编程对Python语言进行界面开发，该流程包括如下步骤：

步骤S1，解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息。

具体的，本发明实施例中，解析配置文件获取的内容包括：

包名称：导出Python三方库的包名称；

源目录：导出C++类、函数所在的头文件的目录；

包含目录：源目录下C++头文件中的包含目录；

链接库目录：源目录下C++头文件使用到的类所在链接库所在的目录；

动态库目录：源目录下C++头文件使用到的类所在动态库所在的目录；

排除头文件目录：源目录下不导出的头文件名称。

其中，包含目录在头文件解析时、shiboken2.exe生成基于CPython代码及编译生成pyd(python数据文件)时均需要用到。链接库(目录)在shiboken2.exe生成基于CPython代码及编译生成pyd时均需要用到。动态库目录在生成pyi(存根文件)时需要用到。

步骤S2，解析源目录中的所有头文件，以获取头文件中的导出类、导出函数，并根据导出类以及导出函数生成shiboken配置。

其中，shiboken配置为shiboken2转换方案的配置。

步骤S3，将shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件。

其中，python数据文件即为pyd，shiboken2.exe是开源方案，假如不采用shiboken2.exe方案，想要Python调用C++的类和函数，需要手动编写这段代码。shiboken2这套方案就是简化此过程。

步骤S4，完成C++库与Python的相互调用。

本发明实施例中，Python调用C++库的示例如图2所示，Python调用C++代码如下表所示：

进一步的，C++执行Python如图3所示，说明如下表所示：

PyBind方法	说明
		pybind11::module::import	导入模块
module.attr	获取模块属性
		getCppPointer	转换为C++指针

综上，本发明提供的混合编程开发方法，通过解析配置文件，获取配置文件中的关键信息，根据关键信息生成shiboken配置；再shiboken2.exe程序进行编译，生成python数据文件。本申请技术方案可以实现在C++代码中执行Python的代码，在Python代码中执行C++的代码，也就是相互调用，并且本申请在每次代码发生变更时，可自动化生成配置文件，不需要手动调整，通过本申请技术方案可有效的简化转换所需配置文件，大幅减少C++代码更新后的维护工作量。

进一步的，请参阅图4，为本发明实施例一中，解析源目录的方法流程图，该方法具体包括：

步骤S21，采用Clang解析递归遍历每个头文件。

步骤S22，将解析结果转换为包含命名空间、类、函数、枚举信息的数据源。

其中，数据源包括所述导出类以及所述导出函数。

进一步的，请参阅图5，为本发明实施例一提出的混合编程开发方法中，生成存根文件的方法流程图，该方法具体包括：

步骤S31：读取python数据文件内部的类、函数、注释信息。

步骤S32：根据python数据文件内部的类、函数、注释信息生成可供Python智能提示识别的存根文件。

示例而非限定的，本发明实施例中，生成可供Python智能提示识别的存根文件具体可通过generate_pyi.py实现，其pyi生成图例如图6所示。

通过上述方法，可将pyd转换为pyi(存根文件)以实现Python开发工具(例如vscode)提供智能提示功能使用。例如在混合编程开发过程中，当pyi文件中存在类、函数及注释时，vscode可以代码补全及注释提示。

进一步的，为本发明实施例一提出的混合编程开发方法中，还包括生成python数据文件的方法，该方法具体包括：

步骤S41：执行shiboken2.exe生成转换代码。

如图6所示，为本发明中执行shiboken2.exe生成转换代码一个示例。

步骤S42：基于转换代码构建cmake项目，编译生成所述python数据文件。

如图7和图8所示，分别为构建cmake项目以及输出pyd的示例图。

本发明实施例还提供了混合编程开发系统，该系统用于实现上述实施例及优选实施方式，已经进行过说明的不再赘述。如以下所使用的，术语“模块”、“单元”、“子单元”等可以实现预定功能的软件和/或硬件的组合。尽管以下实施例所描述的装置较佳地以软件来实现，但是硬件，或者软件和硬件的组合的实现也是可能并被构想的。

具体的，混合编程开发系统包括：

第一解析模块：用于解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息；

第二解析模块：用于解析源目录中的所有头文件，以获取头文件中的导出类、导出函数；

shiboken配置生成模块：用于根据导出类以及导出函数生成shiboken配置；

pyd生成模块：用于将shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件；

调用模块：用于实现C++库与Python的相互调用。

进一步的，第二解析模块具体包括：

遍历单元：用于递归遍历每个头文件；

转换单元：用于将解析结果转换为包含命名空间、类、函数、枚举信息的数据源，其中，数据源包括导出类以及导出函数。

进一步的，系统还包括：

读取模块：用于读取python数据文件内部的类、函数、注释信息；

pyi生成模块：用于根据python数据文件内部的类、函数、注释信息生成可供Python智能提示识别的存根文件。

进一步的，pyd生成模块具体包括：

转换代码生成单元：用于生成转换代码；

项目构建单元：用于基于转换代码构建cmake项目；

编译单元：用于编译生成python数据文件。

综上，本发明实施例提出的混合编程开发系统，通过采用上述的混合编程开发方法，通过解析配置文件，获取配置文件中的关键信息，根据关键信息生成shiboken配置；再shiboken2.exe程序进行编译，生成python数据文件。本申请技术方案可以实现在C++代码中执行Python的代码，在Python代码中执行C++的代码，也就是相互调用，并且本申请在每次代码发生变更时，可自动化生成配置文件，不需要手动调整，通过本申请技术方案可有效的简化转换所需配置文件，大幅减少C++代码更新后的维护工作量。此外，还可以将pyd转换为pyi(存根文件)以实现Python开发工具提供智能提示功能使用。

需要说明的是，上述各个模块可以是功能模块也可以是程序模块，既可以通过软件来实现，也可以通过硬件来实现。对于通过硬件来实现的模块而言，上述各个模块可以位于同一处理器中；或者上述各个模块还可以按照任意组合的形式分别位于不同的处理器中。

另外，结合上述实施例中的混合编程开发方法，本申请实施例可提供一种可读存储介质来实现。该可读存储介质上存储有计算机程序指令；该计算机程序指令被处理器执行时实现上述实施例中的任意一种混合编程开发方法。

另外，结合附图描述的本申请实施例混合编程开发方法可以由计算机设备来实现。计算机设备可以包括处理器以及存储有计算机程序指令的存储器。

具体地，上述处理器可以包括中央处理器(CPU)，或者特定集成电路(ApplicationSpecific Integrated Circuit，简称为ASIC)，或者可以被配置成实施本申请实施例的一个或多个集成电路。

其中，存储器可以包括用于数据或指令的大容量存储器。举例来说而非限制，存储器可包括硬盘驱动器(Hard Disk Drive，简称为HDD)、软盘驱动器、固态驱动器(SolidState Drive，简称为SSD)、闪存、光盘、磁光盘、磁带或通用串行总线(Universal SerialBus，简称为USB)驱动器或者两个或更多个以上这些的组合。在合适的情况下，存储器可包括可移除或不可移除(或固定)的介质。在合适的情况下，存储器可在数据处理装置的内部或外部。在特定实施例中，存储器是非易失性(Non-Volatile)存储器。在特定实施例中，存储器包括只读存储器(Read-Only Memory，简称为ROM)和随机存取存储器(Random AccessMemory，简称为RAM)。在合适的情况下，该ROM可以是掩模编程的ROM、可编程ROM(Programmable Read-Only Memory，简称为PROM)、可擦除PROM(Erasable ProgrammableRead-Only Memory，简称为EPROM)、电可擦除PROM(Electrically Erasable ProgrammableRead-Only Memory，简称为EEPROM)、电可改写ROM(Electrically Alterable Read-OnlyMemory，简称为EAROM)或闪存(FLASH)或者两个或更多个以上这些的组合。在合适的情况下，该RAM可以是静态随机存取存储器(Static Random-Access Memory，简称为SRAM)或动态随机存取存储器(Dynamic Random Access Memory，简称为DRAM)，其中，DRAM可以是快速页模式动态随机存取存储器(Fast Page Mode Dynamic Random Access Memory，简称为FPMDRAM)、扩展数据输出动态随机存取存储器(Extended Date Out Dynamic RandomAccess Memory，简称为EDODRAM)、同步动态随机存取内存(Synchronous Dynamic Random-Access Memory，简称SDRAM)等。

存储器可以用来存储或者缓存需要处理和/或通信使用的各种数据文件，以及处理器所执行的可能的计算机程序指令。

处理器通过读取并执行存储器中存储的计算机程序指令，以实现上述实施例中的任意一种混合编程开发方法。

在其中一些实施例中，计算机设备还可包括通信接口和总线。处理器81、存储器、通信接口通过总线连接并完成相互间的通信。

通信接口用于实现本申请实施例中各模块、装置、单元和/或设备之间的通信。通信接口还可以实现与其他部件例如：外接设备、图像/数据采集设备、数据库、外部存储以及图像/数据处理工作站等之间进行数据通信。

总线包括硬件、软件或两者，将计算机设备的部件彼此耦接在一起。总线包括但不限于以下至少之一：数据总线(Data Bus)、地址总线(Address Bus)、控制总线(ControlBus)、扩展总线(Expansion Bus)、局部总线(Local Bus)。举例来说而非限制，总线可包括图形加速接口(Accelerated Graphics Port，简称为AGP)或其他图形总线、增强工业标准架构(Extended Industry Standard Architecture，简称为EISA)总线、前端总线(FrontSide Bus，简称为FSB)、超传输(Hyper Transport，简称为HT)互连、工业标准架构(Industry Standard Architecture，简称为ISA)总线、无线带宽(InfiniBand)互连、低引脚数(Low Pin Count，简称为LPC)总线、存储器总线、微信道架构(Micro ChannelArchitecture，简称为MCA)总线、外围组件互连(Peripheral Component Interconnect，简称为PCI)总线、PCI-Express(PCI-X)总线、串行高级技术附件(Serial AdvancedTechnology Attachment，简称为SATA)总线、视频电子标准协会局部(Video ElectronicsStandards Association Local Bus，简称为VLB)总线或其他合适的总线或者两个或更多个以上这些的组合。在合适的情况下，总线80可包括一个或多个总线。尽管本申请实施例描述和示出了特定的总线，但本申请考虑任何合适的总线或互连。

该计算机设备可以基于获取到的数据参数，执行本申请实施例中的混合编程开发方法，从而实现结合附图描述的混合编程开发方法。

以上所述实施例的各技术特征可以进行任意的组合，为使描述简洁，未对上述实施例中的各个技术特征所有可能的组合都进行描述，然而，只要这些技术特征的组合不存在矛盾，都应当认为是本说明书记载的范围。

以上所述实施例仅表达了本申请的几种实施方式，其描述较为具体和详细，但并不能因此而理解为对发明专利范围的限制。应当指出的是，对于本领域的普通技术人员来说，在不脱离本申请构思的前提下，还可以做出若干变形和改进，这些都属于本申请的保护范围。因此，本申请专利的保护范围应以所附权利要求为准。

Claims (10)

1.一种混合编程开发方法，其特征在于，包括：

步骤S1：解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息；

步骤S2：解析所述源目录中的所有头文件，以获取所述头文件中的导出类、导出函数，并根据所述导出类以及所述导出函数生成shiboken配置；

步骤S3：将所述shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件；

步骤S4：完成C++库与Python的相互调用。

2.根据权利要求1所述的混合编程开发方法，其特征在于，所述解析所述源目录中的所有头文件，以获取所述头文件中的导出类、导出函数的步骤具体包括：

步骤S21：采用Clang解析递归遍历每个所述头文件；

步骤S22：将解析结果转换为包含命名空间、类、函数、枚举信息的数据源，其中，所述数据源包括所述导出类以及所述导出函数。

3.根据权利要求1所述的混合编程开发方法，其特征在于，所述将所述shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件的步骤之后，还包括：

步骤S31：读取所述python数据文件内部的类、函数、注释信息；

步骤S32：根据所述python数据文件内部的类、函数、注释信息生成可供Python智能提示识别的存根文件。

4.根据权利要求1所述的混合编程开发方法，其特征在于，所述生成python数据文件的步骤具体包括：

步骤S41：执行shiboken2.exe生成转换代码；

步骤S42：基于所述转换代码构建cmake项目，编译生成所述python数据文件。

5.一种混合编程开发系统，其特征在于，所述系统包括：

第一解析模块：用于解析配置文件，以至少获取源目录、链接库依赖项、链接库目录、头文件信息；

第二解析模块：用于解析所述源目录中的所有头文件，以获取所述头文件中的导出类、导出函数；

shiboken配置生成模块：用于根据所述导出类以及所述导出函数生成shiboken配置；

pyd生成模块：用于将所述shiboken配置传入shiboken2.exe程序进行编译，生成python数据文件；

调用模块：用于实现C++库与Python的相互调用。

6.根据权利要求5所述的混合编程开发系统，其特征在于，所述第二解析模块具体包括：

遍历单元：用于递归遍历每个所述头文件；

转换单元：用于将解析结果转换为包含命名空间、类、函数、枚举信息的数据源，其中，所述数据源包括所述导出类以及所述导出函数。

7.根据权利要求5所述的混合编程开发系统，其特征在于，所述系统还包括：

读取模块：用于读取所述python数据文件内部的类、函数、注释信息；

pyi生成模块：用于根据所述python数据文件内部的类、函数、注释信息生成可供Python智能提示识别的存根文件。

8.根据权利要求5所述的混合编程开发系统，其特征在于，所述pyd生成模块具体包括：

转换代码生成单元：用于生成转换代码；

项目构建单元：用于基于所述转换代码构建cmake项目；

编译单元：用于编译生成所述python数据文件。

9.一种可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行时实现如权利要求1至4中任一项所述的混合编程开发方法。

10.一种计算机设备，包括存储器、处理器以及存储在所述存储器上并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1至4中任一项所述的混合编程开发方法。