如何将可选类型从 C++ 传递到 Cython？

我正在尝试将可选参数从 C++ 传递到 Cython 文件。 我不必将其写入 .pxd 和 .pyx 文件中：

[C++]

std::optional<std::shared_ptr<CPP_MyObject>> cpp_find_value();

[.pxd]

shared_ptr[CPP_MyObject] cpp_find_value()   # fix me

[.pyx]

def python_find_value(self):    # fix me
    cdef shared_ptr[CPP_MyObject] cpp_object = self.thisptr.get().cpp_find_value()
    cdef Python_MyObject python_object = Python_MyObject("0")
    python_object.thisptr = cpp_object
    return python_object

以下是使用 Cython 处理从 C++ 到 Python 的可选值（在本例中为 std::optional ）的步骤，以及如何处理 std::shared_ptr 和封装的 C++ 对象：

1. C++ 包装器（可选，但建议）：

为了获得最佳实践和清晰度，请创建一个简单的 C++ 包装器函数，以处理 std::optional 检查和到 Python 可理解类型的转换。这会使 Cython 代码更干净。

// C++ header (e.g., my_cpp_library.hpp)
#include <optional>
#include <memory>

class CPP_MyObject {
public:
    CPP_MyObject(const std::string& s) : data(s) {} 
    std::string getData() const { return data; }
private:
    std::string data; 
};

std::optional<std::shared_ptr<CPP_MyObject>> cpp_find_value();

// Wrapper function for Cython
extern "C" { 
    const char* cpp_find_value_wrapper() {
        auto val = cpp_find_value();
        if (val.has_value()) {
            return val.value()->getData().c_str(); // Example: Returning data as a string
        } else {
            return nullptr;
        }
    }
}

2. Cython 定义（.pxd 文件）：

# my_module.pxd
cdef extern from "my_cpp_library.hpp": 
    const char* cpp_find_value_wrapper()

3. Cython 实现（.pyx 文件）：

# my_module.pyx
from libc.stdlib cimport free

cdef class Python_MyObject:
    cdef object thisptr  

    def __init__(self, data):
        self.thisptr = data 

def python_find_value():
    cdef const char* cpp_result = cpp_find_value_wrapper()
    if cpp_result != NULL:
        python_result = cpp_result.decode('utf-8') # Decode the C string to Python string
        free(<void*>cpp_result) # Free the memory allocated in C++
        return Python_MyObject(python_result)
    else:
        return None 

说明：

• 包装器函数： cpp_find_value_wrapper() 检查 std::optional 是否包含值。如果是，它将返回 std::shared_ptr<CPP_MyObject> 中的数据；否则，返回 nullptr 。
• Cython 类型： Cython 中的 const char* 用于表示 C 风格的字符串，该字符串由 cpp_find_value_wrapper 返回。
• 错误处理： 我们检查 cpp_find_value_wrapper() 是否返回 nullptr 以指示没有值，并相应地返回 Python 的 None 。
• 内存管理： 确保使用 free() 释放由 cpp_find_value_wrapper() 分配的 C 字符串内存，以防止内存泄漏。

其他注意事项：

• 更复杂的数据： 如果需要从 cpp_find_value() 返回更复杂的数据结构，则需要定义相应的 Cython 结构或类，并以 cpp_find_value_wrapper() 中的原始指针或引用返回它们。
• 错误处理： 对于生产代码，请考虑更强大的错误处理机制，例如，使用 Cython 异常来传播 C++ 方面的错误。

通过遵循这些步骤，你可以有效地将可选类型从 C++ 传递到 Cython，同时保持类型安全并管理内存分配。