Pybind:是否可以告知 Python 构造函数的参数名称?

Pybind: Is it possible to inform Python about the names of the arguments for constructors?

在 Pybind 中,可以通知 Python 函数 的参数名称:

m.def("add", &add, "A function which adds two numbers",
  py::arg("i"), py::arg("j"));

(http://pybind11.readthedocs.io/en/stable/basics.html#keyword-arguments)

构造函数是否有类似的东西? Spyder (Anaconda) 已经默认显示函数的输入参数,但对于构​​造函数,"help" 仅显示:(*args, **kwargs)。

是的,与成员函数或函数完全相同:)

struct Foo {
    Foo(int x, int y) {}
    void bar(int a, int b) {}
};

PYBIND11_MODULE(cpp_module, m) {
    py::class_<Foo>(m, "Foo")
        .def(py::init<int, int>(), py::arg("x"), py::arg("y"))
        .def("bar", &Foo::bar, py::arg("a"), py::arg("b"));
}

据我所知,对函数、成员函数或构造函数使用 py::arg 并没有真正的区别,它们的工作方式相同(包括默认值等)。


重载函数(包括构造函数)是一个有趣的案例。由于 Python 没有类似的重载机制,因此由 pybind11 处理。 help() 仍然有效,但会显示如下内容:

__init__(...)
    __init__(*args, **kwargs)
    Overloaded function.

    1. __init__(self: some_cpp.Foo, x: int, y: int) -> None

    2. __init__(self: some_cpp.Foo) -> None

如您所见,__init__ 本身需要 (*args, **kwargs),这将是大多数 IDE 自动完成的内容。解决此问题的一种方法是使用静态方法作为构造函数,这样您就可以为每个构造函数指定一个唯一的名称,以便 Python 知道这一点。例如,Foo Foo::from_ints(int x, int y)Foo Foo::from_string(std::string s).