Python通过Ctypes调用C++类，实测有效

news2024/11/25 0:14:41

文章目录

前言
创建vs dll工程
添加外部库
编辑代码
编译
测试
参考

前言

在软件开发中，有时候需要Python与C++相结合，以充分发挥两者的优势 。Python作为一种高级编程语言，具有简洁易读的特点，适用于快速开发和原型设计。而C++则是一种性能强大的编程语言，适用于需要高效率和底层控制的场景。

Python调用C++代码的主要方式是使用Cython、ctypes或SWIG等工具 。其中，Cython是一种混合语言，允许将Python代码与C语言结合，通过编写类型声明来提高性能。而ctypes是Python标准库中的一部分，允许Python直接调用C函数，并处理C数据类型。另外，SWIG（Simplified Wrapper and Interface Generator）是一个自动生成Python和其他语言之间的接口代码的工具，使Python可以调用C++代码。

在实际应用中，Python调用C++的场景包括但不限于：加速Python程序的关键部分、调用现有的C++库以利用其功能、优化某些算法以提高性能等。通过将Python与C++相结合，开发人员可以在保持Python代码易读性和开发效率的同时，充分发挥C++的性能优势，实现更加复杂和高效的应用程序。

Python通过ctypes调用C++代码是一种常见的技术，它提供了一种简单而直接的方法，让Python与C++进行交互。ctypes是Python标准库的一部分，允许Python代码调用动态链接库（DLL）中的C函数，并处理C数据类型。虽然ctypes主要设计用于调用C函数，但也可以用于调用C++代码，只需注意一些特殊的注意事项。

要在Python中通过ctypes调用C++代码，首先需要确保将C++代码编译为动态链接库，以便Python能够加载并调用其中的函数。然后，需要在Python中定义与C++函数相对应的函数原型，并在调用时传递正确的参数和返回类型。此外，需要注意C++代码中的名称修饰（name mangling）以及C++异常处理等问题，确保与Python的交互能够顺利进行。

在实际应用中，Python通过ctypes调用C++代码的场景包括但不限于：利用现有的C++库实现特定功能、加速Python程序的关键部分、与C++库进行交互以实现复杂的功能等。通过使用ctypes，开发人员可以在Python中利用C++的性能优势，同时保持Python代码的简洁性和易读性。

然而，虽然ctypes提供了一种方便的方法来调用C++代码，但它并不是最高效的方法，特别是对于复杂的数据结构和函数签名而言。对于更复杂的场景，可以考虑使用Cython或SWIG等工具，它们提供了更强大和灵活的功能，以便更好地集成Python和C++代码。

因此，Python通过ctypes调用C++代码是一种简单而有效的方法，适用于许多场景。通过正确地处理数据类型和函数签名，并注意到C++与Python之间的差异，开发人员可以轻松地在两种语言之间进行交互，实现更加强大和灵活的应用程序。

创建vs dll工程

在这里插入图片描述

添加外部库

参考：
vs2019添加使用外置库的设置

编辑代码

添加自己写的C++类

在这里插入图片描述

Foo.h

#pragma once
#ifndef _pro_header_  
#define _pro_header_ 

#ifdef EXPORT_PRO_DLL //如果引用此头文件有预定义为 EXPORT_PRO_DLL
#define PRO_API __declspec(dllexport)  
#else  
#define PRO_API __declspec(dllimport)  
#endif  


class Foo
{
public:
    Foo(int n);
    ~Foo();
    void bar();
    int foobar(int n);
private:
    int val;
};

extern "C"
{
    PRO_API Foo* Foo_new(int n);
    PRO_API void Foo_bar(Foo* foo);
    //PRO_API int* Foo_foobar(Foo* foo, int n); //int、short等不能返回地址类型，因为Python那边不允许；只有char类型才需要使用地址类型
    PRO_API int Foo_foobar(Foo* foo, int n);

    PRO_API void del_Foo(Foo* foo);
}

#endif

Foo.cpp

#define EXPORT_PRO_DLL

#include "pch.h"
#include "Foo.h"

#include "string.h"
#include<iostream>

using namespace std;

Foo::Foo(int n)
{
    this->val = n;
}
void Foo::bar()
{
    std::cout << "Value is " << this->val << std::endl;
}
Foo::~Foo()
{
    cout << "delete foo" << endl;
}

int Foo::foobar(int n)
{
    int* data = new int[2];
    data[0] = 1 + n;
    data[1] = 2 + n;
    return *data;
}

void del_Foo(Foo* foo)
{
    delete foo;
}

Foo* Foo_new(int n)
{
    return new Foo(n);
}

void Foo_bar(Foo* foo)
{
    foo->bar();
}

int Foo_foobar(Foo* foo, int n) {
    return foo->foobar(n);
}

编译

在这里插入图片描述

测试

from ctypes import *

lib = cdll.LoadLibrary(r"路径\x64\Debug\Foo.dll")

class Foo(object):
    def __init__(self, n):
        lib.Foo_new.argtypes = [c_int]
        lib.Foo_new.restype = c_void_p
        lib.Foo_bar.argtypes = [c_void_p]
        lib.Foo_bar.restype = c_void_p
        lib.Foo_foobar.argtypes = [c_void_p, c_int]
        lib.Foo_foobar.restype = c_int

        lib.del_Foo.argtypes = [c_void_p]
        lib.del_Foo.restype = c_void_p

        self.obj = lib.Foo_new(n)

    def __del__(self):
        lib.del_Foo(self.obj)


    def bar(self):
        lib.Foo_bar(self.obj)

    def foobar(self, n):
        return lib.Foo_foobar(self.obj, n)

if __name__ == '__main__':
    f = Foo(5)
    print(f.bar())
    print(f.foobar(5))